Loading documentation…
Loading documentation…
supported
Supported public entry point. Import this entry point as @sheetwrite/core/adapter.
Source entry: packages/core/src/adapter.ts
RowBridgeProjects canonical document transactions into host-owned row changes.
SheetwriteErrorCanonical envelope for thrown and callback-delivered Sheetwrite failures.
applyChangedLiveGridOptionsApplies live-updatable adapter option changes to an existing Grid.
createAdapterGridControllerOwns initialization, replacement, publication, and retirement for framework adapters.
createGridControllerCreate a grid and wire its lifecycle once, so the React/Vue/Svelte adapters (and any plain host) share a single, drift-free implementation instead of each re-deriving the same create → subscribe → teardown behavior.
createRowBridgeCreate a typed bridge while preserving row and identity inference.
createSimpleGridInputConverts simple columns and row objects into canonical workbook and columnar input.
createSimpleRowBridgeCreates the optional row bridge for a simple data-first input.
extractGridOptionsExtracts advanced GridOptions from framework adapter props.
getGridResetReasonReturns the first reset-sensitive adapter input that changed, if any.
gridSizeStyleConverts adapter size props into a host element style object.
isSheetwriteErrorNarrow same-realm errors, cross-realm errors, and serialized failure envelopes.
rowBridgeTransactionIdCompute a deterministic identity for a canonical transaction.
AdapterGridControllerOwns adapter attachment and monotonically numbered Grid generations.
AdapterGridInputCommitted inputs to a framework adapter lifetime.
GridAdapterEventHandlersFramework-neutral readiness, change, and error callbacks shared by adapters.
GridControllerThe lifecycle handle returned by createGridController: the live grid, a theme passthrough, and a single teardown that detaches every subscription and destroys the grid.
GridControllerHandlersEvent callbacks a host (a framework adapter, or any plain app) hangs off a grid's lifecycle.
GridPublicationAdapterInbound hooks implemented by framework adapters for scheduling and imperative-handle publication.
GridReadyEventGrid handle, generation, and reason published after adapter initialization.
OptionalGridSizePropsOptional width and height accepted by advanced framework adapters.
RowBridgeCellA cell effect with semantic column and host row identity.
RowBridgeClearDeltaA clearRange effect expanded to its exact changed cells.
RowBridgeColumnSemantic column key accepted by the row bridge.
RowBridgeFillDeltaA fill-series transaction effect.
RowBridgeHostActionDeltaA document operation that needs a host-side action rather than row mutation.
RowBridgeInsertContextContext supplied when a canonical row insertion needs a host identity.
RowBridgeMetadataDeltaA document operation that changes workbook or column metadata.
RowBridgeOptionsOptions for the framework-neutral, opt-in row bridge.
RowBridgePasteDeltaA paste transaction effect.
RowBridgeProjectionResult of projection or reconciliation.
RowBridgeRangeDeltaA setRange/setBlock/restoreBlock effect expanded to its exact changed cells.
RowBridgeReconciliationInputInput to RowBridge.reconcile.
RowBridgeRowStructureDeltaStable row identity effects for insert, delete, and move operations.
RowBridgeTransactionThe canonical transaction identity carried by each projected delta.
RowBridgeUnprojectableDeltaAn explicit projection record for an operation with no row-space meaning.
SheetwriteErrorEnvelopeStructural form preserved across realms and JSON serialization.
SheetwriteInitializationPropsOptional explicit WASM source and initialization error callback for adapters.
SimpleColumnColumn definition accepted by the adapters’ simple row-object API.
SimpleGridInputNormalized workbook and columnar data produced from simple adapter props.
SimpleSheetwriteOptionsFramework-neutral simple columns, rows, sizing, and grid options.
GridReadyReasonReason an adapter published a ready Grid generation.
GridResetReasonReset-sensitive input change that requires an adapter to replace its Grid.
GridSizePropsExplicit width and height accepted by framework adapters.
RowBridgeDeltaEvery possible projection produced by a row bridge.
RowBridgeHandlerCallback accepted by imperative and framework adapters.
RowBridgeIdA stable host identity for one data-space row.
RowBridgeReconciliationStatusReconciliation status for a canonical transaction response.
SheetwriteErrorCodeExhaustive stable discriminator for consumer-visible Sheetwrite failures.
SheetwriteErrorContextStable, serialization-safe diagnostic context.
SheetwriteErrorOperationExhaustive stable operation discriminator for consumer-visible failures.
DEFAULT_SIMPLE_COLUMN_WIDTHDefault pixel width assigned to simple adapter columns.
GRID_OPTION_POLICYClassification of adapter options as live-updatable or reset-sensitive.
SHEETWRITE_ERROR_CODESStable public failure codes.
SHEETWRITE_ERROR_OPERATIONSStable operations at which a consumer-visible failure can surface.