-
Notifications
You must be signed in to change notification settings - Fork 53
feat: view options print and web #1793
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
caio-pizzol
wants to merge
2
commits into
main
Choose a base branch
from
caio/sd-1043-1-wcag-aa-layout-mode-to-eliminate-horizontal-scroll-on_v1
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
180 changes: 180 additions & 0 deletions
180
packages/super-editor/src/core/Editor.webLayout.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,180 @@ | ||
| import { describe, it, expect, vi, beforeEach, beforeAll } from 'vitest'; | ||
| import { Editor } from './Editor.js'; | ||
| import { loadTestDataForEditorTests } from '@tests/helpers/helpers.js'; | ||
| import { getStarterExtensions } from '@extensions/index.js'; | ||
|
|
||
| /** | ||
| * Tests for web layout mode (OOXML ST_View 'web'). | ||
| * | ||
| * Web layout mode enables responsive document rendering where content | ||
| * reflows to fit the container width, similar to web pages. This contrasts | ||
| * with print layout mode which maintains fixed page dimensions. | ||
| * | ||
| * Key behaviors tested: | ||
| * - isWebLayout() detection | ||
| * - getMaxContentSize() behavior in web vs print layout | ||
| */ | ||
|
|
||
| let blankDocData: { docx: unknown; media: unknown; mediaFiles: unknown; fonts: unknown }; | ||
|
|
||
| beforeAll(async () => { | ||
| blankDocData = await loadTestDataForEditorTests('blank-doc.docx'); | ||
| }); | ||
|
|
||
| function createTestEditor(options: Partial<Parameters<(typeof Editor)['prototype']['constructor']>[0]> = {}) { | ||
| return new Editor({ | ||
| isHeadless: true, | ||
| deferDocumentLoad: true, | ||
| mode: 'docx', | ||
| extensions: getStarterExtensions(), | ||
| suppressDefaultDocxStyles: true, | ||
| ...options, | ||
| }); | ||
| } | ||
|
|
||
| function getBlankDocOptions() { | ||
| return { | ||
| mode: 'docx' as const, | ||
| content: blankDocData.docx, | ||
| mediaFiles: blankDocData.mediaFiles, | ||
| fonts: blankDocData.fonts, | ||
| }; | ||
| } | ||
|
|
||
| describe('Editor Web Layout Mode', () => { | ||
| describe('isWebLayout()', () => { | ||
| it('returns true when viewOptions.layout is "web"', () => { | ||
| const editor = createTestEditor({ | ||
| viewOptions: { layout: 'web' }, | ||
| }); | ||
|
|
||
| expect(editor.isWebLayout()).toBe(true); | ||
| }); | ||
|
|
||
| it('returns false when viewOptions.layout is "print"', () => { | ||
| const editor = createTestEditor({ | ||
| viewOptions: { layout: 'print' }, | ||
| }); | ||
|
|
||
| expect(editor.isWebLayout()).toBe(false); | ||
| }); | ||
|
|
||
| it('returns false when viewOptions is undefined', () => { | ||
| const editor = createTestEditor({ | ||
| viewOptions: undefined, | ||
| }); | ||
|
|
||
| expect(editor.isWebLayout()).toBe(false); | ||
| }); | ||
|
|
||
| it('returns false when viewOptions.layout is undefined', () => { | ||
| const editor = createTestEditor({ | ||
| viewOptions: {}, | ||
| }); | ||
|
|
||
| expect(editor.isWebLayout()).toBe(false); | ||
| }); | ||
| }); | ||
|
|
||
| describe('getMaxContentSize()', () => { | ||
| describe('web layout mode', () => { | ||
| it('returns empty object to skip image constraints', async () => { | ||
| const editor = createTestEditor({ | ||
| viewOptions: { layout: 'web' }, | ||
| }); | ||
| await editor.open(undefined, getBlankDocOptions()); | ||
|
|
||
| const size = editor.getMaxContentSize(); | ||
|
|
||
| // Web layout skips constraints - CSS handles responsive sizing | ||
| expect(size).toEqual({}); | ||
| }); | ||
|
|
||
| it('returns empty object even when document has page size defined', async () => { | ||
| const editor = createTestEditor({ | ||
| viewOptions: { layout: 'web' }, | ||
| }); | ||
| await editor.open(undefined, getBlankDocOptions()); | ||
|
|
||
| // Verify document has page styles (blank-doc.docx has standard Letter size) | ||
| expect(editor.converter?.pageStyles?.pageSize).toBeDefined(); | ||
|
|
||
| // But web layout still returns empty - let CSS handle it | ||
| expect(editor.getMaxContentSize()).toEqual({}); | ||
| }); | ||
| }); | ||
|
|
||
| describe('print layout mode', () => { | ||
| it('returns calculated dimensions based on page size and margins', async () => { | ||
| const editor = createTestEditor({ | ||
| viewOptions: { layout: 'print' }, | ||
| }); | ||
| await editor.open(undefined, getBlankDocOptions()); | ||
|
|
||
| const size = editor.getMaxContentSize(); | ||
|
|
||
| // Print layout should return numeric dimensions | ||
| expect(size.width).toBeDefined(); | ||
| expect(size.height).toBeDefined(); | ||
| expect(typeof size.width).toBe('number'); | ||
| expect(typeof size.height).toBe('number'); | ||
| expect(size.width).toBeGreaterThan(0); | ||
| expect(size.height).toBeGreaterThan(0); | ||
| }); | ||
|
|
||
| it('accounts for page margins in calculations', async () => { | ||
| const editor = createTestEditor({ | ||
| viewOptions: { layout: 'print' }, | ||
| }); | ||
| await editor.open(undefined, getBlankDocOptions()); | ||
|
|
||
| const { pageSize = {}, pageMargins = {} } = editor.converter?.pageStyles ?? {}; | ||
| const PIXELS_PER_INCH = 96; | ||
|
|
||
| // Get the actual calculated size | ||
| const size = editor.getMaxContentSize(); | ||
|
|
||
| // Verify margins are subtracted from page dimensions | ||
| if (pageSize.width && pageSize.height) { | ||
| const expectedMaxWidth = | ||
| pageSize.width * PIXELS_PER_INCH - | ||
| (pageMargins.left ?? 0) * PIXELS_PER_INCH - | ||
| (pageMargins.right ?? 0) * PIXELS_PER_INCH - | ||
| 20; // MAX_WIDTH_BUFFER_PX | ||
|
|
||
| const expectedMaxHeight = | ||
| pageSize.height * PIXELS_PER_INCH - | ||
| (pageMargins.top ?? 0) * PIXELS_PER_INCH - | ||
| (pageMargins.bottom ?? 0) * PIXELS_PER_INCH - | ||
| 50; // MAX_HEIGHT_BUFFER_PX | ||
|
|
||
| expect(size.width).toBe(expectedMaxWidth); | ||
| expect(size.height).toBe(expectedMaxHeight); | ||
| } | ||
| }); | ||
| }); | ||
|
|
||
| describe('edge cases', () => { | ||
| it('returns empty object when converter is not initialized', () => { | ||
| const editor = createTestEditor({ | ||
| viewOptions: { layout: 'print' }, | ||
| }); | ||
| // Don't call open() - converter won't be initialized | ||
|
|
||
| expect(editor.getMaxContentSize()).toEqual({}); | ||
| }); | ||
|
|
||
| it('returns empty object by default (no viewOptions)', async () => { | ||
| const editor = createTestEditor(); | ||
| await editor.open(undefined, getBlankDocOptions()); | ||
|
|
||
| // Default behavior - print layout with calculated dimensions | ||
| const size = editor.getMaxContentSize(); | ||
|
|
||
| // Default should be print layout (calculated dimensions) | ||
| expect(typeof size.width).toBe('number'); | ||
| expect(typeof size.height).toBe('number'); | ||
| }); | ||
| }); | ||
| }); | ||
| }); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@harbournick lmk if this should be removed