Simple framework adapter props for columns and default row objects.
Declaration
export type SheetwriteProps<
"workbook" | "data" | "datasource" | "height" | "fill" | "rowBridge"
defaultRows: readonly Row[];
getRowId?: (row: Row, index: number) => Id;
createRowId?: Parameters<
Referenced by
Workspace packages depending on @sheetwrite/react
@sheetwrite/docs-startdependency
Public exports naming SheetwriteProps
type CellScalar = string | number | boolean | null;type CellScalar = string | number | boolean | null;type CellScalar =
| string
| number
| boolean
| null;A scalar that can be displayed directly.API reference →type RowBridgeId = string | number;type RowBridgeId = string | number;type RowBridgeId =
string | number;A stable host identity for one data-space row.API reference →interface SheetwriteGridProps<
Id extends RowBridgeId = RowBridgeId,
> {
rowBridge?: RowBridge<Id>;
onRowDelta?: RowBridgeHandler<Id>;
onMutationRejected?: GridAdapterEventHandlers["onMutationRejected"];
onRendererFallback?: GridAdapterEventHandlers["onRendererFallback"];
onDatasourceError?: GridAdapterEventHandlers["onDatasourceError"];
onExportError?: GridAdapterEventHandlers["onExportError"];
onReady?: GridAdapterEventHandlers["onReady"];
className?: string;
style?: CSSProperties;
fallback?: ReactNode;
height?: number | string;
fill?: true;
// … 33 more lines — see the API reference
}interface SheetwriteGridProps<
Id extends RowBridgeId = RowBridgeId,
> {
rowBridge?: RowBridge<Id>;
onRowDelta?: RowBridgeHandler<Id>;
onMutationRejected?: GridAdapterEventHandlers["onMutationRejected"];
onRendererFallback?: GridAdapterEventHandlers["onRendererFallback"];
onDatasourceError?: GridAdapterEventHandlers["onDatasourceError"];
onExportError?: GridAdapterEventHandlers["onExportError"];
onReady?: GridAdapterEventHandlers["onReady"];
className?: string;
style?: CSSProperties;
fallback?: ReactNode;
height?: number | string;
fill?: true;
// … 33 more lines — see the API reference
}interface SheetwriteGridProps<
Id extends RowBridgeId =
RowBridgeId,
> {
rowBridge?: RowBridge<Id>;
onRowDelta?: RowBridgeHandler<Id>;
onMutationRejected?: GridAdapterEventHandlers["onMutationRejected"];
onRendererFallback?: GridAdapterEventHandlers["onRendererFallback"];
onDatasourceError?: GridAdapterEventHandlers["onDatasourceError"];
onExportError?: GridAdapterEventHandlers["onExportError"];
onReady?: GridAdapterEventHandlers["onReady"];
className?: string;
style?: CSSProperties;
fallback?: ReactNode;
height?: number | string;
fill?: true;
onGridChange?: (
event: ChangeEvent,
) => void;
// … 58 more lines — see the API reference
}Advanced framework adapter props for workbook data or datasource ownership.API reference →type GridSizeProps =
| { height: number | string; fill?: never }
| { fill: true; height?: never };type GridSizeProps =
| { height: number | string; fill?: never }
| { fill: true; height?: never };type GridSizeProps =
| {
height: number | string;
fill?: never;
}
| {
fill: true;
height?: never;
};Explicit width and height accepted by framework adapters.API reference →interface SimpleColumn<Row extends Record<string, CellScalar>> {
key: keyof Row & string;
title: string;
width?: number;
type?: CellFormat;
numberFormat?: string;
headerStyle?: CellStyle;
editor?: string;
cellStyle?: CellStyle;
visible?: boolean;
}interface SimpleColumn<Row extends Record<string, CellScalar>> {
key: keyof Row & string;
title: string;
width?: number;
type?: CellFormat;
numberFormat?: string;
headerStyle?: CellStyle;
editor?: string;
cellStyle?: CellStyle;
visible?: boolean;
}interface SimpleColumn<
Row extends Record<
string,
CellScalar
>,
> {
key: keyof Row & string;
title: string;
width?: number;
type?: CellFormat;
numberFormat?: string;
headerStyle?: CellStyle;
editor?: string;
cellStyle?: CellStyle;
visible?: boolean;
}Column definition accepted by the adapters’ simple row-object API.API reference →<Row extends Record<string, CellScalar>, Id extends RowBridgeId = RowBridgeId>(options: SimpleSheetwriteOptions<Row, Id>): RowBridgeInstance<Id> | undefined<Row extends Record<string, CellScalar>, Id extends RowBridgeId = RowBridgeId>(options: SimpleSheetwriteOptions<Row, Id>): RowBridgeInstance<Id> | undefined<Row extends Record<string, CellScalar>, Id extends RowBridgeId = RowBridgeId>(options: SimpleSheetwriteOptions<Row, Id>): RowBridgeInstance<Id> | undefinedCreates the optional row bridge for a simple data-first input.API reference →