SheetwriteProps | @sheetwrite/vue

Simple Vue adapter props for columns and default row objects.

Package: @sheetwrite/vue
Source: packages/vue/src/index.ts#L104

Members 5

columns Ordered schema used to derive the component-owned sheet.

columns: readonly SimpleColumninterface 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>[];

defaultRows Rows converted to initial columnar data; missing keys become null.

defaultRows: readonly Row[];

sheetName Generated sheet name; defaults to Sheet 1.

sheetName?: string;

getRowId Opt-in stable identity for each host row.

getRowId?: (row: Row, index: number) => Id;

createRowId Creates stable identities for Grid-inserted rows.

createRowId?: Parameters<typeof createSimpleRowBridge<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 →<Row, Id>>[0]["createRowId"];

Declaration

View full TypeScript declaration

export interface SheetwriteProps<
  Row extends Record<string, CellScalartype 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 →> = Record<string, CellScalartype 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 →>,
  Id extends RowBridgeIdtype RowBridgeId = string | number;type RowBridgeId = string | number;type RowBridgeId =
  string | number;A stable host identity for one data-space row.API reference → = RowBridgeIdtype RowBridgeId = string | number;type RowBridgeId = string | number;type RowBridgeId =
  string | number;A stable host identity for one data-space row.API reference →,
> extends Omit<
  SheetwriteGridPropsinterface 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;
  workbook: Workbook;
  data?: ColumnarData;
  datasource?: DataSource;
  // … 58 more lines — see the API reference
}Advanced framework adapter props for workbook data or datasource ownership.API reference →<Id>,
  "workbook" | "data" | "datasource" | "rowBridge"
> {
  columns: readonly SimpleColumninterface 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>[];
  defaultRows: readonly Row[];
  sheetName?: string;
  getRowId?: (row: Row, index: number) => Id;
  createRowId?: Parameters<
    typeof createSimpleRowBridge<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 →<Row, Id>
  >[0]["createRowId"];
}