API reference

The complete public surface of grist-widget-sdk. Anything not listed here is internal and may change between minor versions.

Entry points

Import path	Use for
`grist-widget-sdk`	Primary surface — components, hooks, helpers, types.
`grist-widget-sdk/advanced`	Lower-level hooks (`useGristReady`, `useGristRowsFromTable`, …).
`grist-widget-sdk/emulator`	Emulator core for storybook/playgrounds.
`grist-widget-sdk/emulator/testing`	`renderWithGrist`, `presets`, test-only helpers.

Symbol	Purpose	Reference
`GristWidgetProvider`	App-root wiring: `grist.ready`, contexts, subscriptions.	/api/provider-boundary
`GristBoundary`	Booting / unavailable / error UI chrome.	/api/provider-boundary

Symbol	Purpose	Reference
`useGrist<TRow, TMapped>()`	Default surface — selection, writes, options, REST, theme.	/api/use-grist

Performance-oriented subscriptions to one part of the state.

Symbol	Reference
`useGristSelection<TRow, TMapped>()`	/api/slice-hooks
`useGristWrites()`	/api/slice-hooks
`useGristStatus()`	/api/slice-hooks
`useGristTheme()`	/api/slice-hooks

Symbol	Reference
`useGristSchema(options?)`	/api/use-grist-schema

Standalone utilities that don't require the React context.

A single page listing every exported type, with brief inline doc. See /api/types.

Opt-in FSM view of the widget ↔ Grist handshake (snapshot + capabilities

heartbeat). The default useGrist().status is a projection over this same machine.

Symbol	Reference
`GristHandshakeProvider`, `useGristHandshakeContext`, `useGristHandshakeContextOptional`	/api/handshake
`useGristHandshake`, `useGristCapabilities`	/api/handshake
`GristWidgetSnapshot`, `GristCapabilities`, `GristLifecycle`, `GristLink`, `GristSync`, `GristConfig`, `GristAuthz`	/api/handshake

Opt-in lower-level hooks for use cases the default surface doesn't cover.

Symbol	Reference
`createGristEmulator`, `mountGristEmulator`	/emulator/api
`renderWithGrist`, `presets`	/emulator/api
`parseDocument`, `parseRowFor`, `parseRowsFor`	/emulator/api