Skip to content

AI-native design editor. Open-source Figma alternative.

6.5 KB
Raw Blame
import { describe, test, expect } from 'bun:test'

import { createEditor, gridNudge } from '@open-pencil/core'

import { getNodeOrThrow } from '../helpers/assert'

describe('nudgeSelected', () => {
  function setup() {
    const editor = createEditor()
    const pageId = editor.graph.getPages()[0].id
    const rect = editor.graph.createNode('RECTANGLE', pageId, {
      name: 'Rect',
      x: 100,
      y: 200,
      width: 50,
      height: 50
    })
    editor.select([rect.id])
    return { editor, rect }
  }

  test('nudge moves selected node by 1px', () => {
    const { editor, rect } = setup()

    editor.nudgeSelected(1, 0)
    expect(getNodeOrThrow(editor.graph, rect.id).x).toBe(101)
    expect(getNodeOrThrow(editor.graph, rect.id).y).toBe(200)

    editor.nudgeSelected(0, -1)
    expect(getNodeOrThrow(editor.graph, rect.id).x).toBe(101)
    expect(getNodeOrThrow(editor.graph, rect.id).y).toBe(199)
  })

  test('shift nudge moves by 10px', () => {
    const { editor, rect } = setup()

    editor.nudgeSelected(10, 0)
    expect(getNodeOrThrow(editor.graph, rect.id).x).toBe(110)

    editor.nudgeSelected(0, 10)
    expect(getNodeOrThrow(editor.graph, rect.id).y).toBe(210)
  })

  test('nudge is undoable as a single entry', () => {
    const { editor, rect } = setup()

    editor.nudgeSelected(1, 0)
    editor.nudgeSelected(1, 0)
    editor.nudgeSelected(1, 0)
    editor.flushNudge()

    expect(getNodeOrThrow(editor.graph, rect.id).x).toBe(103)
    expect(editor.undo.canUndo).toBe(true)

    editor.undo.undo()
    expect(getNodeOrThrow(editor.graph, rect.id).x).toBe(100)
    expect(getNodeOrThrow(editor.graph, rect.id).y).toBe(200)

    editor.undo.redo()
    expect(getNodeOrThrow(editor.graph, rect.id).x).toBe(103)
  })

  test('nudge skips locked nodes', () => {
    const { editor, rect } = setup()

    editor.graph.updateNode(rect.id, { locked: true })
    editor.nudgeSelected(10, 10)
    editor.flushNudge()
    expect(getNodeOrThrow(editor.graph, rect.id).x).toBe(100)
    expect(getNodeOrThrow(editor.graph, rect.id).y).toBe(200)
    expect(editor.undo.canUndo).toBe(false)
  })

  test('nudge does nothing with no selection', () => {
    const { editor } = setup()

    editor.clearSelection()
    editor.nudgeSelected(10, 10)
    editor.flushNudge()
    expect(editor.undo.canUndo).toBe(false)
  })

  test('nudge moves multiple selected nodes', () => {
    const { editor, rect } = setup()
    const pageId = editor.graph.getPages()[0].id
    const rect2 = editor.graph.createNode('RECTANGLE', pageId, {
      name: 'Rect2',
      x: 300,
      y: 400,
      width: 50,
      height: 50
    })
    editor.select([rect.id, rect2.id])

    editor.nudgeSelected(-5, 3)
    editor.flushNudge()

    expect(getNodeOrThrow(editor.graph, rect.id).x).toBe(95)
    expect(getNodeOrThrow(editor.graph, rect.id).y).toBe(203)
    expect(getNodeOrThrow(editor.graph, rect2.id).x).toBe(295)
    expect(getNodeOrThrow(editor.graph, rect2.id).y).toBe(403)
  })

  test('separate nudge sequences create separate undo entries', () => {
    const { editor, rect } = setup()

    editor.nudgeSelected(5, 0)
    editor.flushNudge()

    editor.nudgeSelected(0, 5)
    editor.flushNudge()

    expect(getNodeOrThrow(editor.graph, rect.id).x).toBe(105)
    expect(getNodeOrThrow(editor.graph, rect.id).y).toBe(205)

    editor.undo.undo()
    expect(getNodeOrThrow(editor.graph, rect.id).x).toBe(105)
    expect(getNodeOrThrow(editor.graph, rect.id).y).toBe(200)

    editor.undo.undo()
    expect(getNodeOrThrow(editor.graph, rect.id).x).toBe(100)
    expect(getNodeOrThrow(editor.graph, rect.id).y).toBe(200)
  })
})

// Orders read from Figma desktop 126 after the same keys on four 60 × 40 layers.
describe('arrow keys in an auto layout flow', () => {
  function flow(layoutMode: 'HORIZONTAL' | 'VERTICAL') {
    const editor = createEditor()
    const parent = editor.graph.createNode('FRAME', editor.state.currentPageId, {
      layoutMode,
      primaryAxisSizing: 'HUG',
      counterAxisSizing: 'HUG',
      itemSpacing: 10
    })
    const [a, b, c, d] = ['A', 'B', 'C', 'D'].map((name) =>
      editor.graph.createNode('RECTANGLE', parent.id, { name, width: 60, height: 40 })
    )
    editor.runLayoutForNode(parent.id)
    const order = () => parent.childIds.map((id) => editor.graph.getNode(id)?.name).join('')
    return { editor, parent, a, b, c, d, order }
  }

  test('move a layer one slot along a row, Shift too, and not across it', () => {
    const { editor, a, b, order } = flow('HORIZONTAL')
    editor.select([b.id])
    editor.nudgeSelected(1, 0)
    expect(order()).toBe('ACBD')
    editor.nudgeSelected(10, 0)
    expect(order()).toBe('ACDB')
    editor.nudgeSelected(0, 1)
    expect(order()).toBe('ACDB')
    editor.nudgeSelected(-1, 0)
    expect(order()).toBe('ACBD')
    editor.select([a.id])
    editor.nudgeSelected(10, 0)
    expect(order()).toBe('CABD')
    editor.dispose()
  })

  test('move a layer along a column with Down and Up', () => {
    const { editor, b, order } = flow('VERTICAL')
    editor.select([b.id])
    editor.nudgeSelected(0, 1)
    expect(order()).toBe('ACBD')
    editor.nudgeSelected(1, 0)
    expect(order()).toBe('ACBD')
    editor.nudgeSelected(0, -1)
    expect(order()).toBe('ABCD')
    editor.dispose()
  })

  test('move each selected layer one slot, and keep one at the end in place', () => {
    const { editor, a, c, order } = flow('HORIZONTAL')
    editor.select([a.id, c.id])
    editor.nudgeSelected(1, 0)
    expect(order()).toBe('BADC')
    editor.nudgeSelected(1, 0)
    expect(order()).toBe('BDAC')
    editor.dispose()
  })

  test('a run of keys is one undo step, even undone straight away', () => {
    const { editor, b, order } = flow('HORIZONTAL')
    editor.select([b.id])
    editor.nudgeSelected(1, 0)
    editor.nudgeSelected(1, 0)
    editor.undoAction()
    expect(order()).toBe('ABCD')
    expect(editor.undo.canUndo).toBe(false)
    editor.redoAction()
    expect(order()).toBe('ACDB')
    editor.dispose()
  })
})

describe('Shift+arrow on a board', () => {
  // FigJam: Shift+arrow moves a layer to the next multiple of 16 that way, not by 10.
  test('moves the top-left corner to the next grid line in the arrow’s direction', () => {
    expect(gridNudge({ x: 37, y: 40 }, { x: 1, y: 0 }, 16)).toEqual({ x: 11, y: 0 })
    expect(gridNudge({ x: 37, y: 40 }, { x: -1, y: 0 }, 16)).toEqual({ x: -5, y: 0 })
    expect(gridNudge({ x: 32, y: 48 }, { x: 0, y: 1 }, 16)).toEqual({ x: 0, y: 16 })
    expect(gridNudge({ x: 32, y: 48 }, { x: 0, y: -1 }, 16)).toEqual({ x: 0, y: -16 })
  })
})