import { AssetRecordType, BaseBoxShapeUtil, PageRecordType, TLShape, createShapeId, debounce, } from '@tldraw/editor' import { TestEditor } from './TestEditor' import { TL } from './test-jsx' let editor: TestEditor const ids = { box1: createShapeId('box1'), box2: createShapeId('box2'), box3: createShapeId('box3'), frame1: createShapeId('frame1'), group1: createShapeId('group1'), page2: PageRecordType.createId('page2'), } beforeEach(() => { editor = new TestEditor() editor.createShapes([ // on it's own { id: ids.box1, type: 'geo', x: 100, y: 100, props: { w: 100, h: 100 } }, // in a frame { id: ids.frame1, type: 'frame', x: 100, y: 100, props: { w: 100, h: 100 } }, { id: ids.box2, type: 'geo', x: 700, y: 700, props: { w: 100, h: 100 }, parentId: ids.frame1 }, { id: ids.group1, type: 'group', x: 100, y: 100, props: {} }, { id: ids.box3, type: 'geo', x: 500, y: 500, props: { w: 100, h: 100 }, parentId: ids.group1 }, ]) const page1 = editor.getCurrentPageId() editor.createPage({ name: 'page 2', id: ids.page2 }) editor.setCurrentPage(page1) }) const moveShapesToPage2 = () => { // directly maniuplate parentId like would happen in multiplayer situations editor.updateShapes([ { id: ids.box1, type: 'geo', parentId: ids.page2 }, { id: ids.box2, type: 'geo', parentId: ids.page2 }, { id: ids.group1, type: 'group', parentId: ids.page2 }, ]) } describe('shapes that are moved to another page', () => { it("should be excluded from the previous page's focusedGroupId", () => { editor.setFocusedGroup(ids.group1) expect(editor.getFocusedGroupId()).toBe(ids.group1) moveShapesToPage2() expect(editor.getFocusedGroupId()).toBe(editor.getCurrentPageId()) }) describe("should be excluded from the previous page's hintingShapeIds", () => { test('[boxes]', () => { editor.setHintingShapes([ids.box1, ids.box2, ids.box3]) expect(editor.getHintingShapeIds()).toEqual([ids.box1, ids.box2, ids.box3]) moveShapesToPage2() expect(editor.getHintingShapeIds()).toEqual([]) }) test('[frame that does not move]', () => { editor.setHintingShapes([ids.frame1]) expect(editor.getHintingShapeIds()).toEqual([ids.frame1]) moveShapesToPage2() expect(editor.getHintingShapeIds()).toEqual([ids.frame1]) }) }) describe("should be excluded from the previous page's editingShapeId", () => { test('[root shape]', () => { editor.setEditingShape(ids.box1) expect(editor.getEditingShapeId()).toBe(ids.box1) moveShapesToPage2() expect(editor.getEditingShapeId()).toBe(null) }) test('[child of frame]', () => { editor.setEditingShape(ids.box2) expect(editor.getEditingShapeId()).toBe(ids.box2) moveShapesToPage2() expect(editor.getEditingShapeId()).toBe(null) }) test('[child of group]', () => { editor.setEditingShape(ids.box3) expect(editor.getEditingShapeId()).toBe(ids.box3) moveShapesToPage2() expect(editor.getEditingShapeId()).toBe(null) }) test('[frame that doesnt move]', () => { editor.setEditingShape(ids.frame1) expect(editor.getEditingShapeId()).toBe(ids.frame1) moveShapesToPage2() expect(editor.getEditingShapeId()).toBe(ids.frame1) }) }) describe("should be excluded from the previous page's erasingShapeIds", () => { test('[boxes]', () => { editor.setErasingShapes([ids.box1, ids.box2, ids.box3]) expect(editor.getErasingShapeIds()).toEqual([ids.box1, ids.box2, ids.box3]) moveShapesToPage2() expect(editor.getErasingShapeIds()).toEqual([]) }) test('[frame that does not move]', () => { editor.setErasingShapes([ids.frame1]) expect(editor.getErasingShapeIds()).toEqual([ids.frame1]) moveShapesToPage2() expect(editor.getErasingShapeIds()).toEqual([ids.frame1]) }) }) describe("should be excluded from the previous page's selectedShapeIds", () => { test('[boxes]', () => { editor.setSelectedShapes([ids.box1, ids.box2, ids.box3]) expect(editor.getSelectedShapeIds()).toEqual([ids.box1, ids.box2, ids.box3]) moveShapesToPage2() expect(editor.getSelectedShapeIds()).toEqual([]) }) test('[frame that does not move]', () => { editor.setSelectedShapes([ids.frame1]) expect(editor.getSelectedShapeIds()).toEqual([ids.frame1]) moveShapesToPage2() expect(editor.getSelectedShapeIds()).toEqual([ids.frame1]) }) }) }) it('Begins dragging from pointer move', () => { editor.pointerDown(0, 0) editor.pointerMove(2, 2) expect(editor.inputs.isDragging).toBe(false) editor.pointerMove(10, 10) expect(editor.inputs.isDragging).toBe(true) }) it('Begins dragging from wheel', () => { editor.pointerDown(0, 0) editor.wheel(2, 2) expect(editor.inputs.isDragging).toBe(false) editor.wheel(10, 10) expect(editor.inputs.isDragging).toBe(true) }) it('Does not create an undo stack item when first clicking on an empty canvas', () => { editor = new TestEditor() editor.pointerMove(50, 50) editor.click(0, 0) expect(editor.getCanUndo()).toBe(false) }) describe('Editor.sharedOpacity', () => { it('should return the current opacity', () => { expect(editor.getSharedOpacity()).toStrictEqual({ type: 'shared', value: 1 }) editor.setOpacityForSelectedShapes(0.5) editor.setOpacityForNextShapes(0.5) expect(editor.getSharedOpacity()).toStrictEqual({ type: 'shared', value: 0.5 }) }) it('should return opacity for a single selected shape', () => { const { A } = editor.createShapesFromJsx() editor.setSelectedShapes([A]) expect(editor.getSharedOpacity()).toStrictEqual({ type: 'shared', value: 0.3 }) }) it('should return opacity for multiple selected shapes', () => { const { A, B } = editor.createShapesFromJsx([ , , ]) editor.setSelectedShapes([A, B]) expect(editor.getSharedOpacity()).toStrictEqual({ type: 'shared', value: 0.3 }) }) it('should return mixed when multiple selected shapes have different opacity', () => { const { A, B } = editor.createShapesFromJsx([ , , ]) editor.setSelectedShapes([A, B]) expect(editor.getSharedOpacity()).toStrictEqual({ type: 'mixed' }) }) it('ignores the opacity of groups and returns the opacity of their children', () => { const ids = editor.createShapesFromJsx([ , ]) editor.setSelectedShapes([ids.group]) expect(editor.getSharedOpacity()).toStrictEqual({ type: 'shared', value: 0.3 }) }) }) describe('Editor.setOpacity', () => { it('should set opacity for selected shapes', () => { const ids = editor.createShapesFromJsx([ , , ]) editor.setSelectedShapes([ids.A, ids.B]) editor.setOpacityForSelectedShapes(0.5) editor.setOpacityForNextShapes(0.5) expect(editor.getShape(ids.A)!.opacity).toBe(0.5) expect(editor.getShape(ids.B)!.opacity).toBe(0.5) }) it('should traverse into groups and set opacity in their children', () => { const ids = editor.createShapesFromJsx([ , , ]) editor.setSelectedShapes([ids.groupA]) editor.setOpacityForSelectedShapes(0.5) editor.setOpacityForNextShapes(0.5) // a wasn't selected... expect(editor.getShape(ids.boxA)!.opacity).toBe(1) // b, c, & d were within a selected group... expect(editor.getShape(ids.boxB)!.opacity).toBe(0.5) expect(editor.getShape(ids.boxC)!.opacity).toBe(0.5) expect(editor.getShape(ids.boxD)!.opacity).toBe(0.5) // groups get skipped expect(editor.getShape(ids.groupA)!.opacity).toBe(1) expect(editor.getShape(ids.groupB)!.opacity).toBe(1) }) it('stores opacity on opacityForNextShape', () => { editor.setOpacityForSelectedShapes(0.5) editor.setOpacityForNextShapes(0.5) expect(editor.getInstanceState().opacityForNextShape).toBe(0.5) editor.setOpacityForSelectedShapes(0.6) editor.setOpacityForNextShapes(0.6) expect(editor.getInstanceState().opacityForNextShape).toBe(0.6) }) }) describe('Editor.TickManager', () => { it('Does not produce NaN values when elapsed is 0', () => { // a helper that calls update pointer velocity with a given elapsed time. // usually this is called by the app's tick manager, using the elapsed time // between two animation frames, but we're calling it directly here. const tick = (ms: number) => { // @ts-ignore editor._tickManager.updatePointerVelocity(ms) } // 1. pointer velocity should be 0 when there is no movement expect(editor.inputs.pointerVelocity.toJson()).toCloselyMatchObject({ x: 0, y: 0 }) editor.pointerMove(10, 10) // 2. moving is not enough, we also need to wait a frame before the velocity is updated expect(editor.inputs.pointerVelocity.toJson()).toCloselyMatchObject({ x: 0, y: 0 }) // 3. once time passes, the pointer velocity should be updated tick(16) expect(editor.inputs.pointerVelocity.toJson()).toCloselyMatchObject({ x: 0.3125, y: 0.3125 }) // 4. let's do it again, it should be updated again. move, tick, measure editor.pointerMove(20, 20) tick(16) expect(editor.inputs.pointerVelocity.toJson()).toCloselyMatchObject({ x: 0.46875, y: 0.46875 }) // 5. if we tick again without movement, the velocity should decay tick(16) expect(editor.inputs.pointerVelocity.toJson()).toCloselyMatchObject({ x: 0.23437, y: 0.23437 }) // 6. if updatePointerVelocity is (for whatever reason) called with an elapsed time of zero milliseconds, it should be ignored tick(0) expect(editor.inputs.pointerVelocity.toJson()).toCloselyMatchObject({ x: 0.23437, y: 0.23437 }) }) }) describe("App's default tool", () => { it('Is select for regular app', () => { editor = new TestEditor() expect(editor.getCurrentToolId()).toBe('select') }) it('Is hand for readonly mode', () => { editor = new TestEditor() editor.updateInstanceState({ isReadonly: true }) editor.setCurrentTool('hand') expect(editor.getCurrentToolId()).toBe('hand') }) }) describe('currentToolId', () => { it('is select by default', () => { expect(editor.getCurrentToolId()).toBe('select') }) it('is set to the last used tool', () => { editor.setCurrentTool('draw') expect(editor.getCurrentToolId()).toBe('draw') editor.setCurrentTool('geo') expect(editor.getCurrentToolId()).toBe('geo') }) it('stays the selected tool during shape creation interactions that technically use the select tool', () => { expect(editor.getCurrentToolId()).toBe('select') editor.setCurrentTool('geo') editor.pointerDown(0, 0) editor.pointerMove(100, 100) expect(editor.getCurrentToolId()).toBe('geo') editor.expectToBeIn('select.resizing') }) it('reverts back to select if we finish the interaction', () => { expect(editor.getCurrentToolId()).toBe('select') editor.setCurrentTool('geo') editor.pointerDown(0, 0) editor.pointerMove(100, 100) expect(editor.getCurrentToolId()).toBe('geo') editor.expectToBeIn('select.resizing') editor.pointerUp(100, 100) expect(editor.getCurrentToolId()).toBe('select') }) it('stays on the selected tool if we cancel the interaction', () => { expect(editor.getCurrentToolId()).toBe('select') editor.setCurrentTool('geo') editor.pointerDown(0, 0) editor.pointerMove(100, 100) expect(editor.getCurrentToolId()).toBe('geo') editor.expectToBeIn('select.resizing') editor.cancel() expect(editor.getCurrentToolId()).toBe('geo') }) }) describe('isFocused', () => { beforeEach(() => { // lame but duplicated here since this was moved into a hook const container = editor.getContainer() const updateFocus = debounce(() => { const { activeElement } = document const { isFocused: wasFocused } = editor.getInstanceState() const isFocused = document.hasFocus() && (container === activeElement || container.contains(activeElement)) if (wasFocused !== isFocused) { editor.updateInstanceState({ isFocused }) editor.updateViewportScreenBounds() if (!isFocused) { // When losing focus, run complete() to ensure that any interacts end editor.complete() } } }, 32) container.addEventListener('focusin', updateFocus) container.addEventListener('focus', updateFocus) container.addEventListener('focusout', updateFocus) container.addEventListener('blur', updateFocus) }) it('is false by default', () => { expect(editor.getInstanceState().isFocused).toBe(false) }) it('becomes true when you call .focus()', () => { editor.updateInstanceState({ isFocused: true }) expect(editor.getInstanceState().isFocused).toBe(true) }) it('becomes false when you call .blur()', () => { editor.updateInstanceState({ isFocused: true }) expect(editor.getInstanceState().isFocused).toBe(true) editor.updateInstanceState({ isFocused: false }) expect(editor.getInstanceState().isFocused).toBe(false) }) it('remains false when you call .blur()', () => { expect(editor.getInstanceState().isFocused).toBe(false) editor.updateInstanceState({ isFocused: false }) expect(editor.getInstanceState().isFocused).toBe(false) }) it('becomes true when the container div receives a focus event', () => { jest.advanceTimersByTime(100) expect(editor.getInstanceState().isFocused).toBe(false) editor.elm.focus() jest.advanceTimersByTime(100) expect(editor.getInstanceState().isFocused).toBe(true) }) it('becomes false when the container div receives a blur event', () => { editor.elm.focus() jest.advanceTimersByTime(100) expect(editor.getInstanceState().isFocused).toBe(true) editor.elm.blur() jest.advanceTimersByTime(100) expect(editor.getInstanceState().isFocused).toBe(false) }) it.skip('becomes true when a child of the app container div receives a focusin event', () => { // We need to skip this one because it's not actually true: the focusin event will bubble // to the document.body, resulting in that being the active element. In reality, the editor's // container would also have received a focus event, and after the editor's debounce ends, // the container (or one of its descendants) will be the focused element. editor.elm.blur() const child = document.createElement('div') editor.elm.appendChild(child) jest.advanceTimersByTime(100) expect(editor.getInstanceState().isFocused).toBe(false) child.dispatchEvent(new FocusEvent('focusin', { bubbles: true })) jest.advanceTimersByTime(100) expect(editor.getInstanceState().isFocused).toBe(true) child.dispatchEvent(new FocusEvent('focusout', { bubbles: true })) jest.advanceTimersByTime(100) expect(editor.getInstanceState().isFocused).toBe(false) }) it('becomes false when a child of the app container div receives a focusout event', () => { const child = document.createElement('div') editor.elm.appendChild(child) editor.updateInstanceState({ isFocused: true }) expect(editor.getInstanceState().isFocused).toBe(true) child.dispatchEvent(new FocusEvent('focusout', { bubbles: true })) jest.advanceTimersByTime(100) expect(editor.getInstanceState().isFocused).toBe(false) }) }) describe('getShapeUtil', () => { let myUtil: any beforeEach(() => { class _MyFakeShapeUtil extends BaseBoxShapeUtil { static override type = 'blorg' getDefaultProps() { return { w: 100, h: 100, } } component() { throw new Error('Method not implemented.') } indicator() { throw new Error('Method not implemented.') } } myUtil = _MyFakeShapeUtil editor = new TestEditor({ shapeUtils: [_MyFakeShapeUtil], }) editor.createShapes([ { id: ids.box1, type: 'blorg', x: 100, y: 100, props: { w: 100, h: 100 } }, ]) const page1 = editor.getCurrentPageId() editor.createPage({ name: 'page 2', id: ids.page2 }) editor.setCurrentPage(page1) }) it('accepts shapes', () => { const shape = editor.getShape(ids.box1)! const util = editor.getShapeUtil(shape) expect(util).toBeInstanceOf(myUtil) }) it('accepts shape types', () => { const util = editor.getShapeUtil('blorg') expect(util).toBeInstanceOf(myUtil) }) it('throws if that shape type isnt registered', () => { const myMissingShape = { type: 'missing' } as TLShape expect(() => editor.getShapeUtil(myMissingShape)).toThrowErrorMatchingInlineSnapshot( `"No shape util found for type \\"missing\\""` ) }) it('throws if that type isnt registered', () => { expect(() => editor.getShapeUtil('missing')).toThrowErrorMatchingInlineSnapshot( `"No shape util found for type \\"missing\\""` ) }) }) describe('snapshots', () => { it('creates and loads a snapshot', () => { const ids = { imageA: createShapeId('imageA'), boxA: createShapeId('boxA'), imageAssetA: AssetRecordType.createId('imageAssetA'), } editor.createAssets([ { type: 'image', id: ids.imageAssetA, typeName: 'asset', props: { w: 1200, h: 800, name: '', isAnimated: false, mimeType: 'png', src: '', }, meta: {}, }, ]) editor.createShapes([ { type: 'geo', x: 0, y: 0 }, { type: 'geo', x: 100, y: 0 }, { id: ids.imageA, type: 'image', props: { playing: false, url: '', w: 1200, h: 800, assetId: ids.imageAssetA, }, x: 0, y: 1200, }, ]) const page2Id = PageRecordType.createId('page2') editor.createPage({ id: page2Id, }) editor.setCurrentPage(page2Id) editor.createShapes([ { type: 'geo', x: 0, y: 0 }, { type: 'geo', x: 100, y: 0 }, ]) editor.selectAll() // now serialize const snapshot = editor.store.getSnapshot() const newEditor = new TestEditor() newEditor.store.loadSnapshot(snapshot) expect(editor.store.serialize()).toEqual(newEditor.store.serialize()) }) }) describe('when the user prefers dark UI', () => { beforeEach(() => { window.matchMedia = jest.fn().mockImplementation((query) => { return { matches: query === '(prefers-color-scheme: dark)', media: query, onchange: null, addEventListener: jest.fn(), removeEventListener: jest.fn(), dispatchEvent: jest.fn(), } }) }) it('isDarkMode should be false by default', () => { editor = new TestEditor({}) expect(editor.user.getIsDarkMode()).toBe(false) }) it('isDarkMode should be false when inferDarkMode is false', () => { editor = new TestEditor({ inferDarkMode: false }) expect(editor.user.getIsDarkMode()).toBe(false) }) it('should be true if the editor was instantiated with inferDarkMode', () => { editor = new TestEditor({ inferDarkMode: true }) expect(editor.user.getIsDarkMode()).toBe(true) }) }) describe('when the user prefers light UI', () => { beforeEach(() => { window.matchMedia = jest.fn().mockImplementation((query) => { return { matches: false, media: query, onchange: null, addEventListener: jest.fn(), removeEventListener: jest.fn(), dispatchEvent: jest.fn(), } }) }) it('isDarkMode should be false by default', () => { editor = new TestEditor({}) expect(editor.user.getIsDarkMode()).toBe(false) }) it('isDarkMode should be false when inferDarkMode is false', () => { editor = new TestEditor({ inferDarkMode: false }) expect(editor.user.getIsDarkMode()).toBe(false) }) it('should be false if the editor was instantiated with inferDarkMode', () => { editor = new TestEditor({ inferDarkMode: true }) expect(editor.user.getIsDarkMode()).toBe(false) }) })