Skip to content

useView

Controls grid visibility and snap-to-grid behavior in the editor.

Import

ts
import { useView } from '@asset-studio/core'

Usage

tsx
function ViewControls() {
  const { showCells, setShowCells, snapToGrid, setSnapToGrid, gridSize, setGridSize } = useView()

  return (
    <div>
      <label>
        <input
          type="checkbox"
          checked={showCells}
          onChange={e => setShowCells(e.target.checked)}
        />
        Show Grid
      </label>
      <label>
        <input
          type="checkbox"
          checked={snapToGrid}
          onChange={e => setSnapToGrid(e.target.checked)}
        />
        Snap to Grid
      </label>
      <input
        type="number"
        value={gridSize}
        onChange={e => setGridSize(Number(e.target.value))}
      />
    </div>
  )
}

Return Value

Property / FunctionTypeDescription
showCellsbooleanWhether the grid overlay is visible.
setShowCells(value: boolean) => voidToggle grid visibility.
snapToGridbooleanWhether snap-to-grid is active.
setSnapToGrid(value: boolean) => voidToggle snap-to-grid.
gridSizenumberCurrent grid cell size in pixels.
setGridSize(value: number) => voidSet the grid cell size.

Released under a proprietary license.