spatial-monorepo

---

spatial-monorepo / editor/src / UseKeyboardShortcutsOptions

Interface: UseKeyboardShortcutsOptions

Defined in: packages/editor/src/useKeyboardShortcuts.ts:60

Properties

onCopyAcrossFloors?

optional onCopyAcrossFloors?: () => void

Defined in: packages/editor/src/useKeyboardShortcuts.ts:76

When provided, Cmd/Ctrl+Shift+C triggers the copy-across-floors/buildings flow. No-op in read-only mode.

Returns

void

---

onFloorJump?

optional onFloorJump?: FloorJumpDispatch

Defined in: packages/editor/src/useKeyboardShortcuts.ts:66

When provided, digit keys 0–9 dispatch a floor-jump (skipped when target is input/textarea).

---

onFloorStep?

optional onFloorStep?: FloorStepDispatch

Defined in: packages/editor/src/useKeyboardShortcuts.ts:71

When provided, ArrowUp dispatches onFloorStep(+1) and ArrowDown dispatches onFloorStep(-1). Skipped when the target is an input or textarea.

---

selection?

optional selection?: Set`<string>`

Defined in: packages/editor/src/useKeyboardShortcuts.ts:62

Current selection — set of feature ids. Defaults to empty set.

---

shortcuts?

optional shortcuts?: Partial`<Record<string, ShortcutHandler>>`

Defined in: packages/editor/src/useKeyboardShortcuts.ts:64

Override map: custom handler replaces built-in behaviour for that key.