Sheetwrite | @sheetwrite/vue

Convenience component for local object rows with live option updates.
Package: @sheetwrite/vue
Source: packages/vue/src/index.ts#L417
Declaration

const Sheetwrite: SheetwriteComponentConstructortype SheetwriteComponentConstructor<
  Props,
  Emits,
  Expose = object,
> = new () => Expose &
  ComponentPublicInstance & {
    $props: AllowedComponentProps &
      Props &
      VNodeProps & {
        [
          EventName in keyof Emits &
            string as `on${Capitalize<EventName>}`
        ]?: (payload: Emits[EventName]) => void;
      };
  };type SheetwriteComponentConstructor<
  Props,
  Emits,
  Expose = object,
> = new () => Expose &
  ComponentPublicInstance & {
    $props: AllowedComponentProps &
      Props &
      VNodeProps & {
        [
          EventName in keyof Emits &
            string as `on${Capitalize<EventName>}`
        ]?: (payload: Emits[EventName]) => void;
      };
  };type SheetwriteComponentConstructor<
  Props,
  Emits,
  Expose = object,
> = new () => Expose &
  ComponentPublicInstance & {
    $props: AllowedComponentProps &
      Props &
      VNodeProps & {
        [
          EventName in keyof Emits &
            string as `on${Capitalize<EventName>}`
        ]?: (
          payload: Emits[EventName],
        ) => void;
      };
  };Vue constructor type for Sheetwrite components: Sheetwrite-owned props, emitted events exposed as on* listener props, and the exposed instance surface reachable through a template ref.API reference →<
  SheetwritePropstype SheetwriteProps<Row extends Record<string, CellScalar>> = Omit<
  SheetwriteGridProps,
  "workbook" | "data" | "datasource" | "height" | "fill"
> &
  GridSizeProps & {
    columns: readonly SimpleColumn<Row>[];
    defaultRows: readonly Row[];
    sheetName?: string;
  };type SheetwriteProps<Row extends Record<string, CellScalar>> = Omit<
  SheetwriteGridProps,
  "workbook" | "data" | "datasource" | "height" | "fill"
> &
  GridSizeProps & {
    columns: readonly SimpleColumn<Row>[];
    defaultRows: readonly Row[];
    sheetName?: string;
  };type SheetwriteProps<
  Row extends Record<
    string,
    CellScalar
  >,
> = Omit<
  SheetwriteGridProps,
  | "workbook"
  | "data"
  | "datasource"
  | "height"
  | "fill"
> &
  GridSizeProps & {
    columns: readonly SimpleColumn<Row>[];
    defaultRows: readonly Row[];
    sheetName?: string;
  };Simple framework adapter props for columns and default row objects.API reference →,
  SheetwriteGridEmitsinterface SheetwriteGridEmits {
  "grid-change": ChangeEvent;
  "selection-change": Selection | null;
  "viewport-change": GridEvents["scroll"];
  "edit-begin": GridEvents["edit-begin"];
  "edit-commit": GridEvents["edit-commit"];
  search: GridEvents["search"];
  "active-sheet-change": GridEvents["active-sheet"];
  ready: GridReadyEvent;
  "initialization-error": unknown;
}interface SheetwriteGridEmits {
  "grid-change": ChangeEvent;
  "selection-change": Selection | null;
  "viewport-change": GridEvents["scroll"];
  "edit-begin": GridEvents["edit-begin"];
  "edit-commit": GridEvents["edit-commit"];
  search: GridEvents["search"];
  "active-sheet-change": GridEvents["active-sheet"];
  ready: GridReadyEvent;
  "initialization-error": unknown;
}interface SheetwriteGridEmits {
  "grid-change": ChangeEvent;
  "selection-change": Selection | null;
  "viewport-change": GridEvents["scroll"];
  "edit-begin": GridEvents["edit-begin"];
  "edit-commit": GridEvents["edit-commit"];
  search: GridEvents["search"];
  "active-sheet-change": GridEvents["active-sheet"];
  ready: GridReadyEvent;
  "initialization-error": unknown;
}Event payloads emitted by the Vue components, keyed by template event name.API reference →,
  object
>