Types

Every type exported from grist-widget-sdk. Grouped by area. Each table below is generated from the real exported type in packages/core/src/sdk — see useGrist for the full UseGristResult field enumeration.

Core results

GristRowRecord<T = Record<string, unknown>> defaults its generic to a plain record — T itself only shows once you pass a concrete row type.

Provider / hook options

type UseGristOptions = GristReadyOptions

Result types

UseGristResult<TRow, TMapped> is the return type of useGrist() — see that page for the full, per-field table (status, selection, writes, reads, options, linking, REST, theme). The slice-hook result types (UseGristStatusResult, UseGristSelectionResult, UseGristWritesResult, UseGristThemeResult) are documented on Slice hooks.

Linking

Writes

Reads

Attachments / REST

type GristFetchWithAuthOptions = RequestInit & { readOnly?: boolean }

Replica document

See /design/replica-document for full discussion.

Safe parsing

Alerts

Component props

See <GristWidgetProvider> and <GristBoundary> for the full behavioral reference (fallback slots, gating, retry surface).