Skip to content
Sheetwritev0.5.1

SheetwriteProps@sheetwrite/vue

On this page
@sheetwrite/vueinterface

Simple Vue adapter props for columns and default row objects.

Source
packages/vue/src/index.ts#L104

Members 5

columns Ordered schema used to derive the component-owned sheet. 
columns: readonly SimpleColumn<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, Id>>[0]["createRowId"];

Declaration

View full TypeScript declaration 
export interface SheetwriteProps<
  Row extends Record<string, CellScalar> = Record<string, CellScalar>,
  Id extends RowBridgeId = RowBridgeId,
> extends Omit<
  SheetwriteGridProps<Id>,
  "workbook" | "data" | "datasource" | "rowBridge"
> {
  columns: readonly SimpleColumn<Row>[];
  defaultRows: readonly Row[];
  sheetName?: string;
  getRowId?: (row: Row, index: number) => Id;
  createRowId?: Parameters<
    typeof createSimpleRowBridge<Row, Id>
  >[0]["createRowId"];
}

Referenced by

Workspace packages depending on @sheetwrite/vue

  • @sheetwrite/docs-startdependency

Public exports naming SheetwriteProps

Documentation