Skip to content

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

feat(canvas): show the pixel grid and snap to it as Figma does (#1023)

Danila Poyarkov072e1f8fedc8
diff --git a/CHANGELOG.md b/CHANGELOG.md
index ca4182d5c..c5899a8a9 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -39,6 +39,7 @@
### Added
+- Show the pixel grid when zoomed in, as in Figma: from 800% on a standard display and 400% on a Retina one, toggled with **View → Pixel Grid** or <kbd>⇧</kbd><kbd>'</kbd>. <kbd>⇧</kbd><kbd>⌘</kbd><kbd>'</kbd> toggles **Snap to Pixel Grid**. The zoom menu in the properties panel lists both, with Figma's shortcuts, and labels its shortcuts for zoom to fit (<kbd>⇧</kbd><kbd>1</kbd>) and 100% (<kbd>⌘</kbd><kbd>0</kbd>); <kbd>⇧</kbd><kbd>R</kbd> toggles rulers and <kbd>⌥</kbd><kbd>⌘</kbd><kbd>\\</kbd> multiplayer cursors.
- Set a component's text, boolean, and swap properties on a design JSX `<Instance>` by name, as variants are set, such as `<Instance of="Card" Title="Hello" Badge={false} />`; `properties` accepts names too. An instance written this way still works after the document is saved to `.fig` and reopened, which gives each property a new ID ([#750](https://github.com/open-pencil/open-pencil/issues/750)).
- Save the open document to cloud storage with **File → Save to storage…**. The tab stays bound to the stored copy, so Save and auto-save write to the bucket; before storage is configured, the command opens its settings. A new Cloud Storage guide covers connecting a bucket, CORS, syncing, and provider notes.
- Add a variant to a standalone component from the header's **Add variant** button, as in Figma (#847): it becomes a component set named after it, whose existing instances and properties carry over, with a `Property 1=Variant2` copy below. A set's variant properties are rows of its **Properties** list, each opening to rename it and add, rename, reorder, or remove its values; removing a value variants still use moves them to another value. Variants that share a combination of values are named in a notice that selects them.
@@ -92,6 +93,7 @@
### Changed
+- With **Snap to Pixel Grid** on, moved layers and resized edges land on whole pixels at any zoom, and drawn layers start and end on whole pixels, as in Figma; zoomed in, moves and resizes could leave fractions before, and drawing was not snapped.
- Layers inside components and instances are outlined in purple when hovered or selected, with a purple size label, as in Figma; they were blue.
- The properties panel's variable picker groups variables by collection and shows each color variable's swatch, and the variables dialog points a value at another variable with the same picker, detaching it from the picker's footer.
- **Add variant** on a component set copies its last variant below it, 20 px apart, with the next free value such as `Variant3`, and grows the set to hold it, as Figma does. It used to place a copy with the same values to the right, which made a duplicate combination.
diff --git a/desktop/generated/menu.json b/desktop/generated/menu.json
index da650df4b..f93c9cd82 100644
--- a/desktop/generated/menu.json
+++ b/desktop/generated/menu.json
@@ -149,15 +149,18 @@
"items": [
{
"id": "view.zoom100",
- "label": "Zoom to 100%"
+ "label": "Zoom to 100%",
+ "accelerator": "CmdOrCtrl+0"
},
{
"id": "view.zoomFit",
- "label": "Zoom to Fit"
+ "label": "Zoom to Fit",
+ "accelerator": "Shift+1"
},
{
"id": "view.zoomSelection",
- "label": "Zoom to Selection"
+ "label": "Zoom to Selection",
+ "accelerator": "Shift+2"
},
{
"id": "zoom-in",
@@ -193,11 +196,19 @@
{
"id": "view-rulers",
"label": "Rulers",
+ "accelerator": "Shift+R",
+ "checkbox": true
+ },
+ {
+ "id": "view-pixel-grid",
+ "label": "Pixel Grid",
+ "accelerator": "Shift+'",
"checkbox": true
},
{
"id": "view-multiplayer-cursors",
"label": "Multiplayer Cursors",
+ "accelerator": "Alt+CmdOrCtrl+\\",
"checkbox": true
},
{
@@ -249,6 +260,7 @@
{
"id": "snap-pixel-grid",
"label": "Snap to Pixel Grid",
+ "accelerator": "CmdOrCtrl+Shift+'",
"checkbox": true
},
{
diff --git a/packages/core/src/canvas/overlays/pixel-grid.ts b/packages/core/src/canvas/overlays/pixel-grid.ts
new file mode 100644
index 000000000..34dc52fc8
--- /dev/null
+++ b/packages/core/src/canvas/overlays/pixel-grid.ts
@@ -0,0 +1,81 @@
+import type { Canvas } from 'canvaskit-wasm'
+
+import type { Color } from '@open-pencil/scene-graph/primitives'
+
+import type { SkiaRenderer } from '#core/canvas/renderer'
+
+/** Device pixels one document pixel must cover before Figma shows the pixel grid: 800% at 1×. */
+export const PIXEL_GRID_MIN_DEVICE_PIXELS = 8
+
+/**
+ * The grid's line colour over the page, measured in Figma desktop 126: a light line on a dark page
+ * (#1E1E1E becomes #3E3E3E) and a dark one on a light page (#F5F5F5 becomes #E8E8E8).
+ */
+const DARK_PAGE_LINE: Color = { r: 1, g: 1, b: 1, a: 0.142 }
+const LIGHT_PAGE_LINE: Color = { r: 0, g: 0, b: 0, a: 0.053 }
+
+/** Whether the grid shows at this zoom and pixel density. */
+export function pixelGridVisible(zoom: number, dpr: number): boolean {
+ return zoom * dpr >= PIXEL_GRID_MIN_DEVICE_PIXELS
+}
+
+/**
+ * One line per document pixel, decided per device pixel: the line for document pixel k sits on
+ * device pixel round(offset + k · step), the same rounding a drawn rectangle would get. Computing
+ * it in the shader keeps the grid one draw call, whatever the zoom or viewport.
+ */
+const PIXEL_GRID_SHADER = `
+uniform float2 gridOffset;
+uniform float2 gridSpacing;
+uniform float4 lineColor;
+uniform float dpr;
+
+bool onLine(float device, float origin, float spacing) {
+ float pixel = floor(device);
+ float nearest = floor((pixel - origin) / spacing + 0.5);
+ return pixel == floor(origin + nearest * spacing + 0.5);
+}
+
+half4 main(float2 position) {
+ float2 device = position * dpr;
+ if (onLine(device.x, gridOffset.x, gridSpacing.x) || onLine(device.y, gridOffset.y, gridSpacing.y))
+ return half4(lineColor.rgb * lineColor.a, lineColor.a);
+ return half4(0);
+}
+`
+
+function lineColor(page: Color): Color {
+ const luminance = 0.2126 * page.r + 0.7152 * page.g + 0.0722 * page.b
+ return luminance < 0.5 ? DARK_PAGE_LINE : LIGHT_PAGE_LINE
+}
+
+/** Figma's pixel grid: a line at every document pixel once zoomed in far enough to tell them apart. */
+export function drawPixelGrid(r: SkiaRenderer, canvas: Canvas): void {
+ if (!pixelGridVisible(r.zoom, r.dpr)) return
+ if (!r.pixelGridEffect) {
+ let error = ''
+ r.pixelGridEffect = r.ck.RuntimeEffect.Make(PIXEL_GRID_SHADER, (message) => {
+ error = message
+ })
+ if (!r.pixelGridEffect) throw new Error(`Cannot compile the pixel grid: ${error}`)
+ }
+ const color = lineColor(r.pageColor)
+ const step = r.zoom * r.dpr
+ const shader = r.pixelGridEffect.makeShader([
+ r.panX * r.dpr,
+ r.panY * r.dpr,
+ step,
+ step,
+ color.r,
+ color.g,
+ color.b,
+ color.a,
+ r.dpr
+ ])
+ // Skia scales a shader by the paint's alpha, which earlier overlays may have left translucent.
+ r.auxFill.setAlphaf(1)
+ r.auxFill.setShader(shader)
+ canvas.drawRect(r.ck.LTRBRect(0, 0, r.viewportWidth, r.viewportHeight), r.auxFill)
+ r.auxFill.setShader(null)
+ shader.delete()
+}
diff --git a/packages/core/src/canvas/renderer.ts b/packages/core/src/canvas/renderer.ts
index 9e141ef1c..430a39c20 100644
--- a/packages/core/src/canvas/renderer.ts
+++ b/packages/core/src/canvas/renderer.ts
@@ -81,6 +81,7 @@ export class SkiaRenderer {
surface: Surface
declare fillPaint: Paint
diamondGradientEffect: RuntimeEffect | null = null
+ pixelGridEffect: RuntimeEffect | null = null
declare strokePaint: Paint
declare selectionPaint: Paint
declare parentOutlinePaint: Paint
diff --git a/packages/core/src/canvas/renderer/lifecycle.ts b/packages/core/src/canvas/renderer/lifecycle.ts
index c244cee50..9f51dc292 100644
--- a/packages/core/src/canvas/renderer/lifecycle.ts
+++ b/packages/core/src/canvas/renderer/lifecycle.ts
@@ -38,6 +38,8 @@ export function destroyRenderer(r: SkiaRenderer): void {
r.fillPaint.delete()
r.diamondGradientEffect?.delete()
r.diamondGradientEffect = null
+ r.pixelGridEffect?.delete()
+ r.pixelGridEffect = null
r.strokePaint.delete()
r.selectionPaint.delete()
r.parentOutlinePaint.delete()
diff --git a/packages/core/src/canvas/renderer/overlay-pass.ts b/packages/core/src/canvas/renderer/overlay-pass.ts
index 088b00aa8..c77e5f3f6 100644
--- a/packages/core/src/canvas/renderer/overlay-pass.ts
+++ b/packages/core/src/canvas/renderer/overlay-pass.ts
@@ -9,6 +9,7 @@ import { drawComponentSetBorders } from '#core/canvas/overlays/component-sets'
import { drawDropTarget, drawEditingText } from '#core/canvas/overlays/feedback'
import { drawLayoutOutlines } from '#core/canvas/overlays/layout-outlines'
import { drawMeasurementSegment } from '#core/canvas/overlays/measurement'
+import { drawPixelGrid } from '#core/canvas/overlays/pixel-grid'
import { drawCodeFocus } from '#core/canvas/overlays/selection'
import { drawSlotOutlines } from '#core/canvas/overlays/slots'
import type { RenderOverlays, SkiaRenderer } from '#core/canvas/renderer'
@@ -98,6 +99,8 @@ export function drawOverlayPass(
measuring || overlays.hoveredNodeId === overlays.nodeEditState?.nodeId
? null
: overlays.hoveredNodeId
+ // Over the design and under every editing outline, as in Figma.
+ if (overlays.showPixelGrid) drawPixelGrid(r, canvas)
drawComponentSetBorders(r, canvas, graph, overlays.rotationPreview)
drawCodeFocus(r, canvas, graph, overlays.codeFocusNodeId, overlays.rotationPreview)
if (!measuring)
diff --git a/packages/core/src/canvas/renderer/pipeline.ts b/packages/core/src/canvas/renderer/pipeline.ts
index f5332af2f..45d572ba2 100644
--- a/packages/core/src/canvas/renderer/pipeline.ts
+++ b/packages/core/src/canvas/renderer/pipeline.ts
@@ -85,6 +85,7 @@ export function renderFromEditorState(
playing: previewing,
playIslands: previewing ? new Set(playIslandRoots(graph, state.currentPageId)) : undefined,
hoveredNodeId: previewing ? null : state.hoveredNodeId,
+ showPixelGrid: !previewing && state.showPixelGrid !== false,
transforming: state.transforming,
measurementMode: state.measurementMode,
enteredContainerId: state.enteredContainerId,
diff --git a/packages/core/src/canvas/renderer/types.ts b/packages/core/src/canvas/renderer/types.ts
index 0041680d4..c360a109b 100644
--- a/packages/core/src/canvas/renderer/types.ts
+++ b/packages/core/src/canvas/renderer/types.ts
@@ -38,6 +38,8 @@ export interface RenderOverlays {
/** Layers a previewing canvas leaves to its live islands. */
playIslands?: ReadonlySet<string>
hoveredNodeId?: string | null
+ /** Draw the pixel grid when zoomed in far enough. */
+ showPixelGrid?: boolean
transforming?: boolean
measurementMode?: MeasurementMode
enteredContainerId?: string | null
diff --git a/packages/core/src/editor/state/shared.ts b/packages/core/src/editor/state/shared.ts
index c256204f8..1571f590f 100644
--- a/packages/core/src/editor/state/shared.ts
+++ b/packages/core/src/editor/state/shared.ts
@@ -5,6 +5,7 @@ export function createDefaultEditorSharedState(): EditorSharedState {
return {
activeTool: 'SELECT',
snappingPreferences: { ...DEFAULT_SNAPPING_PREFERENCES },
+ showPixelGrid: true,
presenceCursors: [],
documentName: 'Untitled',
designIssues: null,
diff --git a/packages/core/src/editor/types.ts b/packages/core/src/editor/types.ts
index 81a0c349c..c3b888161 100644
--- a/packages/core/src/editor/types.ts
+++ b/packages/core/src/editor/types.ts
@@ -41,6 +41,8 @@ export type Tool =
export interface EditorSharedState {
activeTool: Tool
snappingPreferences: SnappingPreferences
+ /** Draw the pixel grid once zoomed in far enough, as Figma's View › Pixel grid; shown unless false. */
+ showPixelGrid?: boolean
presenceCursors: PresenceCursor[]
documentName: string
/** Design check markers and highlight, shared by every canvas pane. */
diff --git a/packages/core/tests/canvas/pixel-grid.test.ts b/packages/core/tests/canvas/pixel-grid.test.ts
new file mode 100644
index 000000000..94e10b151
--- /dev/null
+++ b/packages/core/tests/canvas/pixel-grid.test.ts
@@ -0,0 +1,13 @@
+import { describe, expect, test } from 'bun:test'
+
+import { pixelGridVisible } from '#core/canvas/overlays/pixel-grid'
+
+// Figma desktop 126 shows the grid once a document pixel covers 8 device pixels.
+describe('pixel grid', () => {
+ test('shows from 800% at 1× density and from 400% at 2×', () => {
+ expect(pixelGridVisible(7.9, 1)).toBe(false)
+ expect(pixelGridVisible(8, 1)).toBe(true)
+ expect(pixelGridVisible(3.9, 2)).toBe(false)
+ expect(pixelGridVisible(4, 2)).toBe(true)
+ })
+})
diff --git a/packages/docs/user-guide/canvas-navigation.md b/packages/docs/user-guide/canvas-navigation.md
index 1c5a6b035..9e29689b9 100644
--- a/packages/docs/user-guide/canvas-navigation.md
+++ b/packages/docs/user-guide/canvas-navigation.md
@@ -39,6 +39,16 @@ Pinch-to-zoom on UI panels (layers, properties) is prevented so it doesn't accid
| Zoom in | <kbd>⌘</kbd><kbd>+</kbd> | <kbd>Ctrl</kbd> + <kbd>+</kbd> |
| Zoom out | <kbd>⌘</kbd><kbd>−</kbd> | <kbd>Ctrl</kbd> + <kbd>−</kbd> |
| Zoom to 100% | <kbd>⌘</kbd><kbd>0</kbd> | <kbd>Ctrl</kbd> + <kbd>0</kbd> |
+| Zoom to fit | <kbd>⇧</kbd><kbd>1</kbd> | <kbd>Shift</kbd> + <kbd>1</kbd> |
+| Zoom to selection | <kbd>⇧</kbd><kbd>2</kbd> | <kbd>Shift</kbd> + <kbd>2</kbd> |
+| Pixel grid | <kbd>⇧</kbd><kbd>'</kbd> | <kbd>Shift</kbd> + <kbd>'</kbd> |
+| Snap to pixel grid | <kbd>⇧</kbd><kbd>⌘</kbd><kbd>'</kbd> | <kbd>Shift</kbd> + <kbd>Ctrl</kbd> + <kbd>'</kbd> |
+| Rulers | <kbd>⇧</kbd><kbd>R</kbd> | <kbd>Shift</kbd> + <kbd>R</kbd> |
+| Multiplayer cursors | <kbd>⌥</kbd><kbd>⌘</kbd><kbd>\\</kbd> | <kbd>Alt</kbd> + <kbd>Ctrl</kbd> + <kbd>\\</kbd> |
+
+## Pixel Grid
+
+Zoomed in far enough that each document pixel covers eight screen pixels (800% on a standard display, 400% on a Retina one), the canvas shows a line at every pixel, as in Figma. Turn it off or on with **View → Pixel Grid**.
## Ruler Guides
@@ -55,6 +65,8 @@ Under **View → Preferences**, toggle **Snap to Geometry**, **Snap to Objects**
Geometry and object snapping help align vector points, moved layers, and resized edges with nearby geometry, objects, guides, and frame bounds. Alignment lines appear for those targets; pixel-grid rounding does not draw an alignment line for every pixel.
+With **Snap to Pixel Grid** on, moved layers, resized edges, and drawn layers land on whole pixels at any zoom, even when they started between pixels. A snap to an object or guide wins over the grid. Arrow-key nudges and values typed in the properties panel keep their fractions.
+
Hold <kbd>Control</kbd> during a layer drag to temporarily bypass object and pixel snapping, including on macOS where this is Control, not Command.
## Distance Measurements
diff --git a/packages/vue/src/editor/commands/registry.ts b/packages/vue/src/editor/commands/registry.ts
index 2d1daa58e..3822c9012 100644
--- a/packages/vue/src/editor/commands/registry.ts
+++ b/packages/vue/src/editor/commands/registry.ts
@@ -112,9 +112,9 @@ export const EDITOR_COMMAND_METADATA = {
'selection.outlineStroke': { contextTestId: 'context-outline-stroke' },
'selection.moveToPage': {},
'selection.setOpacity': { shortcut: '1-9, 0' },
- 'view.zoom100': { keybinding: '$mod+Digit0' },
- 'view.zoomFit': { keybinding: ['$mod+Digit1', 'Shift+Digit1'] },
- 'view.zoomSelection': { keybinding: ['$mod+Digit2', 'Shift+Digit2'] }
+ 'view.zoom100': { shortcut: 'MOD+0', keybinding: '$mod+Digit0' },
+ 'view.zoomFit': { shortcut: 'SHIFT+1', keybinding: ['$mod+Digit1', 'Shift+Digit1'] },
+ 'view.zoomSelection': { shortcut: 'SHIFT+2', keybinding: ['$mod+Digit2', 'Shift+Digit2'] }
} satisfies Record<EditorCommandId, EditorCommandMetadata>
export function editorCommandMetadata(id: EditorCommandId): EditorCommandMetadata {
diff --git a/packages/vue/src/i18n/locales/de/commands.json b/packages/vue/src/i18n/locales/de/commands.json
index be7725572..0f4f5d223 100644
--- a/packages/vue/src/i18n/locales/de/commands.json
+++ b/packages/vue/src/i18n/locales/de/commands.json
@@ -18,7 +18,9 @@
"sendToBack": "In den Hintergrund",
"moveToPage": "Auf Seite verschieben",
"setOpacity": "Deckkraft festlegen",
+ "zoomTo50": "Zoom 50 %",
"zoomTo100": "Zoom 100 %",
+ "zoomTo200": "Zoom 200 %",
"zoomToFit": "Einpassen",
"zoomToSelection": "Auswahl einpassen",
"groupSelection": "Gruppieren",
diff --git a/packages/vue/src/i18n/locales/de/menu.json b/packages/vue/src/i18n/locales/de/menu.json
index 4bb44e08c..d2e68e588 100644
--- a/packages/vue/src/i18n/locales/de/menu.json
+++ b/packages/vue/src/i18n/locales/de/menu.json
@@ -64,6 +64,7 @@
"snapToPixelGrid": "Am Pixelraster ausrichten",
"renameSelection": "Auswahl umbenennen…",
"rulers": "Lineale",
+ "pixelGrid": "Pixelraster",
"settings": "Einstellungen…",
"variables": "Variablen…",
"insertIcon": "Symbol einfügen…",
diff --git a/packages/vue/src/i18n/locales/es/commands.json b/packages/vue/src/i18n/locales/es/commands.json
index 8d259285c..c0c0a9e73 100644
--- a/packages/vue/src/i18n/locales/es/commands.json
+++ b/packages/vue/src/i18n/locales/es/commands.json
@@ -18,7 +18,9 @@
"sendToBack": "Enviar al fondo",
"moveToPage": "Mover a página",
"setOpacity": "Establecer opacidad",
+ "zoomTo50": "Zoom 50 %",
"zoomTo100": "Zoom 100 %",
+ "zoomTo200": "Zoom 200 %",
"zoomToFit": "Ajustar a pantalla",
"zoomToSelection": "Zoom a selección",
"groupSelection": "Agrupar",
diff --git a/packages/vue/src/i18n/locales/es/menu.json b/packages/vue/src/i18n/locales/es/menu.json
index 2402b5984..f3f20d8db 100644
--- a/packages/vue/src/i18n/locales/es/menu.json
+++ b/packages/vue/src/i18n/locales/es/menu.json
@@ -64,6 +64,7 @@
"snapToPixelGrid": "Ajustar a la cuadrícula de píxeles",
"renameSelection": "Renombrar selección…",
"rulers": "Reglas",
+ "pixelGrid": "Cuadrícula de píxeles",
"settings": "Ajustes…",
"variables": "Variables…",
"insertIcon": "Insertar icono…",
diff --git a/packages/vue/src/i18n/locales/fr/commands.json b/packages/vue/src/i18n/locales/fr/commands.json
index ae12af3fb..1fde12222 100644
--- a/packages/vue/src/i18n/locales/fr/commands.json
+++ b/packages/vue/src/i18n/locales/fr/commands.json
@@ -18,7 +18,9 @@
"sendToBack": "Mettre en arrière-plan",
"moveToPage": "Déplacer vers la page",
"setOpacity": "Définir l'opacité",
+ "zoomTo50": "Zoom 50 %",
"zoomTo100": "Zoom 100 %",
+ "zoomTo200": "Zoom 200 %",
"zoomToFit": "Ajuster à l'écran",
"zoomToSelection": "Zoom sur la sélection",
"groupSelection": "Grouper",
diff --git a/packages/vue/src/i18n/locales/fr/menu.json b/packages/vue/src/i18n/locales/fr/menu.json
index 6c63aedb1..10176c7da 100644
--- a/packages/vue/src/i18n/locales/fr/menu.json
+++ b/packages/vue/src/i18n/locales/fr/menu.json
@@ -64,6 +64,7 @@
"snapToPixelGrid": "Aligner sur la grille de pixels",
"renameSelection": "Renommer la sélection…",
"rulers": "Règles",
+ "pixelGrid": "Grille de pixels",
"settings": "Paramètres…",
"variables": "Variables…",
"insertIcon": "Insérer une icône…",
diff --git a/packages/vue/src/i18n/locales/it/commands.json b/packages/vue/src/i18n/locales/it/commands.json
index 1479747e3..c71f14c08 100644
--- a/packages/vue/src/i18n/locales/it/commands.json
+++ b/packages/vue/src/i18n/locales/it/commands.json
@@ -18,7 +18,9 @@
"sendToBack": "Porta in secondo piano",
"moveToPage": "Sposta nella pagina",
"setOpacity": "Imposta opacità",
+ "zoomTo50": "Zoom 50%",
"zoomTo100": "Zoom 100%",
+ "zoomTo200": "Zoom 200%",
"zoomToFit": "Adatta allo schermo",
"zoomToSelection": "Zoom sulla selezione",
"groupSelection": "Raggruppa",
diff --git a/packages/vue/src/i18n/locales/it/menu.json b/packages/vue/src/i18n/locales/it/menu.json
index 8aae7660e..8cc35ec50 100644
--- a/packages/vue/src/i18n/locales/it/menu.json
+++ b/packages/vue/src/i18n/locales/it/menu.json
@@ -64,6 +64,7 @@
"snapToPixelGrid": "Aggancia alla griglia di pixel",
"renameSelection": "Rinomina selezione…",
"rulers": "Righelli",
+ "pixelGrid": "Griglia di pixel",
"settings": "Impostazioni…",
"variables": "Variabili…",
"insertIcon": "Inserisci icona…",
diff --git a/packages/vue/src/i18n/locales/ja/commands.json b/packages/vue/src/i18n/locales/ja/commands.json
index f33ab878e..7437214d5 100644
--- a/packages/vue/src/i18n/locales/ja/commands.json
+++ b/packages/vue/src/i18n/locales/ja/commands.json
@@ -18,7 +18,9 @@
"sendToBack": "最背面へ移動",
"moveToPage": "ページへ移動",
"setOpacity": "不透明度を設定",
+ "zoomTo50": "50%にズーム",
"zoomTo100": "100%にズーム",
+ "zoomTo200": "200%にズーム",
"zoomToFit": "画面に合わせる",
"zoomToSelection": "選択範囲にズーム",
"groupSelection": "グループ化",
diff --git a/packages/vue/src/i18n/locales/ja/menu.json b/packages/vue/src/i18n/locales/ja/menu.json
index 41480837f..19eb45057 100644
--- a/packages/vue/src/i18n/locales/ja/menu.json
+++ b/packages/vue/src/i18n/locales/ja/menu.json
@@ -64,6 +64,7 @@
"snapToPixelGrid": "ピクセルグリッドにスナップ",
"renameSelection": "選択範囲の名前を変更…",
"rulers": "ルーラー",
+ "pixelGrid": "ピクセルグリッド",
"settings": "設定…",
"variables": "変数…",
"insertIcon": "アイコンを挿入…",
diff --git a/packages/vue/src/i18n/locales/pl/commands.json b/packages/vue/src/i18n/locales/pl/commands.json
index 9cdddf6d9..a83d974e4 100644
--- a/packages/vue/src/i18n/locales/pl/commands.json
+++ b/packages/vue/src/i18n/locales/pl/commands.json
@@ -18,7 +18,9 @@
"sendToBack": "Przenieś na spód",
"moveToPage": "Przenieś na stronę",
"setOpacity": "Ustaw krycie",
+ "zoomTo50": "Zoom 50%",
"zoomTo100": "Zoom 100%",
+ "zoomTo200": "Zoom 200%",
"zoomToFit": "Dopasuj do ekranu",
"zoomToSelection": "Zoom do zaznaczenia",
"groupSelection": "Grupuj",
diff --git a/packages/vue/src/i18n/locales/pl/menu.json b/packages/vue/src/i18n/locales/pl/menu.json
index 3b63a2504..81cf2ba58 100644
--- a/packages/vue/src/i18n/locales/pl/menu.json
+++ b/packages/vue/src/i18n/locales/pl/menu.json
@@ -64,6 +64,7 @@
"snapToPixelGrid": "Przyciągaj do siatki pikseli",
"renameSelection": "Zmień nazwę zaznaczenia…",
"rulers": "Linijki",
+ "pixelGrid": "Siatka pikseli",
"settings": "Ustawienia…",
"variables": "Zmienne…",
"insertIcon": "Wstaw ikonę…",
diff --git a/packages/vue/src/i18n/locales/ru/commands.json b/packages/vue/src/i18n/locales/ru/commands.json
index d5f7b8167..05f10acf3 100644
--- a/packages/vue/src/i18n/locales/ru/commands.json
+++ b/packages/vue/src/i18n/locales/ru/commands.json
@@ -18,7 +18,9 @@
"sendToBack": "На задний план",
"moveToPage": "Переместить на страницу",
"setOpacity": "Задать непрозрачность",
+ "zoomTo50": "Масштаб 50%",
"zoomTo100": "Масштаб 100%",
+ "zoomTo200": "Масштаб 200%",
"zoomToFit": "Вписать в экран",
"zoomToSelection": "Масштаб по выделению",
"groupSelection": "Сгруппировать",
diff --git a/packages/vue/src/i18n/locales/ru/menu.json b/packages/vue/src/i18n/locales/ru/menu.json
index 29a7bb6d7..9dff3ca42 100644
--- a/packages/vue/src/i18n/locales/ru/menu.json
+++ b/packages/vue/src/i18n/locales/ru/menu.json
@@ -64,6 +64,7 @@
"snapToPixelGrid": "Привязка к пиксельной сетке",
"renameSelection": "Переименовать выделение…",
"rulers": "Линейки",
+ "pixelGrid": "Пиксельная сетка",
"settings": "Настройки…",
"variables": "Переменные…",
"insertIcon": "Вставить иконку…",
diff --git a/packages/vue/src/i18n/locales/zh-cn/commands.json b/packages/vue/src/i18n/locales/zh-cn/commands.json
index ff87e2584..01310f5b3 100644
--- a/packages/vue/src/i18n/locales/zh-cn/commands.json
+++ b/packages/vue/src/i18n/locales/zh-cn/commands.json
@@ -18,7 +18,9 @@
"sendToBack": "置于底层",
"moveToPage": "移动到页面",
"setOpacity": "设置不透明度",
+ "zoomTo50": "缩放到 50%",
"zoomTo100": "缩放到 100%",
+ "zoomTo200": "缩放到 200%",
"zoomToFit": "适应屏幕",
"zoomToSelection": "适应所选内容",
"groupSelection": "编组所选内容",
diff --git a/packages/vue/src/i18n/locales/zh-cn/menu.json b/packages/vue/src/i18n/locales/zh-cn/menu.json
index 8cce8d5f3..34fe6b599 100644
--- a/packages/vue/src/i18n/locales/zh-cn/menu.json
+++ b/packages/vue/src/i18n/locales/zh-cn/menu.json
@@ -64,6 +64,7 @@
"snapToPixelGrid": "吸附到像素网格",
"renameSelection": "重命名所选内容…",
"rulers": "标尺",
+ "pixelGrid": "像素网格",
"settings": "设置…",
"variables": "变量…",
"insertIcon": "插入图标…",
diff --git a/packages/vue/src/i18n/messages/commands.ts b/packages/vue/src/i18n/messages/commands.ts
index 90732a102..01a562a23 100644
--- a/packages/vue/src/i18n/messages/commands.ts
+++ b/packages/vue/src/i18n/messages/commands.ts
@@ -41,7 +41,9 @@ export const commandMessageDefaults = {
distributeVertical: 'Distribute vertical spacing',
moveToPage: 'Move to page',
setOpacity: 'Set opacity',
+ zoomTo50: 'Zoom to 50%',
zoomTo100: 'Zoom to 100%',
+ zoomTo200: 'Zoom to 200%',
zoomToFit: 'Zoom to fit',
zoomToSelection: 'Zoom to selection',
paletteSearchPlaceholder: 'Type a command or search…',
diff --git a/packages/vue/src/i18n/messages/menu.ts b/packages/vue/src/i18n/messages/menu.ts
index 0e9cd48fb..4808ea35e 100644
--- a/packages/vue/src/i18n/messages/menu.ts
+++ b/packages/vue/src/i18n/messages/menu.ts
@@ -35,6 +35,7 @@ export const menuMessageDefaults = {
variables: 'Variables…',
insertIcon: 'Insert Icon…',
rulers: 'Rulers',
+ pixelGrid: 'Pixel grid',
multiplayerCursors: 'Multiplayer cursors',
designIssues: 'Design issues',
preferences: 'Preferences',
diff --git a/packages/vue/src/shared/input/draw.ts b/packages/vue/src/shared/input/draw.ts
index 28c66bc20..23d8ad114 100644
--- a/packages/vue/src/shared/input/draw.ts
+++ b/packages/vue/src/shared/input/draw.ts
@@ -30,11 +30,14 @@ function startDraw(
editor.undo.beginBatch(label)
const parentId = findDrawParent(cx, cy, type, editor)
const toLocal = parentSpace(editor, parentId)
- const start = toLocal(cx, cy)
+ // Figma rounds both corners of a drawn layer to whole pixels.
+ const snap = editor.state.snappingPreferences.pixelGrid ? Math.round : (value: number) => value
+ const local = toLocal(cx, cy)
+ const start = { x: snap(local.x), y: snap(local.y) }
const nodeId = editor.createShape(type, start.x, start.y, 0, 0, parentId)
if (type === 'TEXT') editor.graph.updateNode(nodeId, { text: '' })
editor.select([nodeId])
- setDrag(createDraw(editor, nodeId, start.x, start.y, toLocal, type === 'LINE'))
+ setDrag(createDraw(editor, nodeId, start.x, start.y, toLocal, type === 'LINE', snap))
}
export function startTextDraw(
@@ -70,8 +73,8 @@ function lineGeometry(d: DragDraw, dx: number, dy: number, shiftKey: boolean): P
export function handleDrawMove(d: DragDraw, cx: number, cy: number, shiftKey: boolean) {
const point = d.toLocal(cx, cy)
- let w = point.x - d.startX
- let h = point.y - d.startY
+ let w = d.snap(point.x) - d.startX
+ let h = d.snap(point.y) - d.startY
if (d.line) {
d.update(lineGeometry(d, w, h, shiftKey))
return
@@ -115,7 +118,8 @@ function createDraw(
startX: number,
startY: number,
toLocal: DragDraw['toLocal'],
- line: boolean
+ line: boolean,
+ snap: DragDraw['snap']
): DragDraw {
const graph = editor.graph
const preview = editor.beginNodePreview('Draw dimensions')
@@ -171,6 +175,7 @@ function createDraw(
startY,
toLocal,
line,
+ snap,
nodeId,
update: (changes) => {
if (!finished) preview.update(nodeId, changes)
diff --git a/packages/vue/src/shared/input/snap.ts b/packages/vue/src/shared/input/snap.ts
index 33c1e7d82..448e7d14b 100644
--- a/packages/vue/src/shared/input/snap.ts
+++ b/packages/vue/src/shared/input/snap.ts
@@ -12,16 +12,13 @@ export interface PixelSnapResult {
guides: SnapGuide[]
}
-export function computePixelGridSnap(bounds: Rect, threshold: number): PixelSnapResult {
- const roundedX = Math.round(bounds.x)
- const roundedY = Math.round(bounds.y)
- const dx = roundedX - bounds.x
- const dy = roundedY - bounds.y
+/**
+ * Lands the bounds on whole pixels, as Figma's Snap to pixel grid does at any zoom: a move ends on
+ * a whole position and a resized edge on a whole size, even from a fractional start.
+ */
+export function computePixelGridSnap(bounds: Rect): PixelSnapResult {
return {
- delta: {
- x: Math.abs(dx) < threshold ? dx : 0,
- y: Math.abs(dy) < threshold ? dy : 0
- },
+ delta: { x: Math.round(bounds.x) - bounds.x, y: Math.round(bounds.y) - bounds.y },
// Pixel rounding is not alignment with another object or an explicit guide.
guides: []
}
@@ -133,7 +130,7 @@ export function resolveObjectPixelSnap(
? computeSnap(movingIds, movingBounds, targets, threshold)
: { dx: 0, dy: 0, guides: [] }
const pixelSnap = editor.state.snappingPreferences.pixelGrid
- ? computePixelGridSnap(movingBounds, threshold)
+ ? computePixelGridSnap(movingBounds)
: { delta: { x: 0, y: 0 }, guides: [] }
const objectX = objectSnap.guides.some((guide) => guide.axis === 'x')
const objectY = objectSnap.guides.some((guide) => guide.axis === 'y')
diff --git a/packages/vue/src/shared/input/types.ts b/packages/vue/src/shared/input/types.ts
index 9a0146aca..7a7ce0e75 100644
--- a/packages/vue/src/shared/input/types.ts
+++ b/packages/vue/src/shared/input/types.ts
@@ -24,6 +24,8 @@ export interface DragDraw {
toLocal: (x: number, y: number) => Vector
/** A line is drawn by its length and angle, as in Figma, not as a box. */
line?: boolean
+ /** Lands a coordinate on the pixel grid while Snap to pixel grid is on. */
+ snap: (value: number) => number
nodeId: string
update: (changes: Partial<SceneNode>) => void
commit: () => void
diff --git a/src/app/shell/keyboard/registry.ts b/src/app/shell/keyboard/registry.ts
index 12b2f600e..c7c884212 100644
--- a/src/app/shell/keyboard/registry.ts
+++ b/src/app/shell/keyboard/registry.ts
@@ -8,6 +8,7 @@ import type { EditorCommandId } from '@open-pencil/vue'
import { requestRenameSelection } from '@/app/editor/selection/rename-dialog'
import { TOOL_SHORTCUTS } from '@/app/editor/session'
import { openSettingsDialog } from '@/app/settings/dialog'
+import { setSnappingPreference } from '@/app/settings/preferences/apply'
import { isButtonActivation, isEditing } from '@/app/shell/keyboard/focus'
import { bindSpaceHandTool } from '@/app/shell/keyboard/space-tool'
import type {
@@ -143,6 +144,37 @@ export function registerKeyboardShortcuts(options: KeyboardShortcutOptions) {
run: ({ actions }) => actions.togglePlay(),
preview: true
},
+ {
+ id: 'toggle-rulers',
+ keys: 'Shift+KeyR',
+ run: ({ store }) => {
+ store.state.showRulers = !store.state.showRulers
+ store.requestRepaint()
+ }
+ },
+ {
+ id: 'toggle-multiplayer-cursors',
+ keys: '$mod+Alt+Backslash',
+ run: ({ store }) => {
+ store.state.showRemoteCursors = !store.state.showRemoteCursors
+ store.requestRepaint()
+ }
+ },
+ // Figma's keys, matched by key position since Shift turns ' into ".
+ {
+ id: 'toggle-pixel-grid',
+ keys: 'Shift+Quote',
+ run: ({ store }) => {
+ store.state.showPixelGrid = store.state.showPixelGrid === false
+ store.requestRepaint()
+ }
+ },
+ {
+ id: 'toggle-pixel-grid-snap',
+ keys: '$mod+Shift+Quote',
+ run: ({ store }) =>
+ setSnappingPreference('pixelGrid', !store.state.snappingPreferences.pixelGrid)
+ },
{
id: 'toggle-ui',
keys: appMenuTinykeysShortcut('toggle-ui') ?? '$mod+Backslash',
diff --git a/src/app/shell/menu/app-menu.ts b/src/app/shell/menu/app-menu.ts
index 1a71a8306..c46390c75 100644
--- a/src/app/shell/menu/app-menu.ts
+++ b/src/app/shell/menu/app-menu.ts
@@ -117,6 +117,7 @@ export function useAppMenu() {
variables: 'variables',
'insert-icon': 'insertIcon',
'view-rulers': 'rulers',
+ 'view-pixel-grid': 'pixelGrid',
'view-multiplayer-cursors': 'multiplayerCursors',
'view-design-issues': 'designIssues',
'snap-geometry': 'snapToGeometry',
@@ -196,6 +197,8 @@ export function useAppMenu() {
return store.renderer?.profiler.hudVisible ?? false
case 'view-rulers':
return store.state.showRulers
+ case 'view-pixel-grid':
+ return store.state.showPixelGrid !== false
case 'view-multiplayer-cursors':
return store.state.showRemoteCursors
case 'view-design-issues':
@@ -229,6 +232,10 @@ export function useAppMenu() {
return (value: boolean) => {
if (store.state.showRulers !== value) itemAction(item)?.()
}
+ case 'view-pixel-grid':
+ return (value: boolean) => {
+ if ((store.state.showPixelGrid !== false) !== value) itemAction(item)?.()
+ }
case 'view-multiplayer-cursors':
return (value: boolean) => {
if (store.state.showRemoteCursors !== value) itemAction(item)?.()
diff --git a/src/app/shell/menu/editor-actions.ts b/src/app/shell/menu/editor-actions.ts
index a8ac4b978..c9750f0d0 100644
--- a/src/app/shell/menu/editor-actions.ts
+++ b/src/app/shell/menu/editor-actions.ts
@@ -60,6 +60,10 @@ export function createSharedEditorMenuActions(
store.state.showRulers = !store.state.showRulers
store.requestRepaint()
},
+ 'view-pixel-grid': () => {
+ store.state.showPixelGrid = store.state.showPixelGrid === false
+ store.requestRepaint()
+ },
'view-multiplayer-cursors': () => {
store.state.showRemoteCursors = !store.state.showRemoteCursors
store.requestRepaint()
diff --git a/src/app/shell/menu/schema.ts b/src/app/shell/menu/schema.ts
index e03e36f7e..38f367448 100644
--- a/src/app/shell/menu/schema.ts
+++ b/src/app/shell/menu/schema.ts
@@ -185,8 +185,15 @@ export const APP_MENU_SCHEMA = [
}
},
{ type: 'separator' },
- { id: 'view-rulers', label: 'Rulers', checkbox: true },
- { id: 'view-multiplayer-cursors', label: 'Multiplayer Cursors', checkbox: true },
+ { id: 'view-rulers', label: 'Rulers', checkbox: true, shortcut: 'SHIFT+R' },
+ // Figma's View › Pixel grid, shown once zoomed in far enough.
+ { id: 'view-pixel-grid', label: 'Pixel Grid', checkbox: true, shortcut: "SHIFT+'" },
+ {
+ id: 'view-multiplayer-cursors',
+ label: 'Multiplayer Cursors',
+ checkbox: true,
+ shortcut: 'ALT+MOD+\\'
+ },
{ id: 'view-design-issues', label: 'Design Issues', checkbox: true, handler: 'shell' },
{ type: 'separator' },
{
@@ -220,6 +227,7 @@ export const APP_MENU_SCHEMA = [
id: 'snap-pixel-grid',
label: 'Snap to Pixel Grid',
checkbox: true,
+ shortcut: "MOD+SHIFT+'",
handler: 'shell'
},
{ type: 'separator' },
diff --git a/src/components/editor/ZoomDropdown.vue b/src/components/editor/ZoomDropdown.vue
index 2a199e239..0cffcb6d9 100644
--- a/src/components/editor/ZoomDropdown.vue
+++ b/src/components/editor/ZoomDropdown.vue
@@ -9,12 +9,12 @@ import {
} from 'reka-ui'
import { nextTick, ref, watch } from 'vue'
-import { useEditorCommands, useI18n, formatShortcut } from '@open-pencil/vue'
+import { useEditorCommands, useI18n } from '@open-pencil/vue'
import { useEditorStore } from '@/app/editor/active-store'
-import { setDesignIssuesOnCanvas } from '@/app/settings/preferences/apply'
+import { setDesignIssuesOnCanvas, setSnappingPreference } from '@/app/settings/preferences/apply'
import { appPreferences } from '@/app/settings/preferences/store'
-import { appMenuShortcut, appMenuShortcutLabel } from '@/app/shell/menu/shortcut'
+import { appMenuShortcutLabel } from '@/app/shell/menu/shortcut'
import AppShortcutText from '@/components/ui/menu/AppShortcutText.vue'
import { menuItem, useMenuUI } from '@/components/ui/menu/menu'
@@ -57,6 +57,11 @@ function toggleRulers() {
store.requestRepaint()
}
+function togglePixelGrid() {
+ store.state.showPixelGrid = store.state.showPixelGrid === false
+ store.requestRepaint()
+}
+
function toggleRemoteCursors() {
store.state.showRemoteCursors = !store.state.showRemoteCursors
store.requestRepaint()
@@ -72,10 +77,14 @@ function zoomOut() {
store.applyZoom(100, center.x, center.y)
}
-const ZOOM_PRESETS: ReadonlyArray<{ label: string; level: number; shortcut?: string }> = [
- { label: '50%', level: 0.5 },
- { label: '100%', level: 1, shortcut: appMenuShortcut('view.zoom100') },
- { label: '200%', level: 2 }
+const ZOOM_PRESETS = [
+ { level: 0.5, label: () => commands.value.zoomTo50 },
+ {
+ level: 1,
+ label: () => commands.value.zoomTo100,
+ shortcut: appMenuShortcutLabel('view.zoom100')
+ },
+ { level: 2, label: () => commands.value.zoomTo200 }
]
function isActivePreset(level: number) {
@@ -148,17 +157,37 @@ watch(open, (v) => {
@select="store.zoomToLevel(preset.level)"
>
<icon-lucide-check v-if="isActivePreset(preset.level)" class="absolute left-2 size-3.5" />
- <span class="flex-1">{{ preset.label }}</span>
- <AppShortcutText v-if="preset.shortcut">{{
- formatShortcut(preset.shortcut)
- }}</AppShortcutText>
+ <span class="flex-1">{{ preset.label() }}</span>
+ <AppShortcutText v-if="preset.shortcut">{{ preset.shortcut }}</AppShortcutText>
</DropdownMenuItem>
<DropdownMenuSeparator :class="menuCls.separator" />
+ <DropdownMenuItem :class="itemCls" @select.prevent="togglePixelGrid">
+ <icon-lucide-check
+ v-if="store.state.showPixelGrid !== false"
+ class="absolute left-2 size-3.5"
+ />
+ <span class="flex-1">{{ menuText.pixelGrid }}</span>
+ <AppShortcutText>{{ appMenuShortcutLabel('view-pixel-grid') }}</AppShortcutText>
+ </DropdownMenuItem>
+ <DropdownMenuItem
+ :class="itemCls"
+ @select.prevent="
+ setSnappingPreference('pixelGrid', !store.state.snappingPreferences.pixelGrid)
+ "
+ >
+ <icon-lucide-check
+ v-if="store.state.snappingPreferences.pixelGrid"
+ class="absolute left-2 size-3.5"
+ />
+ <span class="flex-1">{{ menuText.snapToPixelGrid }}</span>
+ <AppShortcutText>{{ appMenuShortcutLabel('snap-pixel-grid') }}</AppShortcutText>
+ </DropdownMenuItem>
<DropdownMenuItem :class="itemCls" @select.prevent="toggleRulers">
<icon-lucide-check v-if="store.state.showRulers" class="absolute left-2 size-3.5" />
<span class="flex-1">{{ panels.rulers }}</span>
+ <AppShortcutText>{{ appMenuShortcutLabel('view-rulers') }}</AppShortcutText>
</DropdownMenuItem>
<DropdownMenuItem :class="itemCls" @select.prevent="toggleRemoteCursors">
<icon-lucide-check
@@ -166,6 +195,7 @@ watch(open, (v) => {
class="absolute left-2 size-3.5"
/>
<span class="flex-1">{{ panels.multiplayerCursors }}</span>
+ <AppShortcutText>{{ appMenuShortcutLabel('view-multiplayer-cursors') }}</AppShortcutText>
</DropdownMenuItem>
<DropdownMenuItem
:class="itemCls"
diff --git a/tests/e2e/canvas/pixel-grid.spec.ts b/tests/e2e/canvas/pixel-grid.spec.ts
new file mode 100644
index 000000000..a75c42fa4
--- /dev/null
+++ b/tests/e2e/canvas/pixel-grid.spec.ts
@@ -0,0 +1,49 @@
+import { expect, test, useEditorSetupWithClear } from '#tests/e2e/fixtures'
+import { pixelGridDriver } from '#tests/helpers/canvas/pixel-grid-driver'
+
+// Figma desktop 126: the pixel grid shows once a document pixel covers 8 device pixels (800% at
+// 1×, 400% at 2×), Shift+' toggles it, and
+// Shift+⌘' toggles snapping to it.
+
+const editor = useEditorSetupWithClear('/?test&no-chrome&no-rulers')
+
+const grid = pixelGridDriver(() => editor.page)
+
+async function zoomTo(zoom: number) {
+ await grid.showAtZoom(zoom)
+ await editor.canvas.waitForRender()
+}
+
+test('the pixel grid shows when zoomed in and Shift+quote toggles it', async () => {
+ await zoomTo(8)
+ const shown = await editor.canvas.screenshotCanvasRegion(480, 320)
+ expect(shown).toMatchSnapshot('pixel-grid-800.png', { maxDiffPixelRatio: 0, threshold: 0 })
+
+ await editor.page.keyboard.press('Shift+Quote')
+ await editor.canvas.waitForRender()
+ expect(await editor.canvas.screenshotCanvasRegion(480, 320)).not.toEqual(shown)
+
+ await editor.page.keyboard.press('Shift+Quote')
+ await editor.canvas.waitForRender()
+ expect(await editor.canvas.screenshotCanvasRegion(480, 320)).toEqual(shown)
+ editor.canvas.assertNoErrors()
+})
+
+test('just below 8 device pixels per document pixel the canvas has no grid', async () => {
+ const dpr = await grid.devicePixelRatio()
+ await zoomTo(8 / dpr - 0.1)
+ const before = await editor.canvas.screenshotCanvasRegion(480, 320)
+ await editor.page.keyboard.press('Shift+Quote')
+ await editor.canvas.waitForRender()
+ expect(await editor.canvas.screenshotCanvasRegion(480, 320)).toEqual(before)
+ await editor.page.keyboard.press('Shift+Quote')
+})
+
+test('Shift+Cmd+quote toggles snapping to the pixel grid', async () => {
+ await zoomTo(1)
+ expect(await grid.snapsToPixelGrid()).toBe(true)
+ await editor.page.keyboard.press('ControlOrMeta+Shift+Quote')
+ await expect.poll(() => grid.snapsToPixelGrid()).toBe(false)
+ await editor.page.keyboard.press('ControlOrMeta+Shift+Quote')
+ await expect.poll(() => grid.snapsToPixelGrid()).toBe(true)
+})
diff --git a/tests/e2e/canvas/pixel-grid.spec.ts-snapshots/pixel-grid-800-openpencil-darwin.png b/tests/e2e/canvas/pixel-grid.spec.ts-snapshots/pixel-grid-800-openpencil-darwin.png
new file mode 100644
index 000000000..9c5fbaeb6
Binary files /dev/null and b/tests/e2e/canvas/pixel-grid.spec.ts-snapshots/pixel-grid-800-openpencil-darwin.png differ
diff --git a/tests/e2e/perf/pixel-grid.spec.ts b/tests/e2e/perf/pixel-grid.spec.ts
new file mode 100644
index 000000000..207763d76
--- /dev/null
+++ b/tests/e2e/perf/pixel-grid.spec.ts
@@ -0,0 +1,47 @@
+import { expect, test } from '@playwright/test'
+
+import { CanvasHelper } from '#tests/helpers/canvas'
+
+// The grid is redrawn on every frame of a pan or zoom. Drawn line by line as a path it cost about
+// 8 ms of CPU per frame at 400% on a 1440 × 900 Retina viewport; as one shader draw it costs about
+// 0.1 ms. This keeps it that way.
+test.use({ deviceScaleFactor: 2, viewport: { width: 1440, height: 900 } })
+
+test('the pixel grid adds no CPU time to panning frames', async ({ page }) => {
+ test.setTimeout(60_000)
+ await page.goto('/?test&no-chrome&no-rulers')
+ await new CanvasHelper(page).waitForInit()
+ const cost = await page.evaluate(async () => {
+ const found = window.openPencil?.getStore?.()
+ if (!found?.renderer) throw new Error('OpenPencil renderer not initialized')
+ const store = found
+ const profiler = found.renderer.profiler
+ profiler.setVisible(true)
+ const frame = () =>
+ new Promise<void>((resolve) => {
+ requestAnimationFrame(() => resolve())
+ })
+ // The densest grid: a line every 8 device pixels.
+ store.state.zoom = 4
+ async function averageFrameCpu(showPixelGrid: boolean) {
+ store.state.showPixelGrid = showPixelGrid
+ const samples: number[] = []
+ for (let index = 0; index < 90; index++) {
+ store.state.panX += 3.3
+ store.state.panY += 1.7
+ store.requestRepaint()
+ await frame()
+ if (index >= 30) samples.push(profiler.stats.cpuTime)
+ }
+ return samples.reduce((sum, sample) => sum + sample, 0) / samples.length
+ }
+ const without = await averageFrameCpu(false)
+ const withGrid = await averageFrameCpu(true)
+ profiler.setVisible(false)
+ return { without, withGrid }
+ })
+ console.log(
+ `Pan frame CPU at 400%: ${cost.without.toFixed(2)} ms without the grid, ${cost.withGrid.toFixed(2)} ms with it`
+ )
+ expect(cost.withGrid - cost.without).toBeLessThan(1)
+})
diff --git a/tests/engine/vue/input/draw.test.ts b/tests/engine/vue/input/draw.test.ts
index 387f90b85..a6ee2ece1 100644
--- a/tests/engine/vue/input/draw.test.ts
+++ b/tests/engine/vue/input/draw.test.ts
@@ -20,6 +20,36 @@ function start(editor: Editor, tool: Tool = 'FRAME') {
}
describe('draw creation previews', () => {
+ // Figma desktop 126: dragging from (3.3, 50.4) to (30.7, 71.8) draws 28 × 22 at (3, 50).
+ test('rounds both corners to whole pixels while snapping to the pixel grid', () => {
+ for (const [pixelGrid, expected] of [
+ [true, { x: 3, y: 50, width: 28, height: 22 }],
+ [false, { x: 3.3, y: 50.4 }]
+ ] as const) {
+ const editor = createEditor()
+ try {
+ editor.state.snappingPreferences = { geometry: true, objects: true, pixelGrid }
+ editor.setTool('RECTANGLE')
+ const state: { drag: DragState | null } = { drag: null }
+ startShapeDraw(3.3, 50.4, editor, (drag) => {
+ state.drag = drag
+ })
+ const drag = state.drag
+ if (drag?.type !== 'draw') throw new Error('Expected drawing interaction')
+ handleDrawMove(drag, 30.7, 71.8, false)
+ drag.commit()
+ const node = editor.graph.getNode(drag.nodeId)
+ expect(node).toMatchObject(expected)
+ if (!pixelGrid) {
+ expect(node?.width).toBeCloseTo(27.4)
+ expect(node?.height).toBeCloseTo(21.4)
+ }
+ } finally {
+ editor.dispose()
+ }
+ }
+ })
+
test('graph replacement discards pending draw batches without replaying or deleting history', () => {
const editor = createEditor()
try {
diff --git a/tests/engine/vue/input/resize/snapping.test.ts b/tests/engine/vue/input/resize/snapping.test.ts
index 67acf1ea8..b1ade09b6 100644
--- a/tests/engine/vue/input/resize/snapping.test.ts
+++ b/tests/engine/vue/input/resize/snapping.test.ts
@@ -35,6 +35,18 @@ function setup(handle: DragResize['handle'] = 'se') {
}
describe('resize snapping preferences', () => {
+ // Figma desktop 126 lands a resized edge on a whole pixel at any zoom.
+ test('snaps edges to whole pixels however far zoomed in', () => {
+ const { editor, nodeId, drag } = setup()
+ editor.state.snappingPreferences = { geometry: true, objects: false, pixelGrid: true }
+ editor.state.zoom = 16
+
+ applyResize(drag, drag.startX + 0.4, drag.startY + 0.4, false, editor)
+ commitResizePreview(drag, editor)
+
+ expect(editor.graph.getNode(nodeId)).toMatchObject({ width: 100.75, height: 80.75 })
+ })
+
test('preserves fractional edges when pixel snapping is disabled', () => {
const { editor, nodeId, drag } = setup()
editor.state.snappingPreferences = { geometry: true, objects: false, pixelGrid: false }
diff --git a/tests/engine/vue/input/snap-guides.test.ts b/tests/engine/vue/input/snap-guides.test.ts
index 42c403d1c..baf67ffe9 100644
--- a/tests/engine/vue/input/snap-guides.test.ts
+++ b/tests/engine/vue/input/snap-guides.test.ts
@@ -6,8 +6,23 @@ import { computeSnap, createDefaultNode } from '@open-pencil/scene-graph'
import { computePixelGridSnap, resolveObjectPixelSnap } from '#vue/shared/input/snap'
describe('move snap guide presentation', () => {
+ // Figma desktop 126 ends a move on whole pixels at any zoom, even from a fractional start.
+ test('pixel rounding applies however far zoomed in', () => {
+ const editor = createEditor()
+ editor.state.snappingPreferences = { geometry: false, objects: true, pixelGrid: true }
+ editor.state.zoom = 16
+ const result = resolveObjectPixelSnap(
+ new Set(['frame']),
+ { x: 10.4, y: 20.6, width: 100, height: 80 },
+ [],
+ editor
+ )
+ expect(result.correction.x).toBeCloseTo(-0.4)
+ expect(result.correction.y).toBeCloseTo(0.4)
+ })
+
test('pixel rounding adjusts a lone frame without drawing self-alignment guides', () => {
- const pixel = computePixelGridSnap({ x: 10.25, y: 20.4, width: 100, height: 80 }, 5)
+ const pixel = computePixelGridSnap({ x: 10.25, y: 20.4, width: 100, height: 80 })
expect(pixel.delta).toEqual({ x: -0.25, y: -0.3999999999999986 })
expect(pixel.guides).toEqual([])
const editor = createEditor()
diff --git a/tests/helpers/canvas/pixel-grid-driver.ts b/tests/helpers/canvas/pixel-grid-driver.ts
new file mode 100644
index 000000000..b0c895b48
--- /dev/null
+++ b/tests/helpers/canvas/pixel-grid-driver.ts
@@ -0,0 +1,34 @@
+import type { Page } from '@playwright/test'
+
+import type * as PixelGridScene from '#tests/helpers/canvas/pixel-grid'
+
+/** Builds the pixel grid scene at a zoom and reads back the snapping preference. */
+export function pixelGridDriver(page: () => Page) {
+ return {
+ /** The probe rectangle 40 screen pixels in from the canvas corner at `zoom`. */
+ showAtZoom(zoom: number) {
+ return page().evaluate(async (zoom) => {
+ const store = window.openPencil?.getStore?.()
+ if (!store) throw new Error('OpenPencil store not initialized')
+ const fixtureURL = '/tests/helpers/canvas/pixel-grid.ts'
+ const scene: typeof PixelGridScene = await import(fixtureURL)
+ scene.createPixelGridScene(store.graph, store.state.currentPageId)
+ store.state.zoom = zoom
+ store.state.panX = 40
+ store.state.panY = 40
+ store.clearSelection()
+ store.requestRender()
+ }, zoom)
+ },
+
+ devicePixelRatio() {
+ return page().evaluate(() => devicePixelRatio)
+ },
+
+ snapsToPixelGrid() {
+ return page().evaluate(
+ () => window.openPencil?.getStore?.().state.snappingPreferences.pixelGrid
+ )
+ }
+ }
+}
diff --git a/tests/helpers/canvas/pixel-grid.ts b/tests/helpers/canvas/pixel-grid.ts
new file mode 100644
index 000000000..112702590
--- /dev/null
+++ b/tests/helpers/canvas/pixel-grid.ts
@@ -0,0 +1,14 @@
+import type { SceneGraph } from '@open-pencil/scene-graph'
+
+/** A blue rectangle at the page origin, for pixel grid specs, built in the browser. */
+export function createPixelGridScene(graph: SceneGraph, pageId: string) {
+ const probe = graph.createNode('RECTANGLE', pageId, {
+ name: 'Probe',
+ x: 0,
+ y: 0,
+ width: 40,
+ height: 30,
+ fills: [{ type: 'SOLID', color: { r: 0.3, g: 0.5, b: 1, a: 1 }, opacity: 1, visible: true }]
+ })
+ return { probe: probe.id }
+}