SheetwriteProps | @sheetwrite/vue

Simple Vue adapter props for columns and default row objects.

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

Members 3

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;
  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;
  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;
  cellStyle?: CellStyle;
  visible?: boolean;
}Column definition accepted by the adapters’ simple row-object API.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 →>>[];

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

defaultRows: readonly 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 →>[];

sheetName Generated sheet name; defaults to Sheet 1.

sheetName?: string;

Declaration

View full TypeScript declaration

export interface SheetwriteProps extends Omit<
  SheetwriteGridPropsinterface SheetwriteGridProps extends Omit<
  HTMLAttributes<HTMLDivElement>,
  keyof GridAdapterEventHandlers | "children"
> {
  className?: string;
  style?: CSSProperties;
  fallback?: ReactNode;
  height?: number | string;
  fill?: true;
  workbook: Workbook;
  data?: ColumnarData;
  datasource?: DataSource;
  datasourceStorage?: DataSourceStorageOptions;
  renderer?: "canvas" | "worker";
  workerUrl?: string | URL;
  // … 21 more lines — see the API reference
}interface SheetwriteGridProps extends Omit<
  HTMLAttributes<HTMLDivElement>,
  keyof GridAdapterEventHandlers | "children"
> {
  className?: string;
  style?: CSSProperties;
  fallback?: ReactNode;
  height?: number | string;
  fill?: true;
  workbook: Workbook;
  data?: ColumnarData;
  datasource?: DataSource;
  datasourceStorage?: DataSourceStorageOptions;
  renderer?: "canvas" | "worker";
  workerUrl?: string | URL;
  // … 21 more lines — see the API reference
}interface SheetwriteGridProps extends Omit<
  HTMLAttributes<HTMLDivElement>,
  | keyof GridAdapterEventHandlers
  | "children"
> {
  className?: string;
  style?: CSSProperties;
  fallback?: ReactNode;
  height?: number | string;
  fill?: true;
  workbook: Workbook;
  data?: ColumnarData;
  datasource?: DataSource;
  datasourceStorage?: DataSourceStorageOptions;
  renderer?: "canvas" | "worker";
  workerUrl?: string | URL;
  theme?: Partial<Theme>;
  readOnly?: boolean;
  protectionResolver?: ProtectionResolver;
  // … 43 more lines — see the API reference
}Advanced framework adapter props for workbook data or datasource ownership.API reference →,
  "workbook" | "data" | "datasource"
> {
  columns: readonly SimpleColumninterface SimpleColumn<Row extends Record<string, CellScalar>> {
  key: keyof Row & string;
  title: string;
  width?: number;
  type?: CellFormat;
  numberFormat?: string;
  headerStyle?: CellStyle;
  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;
  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;
  cellStyle?: CellStyle;
  visible?: boolean;
}Column definition accepted by the adapters’ simple row-object API.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 →>>[];
  defaultRows: readonly 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 →>[];
  sheetName?: string;
}