GridConfig | @sheetwrite/core

@sheetwrite/coreinterface

Toolbar / feature configuration. When config is set the built-in toolbar is shown; control flags default to true except the opt-in export flag.

Package: @sheetwrite/core
Source: packages/core/src/types/grid.ts#L209

Members 17

toolbar Show the built-in toolbar (true), hide it (false), or supply a custom item list.

toolbar?: boolean | ToolbarIteminterface ToolbarItem {
  action?: ToolbarActionName;
  onClick?: (grid: Grid) => void;
  icon?: ToolbarIcon;
  title?: string;
}interface ToolbarItem {
  action?: ToolbarActionName;
  onClick?: (grid: Grid) => void;
  icon?: ToolbarIcon;
  title?: string;
}interface ToolbarItem {
  action?: ToolbarActionName;
  onClick?: (grid: Grid) => void;
  icon?: ToolbarIcon;
  title?: string;
}Built-in, separator, or custom callback item in the grid toolbar.API reference →[];

bold Show the bold control in the default toolbar (default true).

bold?: boolean;

italic Show the italic control in the default toolbar (default true).

italic?: boolean;

align Show left, center, and right alignment controls (default true).

align?: boolean;

textColor Show the text-color control in the default toolbar (default true).

textColor?: boolean;

fillColor Show the fill-color control in the default toolbar (default true).

fillColor?: boolean;

border Show the border control in the default toolbar (default true).

border?: boolean;

clearFormat Show the clear-format control in the default toolbar (default true).

clearFormat?: boolean;

merge Show merge and unmerge controls in the default toolbar (default true).

merge?: boolean;

sort Show ascending and descending sort controls in the default toolbar (default true).

sort?: boolean;

export Show CSV/XLSX export controls in the default toolbar (default false).

export?: boolean;

icons Override built-in toolbar icons by action name.

icons?: Partial<Record<ToolbarActionNametype ToolbarActionName =
  | "bold"
  | "italic"
  | "underline"
  | "strikethrough"
  | "alignLeft"
  | "alignCenter"
  | "alignRight"
  | "textColor"
  | "fillColor"
  | "border"
  | "clearFormat"
  | "merge"
  | "unmerge"
  | "sortAsc"
  // … 6 more lines — see the API reference
}type ToolbarActionName =
  | "bold"
  | "italic"
  | "underline"
  | "strikethrough"
  | "alignLeft"
  | "alignCenter"
  | "alignRight"
  | "textColor"
  | "fillColor"
  | "border"
  | "clearFormat"
  | "merge"
  | "unmerge"
  | "sortAsc"
  // … 6 more lines — see the API reference
}type ToolbarActionName =
  | "bold"
  | "italic"
  | "underline"
  | "strikethrough"
  | "alignLeft"
  | "alignCenter"
  | "alignRight"
  | "textColor"
  | "fillColor"
  | "border"
  | "clearFormat"
  | "merge"
  | "unmerge"
  | "sortAsc"
  | "sortDesc"
  | "exportCsv"
  | "exportXlsx"
  | "undo"
  // … 2 more lines — see the API reference
}Built-in action names accepted by custom toolbar items.API reference →, ToolbarIcontype ToolbarIcon = string | Node | (() => Node);type ToolbarIcon = string | Node | (() => Node);type ToolbarIcon =
  string | Node | (() => Node);Text, DOM node, or node factory used as toolbar icon content.API reference →>>;

Override built-in toolbar icons by action name. Strings render as plain text; DOM nodes/factories support SVG/HTML icons.

contextMenu Built-in menu, disabled menu, static rows, or a request-aware row factory.

contextMenu?: boolean | ContextMenuItemstype ContextMenuItems =
  | readonly ContextMenuItem[]
  | ((context: ContextMenuContext) => readonly ContextMenuItem[]);type ContextMenuItems =
  | readonly ContextMenuItem[]
  | ((context: ContextMenuContext) => readonly ContextMenuItem[]);type ContextMenuItems =
  | readonly ContextMenuItem[]
  | ((
      context: ContextMenuContext,
    ) => readonly ContextMenuItem[]);Static rows or a context-aware factory evaluated each time the menu opens.API reference →;

undo Show undo/redo controls in the built-in toolbar (default true).

undo?: boolean;

find Built-in Ctrl+F find widget: enabled (true, default) or disabled (false).

find?: boolean;

tabs Bottom sheet-tab bar for multi-sheet workbooks (default true).

tabs?: boolean;

keyboard Built-in keyboard handling.

keyboard?: boolean | ((e: KeyboardEvent, grid: Gridinterface Grid {
  readonly store: Store;
  readonly actions: GridActions;
  setActiveSheet(id: SheetId): void;
  scrollToCell(addr: CellAddress): void;
  getCellAtPoint(
    clientX: number,
    clientY: number,
  ): CellAddress | null;
  getActiveSheet(): SheetId;
  getCellInput(row: number, col: number): CellInputSnapshot | null;
  getSelection(): Selection | null;
  setSelection(sel: Selection | null): void;
  setTheme(theme: Partial<Theme>): void;
  replaceTheme(theme: Partial<Theme> | undefined): void;
  // … 106 more lines — see the API reference
}interface Grid {
  readonly store: Store;
  readonly actions: GridActions;
  setActiveSheet(id: SheetId): void;
  scrollToCell(addr: CellAddress): void;
  getCellAtPoint(
    clientX: number,
    clientY: number,
  ): CellAddress | null;
  getActiveSheet(): SheetId;
  getCellInput(row: number, col: number): CellInputSnapshot | null;
  getSelection(): Selection | null;
  setSelection(sel: Selection | null): void;
  setTheme(theme: Partial<Theme>): void;
  replaceTheme(theme: Partial<Theme> | undefined): void;
  // … 106 more lines — see the API reference
}interface Grid {
  readonly store: Store;
  readonly actions: GridActions;
  setActiveSheet(
    id: SheetId,
  ): void;
  scrollToCell(
    addr: CellAddress,
  ): void;
  getCellAtPoint(
    clientX: number,
    clientY: number,
  ): CellAddress | null;
  getActiveSheet(): SheetId;
  getCellInput(
    row: number,
    col: number,
  ): CellInputSnapshot | null;
  getSelection(): Selection | null;
  // … 229 more lines — see the API reference
}Imperative grid handle for document commands, events, rendering, and teardown.API reference →) => boolean);

Built-in keyboard handling. `true` (default) keeps the stock Sheets-style bindings (navigation, type-to-edit, clipboard, undo/redo, find). `false` disables ALL of them — the host owns key events and drives `grid.actions`, selection, editing, and search primitives itself. A function is consulted first and consumes the event by returning `true`; returning `false` falls through to the stock bindings.

Declaration

View full TypeScript declaration

export interface GridConfig {
  toolbar?: boolean | ToolbarIteminterface ToolbarItem {
  action?: ToolbarActionName;
  onClick?: (grid: Grid) => void;
  icon?: ToolbarIcon;
  title?: string;
}interface ToolbarItem {
  action?: ToolbarActionName;
  onClick?: (grid: Grid) => void;
  icon?: ToolbarIcon;
  title?: string;
}interface ToolbarItem {
  action?: ToolbarActionName;
  onClick?: (grid: Grid) => void;
  icon?: ToolbarIcon;
  title?: string;
}Built-in, separator, or custom callback item in the grid toolbar.API reference →[];
  bold?: boolean;
  italic?: boolean;
  align?: boolean;
  textColor?: boolean;
  fillColor?: boolean;
  border?: boolean;
  clearFormat?: boolean;
  merge?: boolean;
  sort?: boolean;
  export?: boolean;
  icons?: Partial<Record<ToolbarActionNametype ToolbarActionName =
  | "bold"
  | "italic"
  | "underline"
  | "strikethrough"
  | "alignLeft"
  | "alignCenter"
  | "alignRight"
  | "textColor"
  | "fillColor"
  | "border"
  | "clearFormat"
  | "merge"
  | "unmerge"
  | "sortAsc"
  // … 6 more lines — see the API reference
}type ToolbarActionName =
  | "bold"
  | "italic"
  | "underline"
  | "strikethrough"
  | "alignLeft"
  | "alignCenter"
  | "alignRight"
  | "textColor"
  | "fillColor"
  | "border"
  | "clearFormat"
  | "merge"
  | "unmerge"
  | "sortAsc"
  // … 6 more lines — see the API reference
}type ToolbarActionName =
  | "bold"
  | "italic"
  | "underline"
  | "strikethrough"
  | "alignLeft"
  | "alignCenter"
  | "alignRight"
  | "textColor"
  | "fillColor"
  | "border"
  | "clearFormat"
  | "merge"
  | "unmerge"
  | "sortAsc"
  | "sortDesc"
  | "exportCsv"
  | "exportXlsx"
  | "undo"
  // … 2 more lines — see the API reference
}Built-in action names accepted by custom toolbar items.API reference →, ToolbarIcontype ToolbarIcon = string | Node | (() => Node);type ToolbarIcon = string | Node | (() => Node);type ToolbarIcon =
  string | Node | (() => Node);Text, DOM node, or node factory used as toolbar icon content.API reference →>>;
  contextMenu?: boolean | ContextMenuItemstype ContextMenuItems =
  | readonly ContextMenuItem[]
  | ((context: ContextMenuContext) => readonly ContextMenuItem[]);type ContextMenuItems =
  | readonly ContextMenuItem[]
  | ((context: ContextMenuContext) => readonly ContextMenuItem[]);type ContextMenuItems =
  | readonly ContextMenuItem[]
  | ((
      context: ContextMenuContext,
    ) => readonly ContextMenuItem[]);Static rows or a context-aware factory evaluated each time the menu opens.API reference →;
  undo?: boolean;
  find?: boolean;
  tabs?: boolean;
  keyboard?: boolean | ((e: KeyboardEvent, grid: Gridinterface Grid {
  readonly store: Store;
  readonly actions: GridActions;
  setActiveSheet(id: SheetId): void;
  scrollToCell(addr: CellAddress): void;
  getCellAtPoint(
    clientX: number,
    clientY: number,
  ): CellAddress | null;
  getActiveSheet(): SheetId;
  getCellInput(row: number, col: number): CellInputSnapshot | null;
  getSelection(): Selection | null;
  setSelection(sel: Selection | null): void;
  setTheme(theme: Partial<Theme>): void;
  replaceTheme(theme: Partial<Theme> | undefined): void;
  // … 106 more lines — see the API reference
}interface Grid {
  readonly store: Store;
  readonly actions: GridActions;
  setActiveSheet(id: SheetId): void;
  scrollToCell(addr: CellAddress): void;
  getCellAtPoint(
    clientX: number,
    clientY: number,
  ): CellAddress | null;
  getActiveSheet(): SheetId;
  getCellInput(row: number, col: number): CellInputSnapshot | null;
  getSelection(): Selection | null;
  setSelection(sel: Selection | null): void;
  setTheme(theme: Partial<Theme>): void;
  replaceTheme(theme: Partial<Theme> | undefined): void;
  // … 106 more lines — see the API reference
}interface Grid {
  readonly store: Store;
  readonly actions: GridActions;
  setActiveSheet(
    id: SheetId,
  ): void;
  scrollToCell(
    addr: CellAddress,
  ): void;
  getCellAtPoint(
    clientX: number,
    clientY: number,
  ): CellAddress | null;
  getActiveSheet(): SheetId;
  getCellInput(
    row: number,
    col: number,
  ): CellInputSnapshot | null;
  getSelection(): Selection | null;
  // … 229 more lines — see the API reference
}Imperative grid handle for document commands, events, rendering, and teardown.API reference →) => boolean);
}