# BeautifulGrid TypeScript API Reference

> Machine-readable public interfaces, types, enums, and members generated from beautiful-grid/types.ts.

Source page: https://bgrid.axisj.com/en/api/props

The TypeScript source is the final authority when this document and an installed package version differ. Internal Zustand store and rendering-only types are intentionally excluded.

## Core component types

### BGridProps

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L974

```ts
export interface BGridProps<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `ref` | `React.Ref<BGridRef<T>>` | no | no | Contract for ref; use the exact type shown in this row. |
| `width` | `number` | yes | no | Contract for width; use the exact type shown in this row. |
| `height` | `number` | yes | no | Contract for height; use the exact type shown in this row. |
| `headerHeight` | `number` | no | no | Contract for headerHeight; use the exact type shown in this row. |
| `footerHeight` | `number` | no | yes | Contract for footerHeight; use the exact type shown in this row. |
| `bottomBarHeight` | `number` | no | no | Contract for bottomBarHeight; use the exact type shown in this row. |
| `summaryHeight` | `number` | no | no | Contract for summaryHeight; use the exact type shown in this row. |
| `summaryRowHeight` | `number` | no | no | Contract for summaryRowHeight; use the exact type shown in this row. |
| `itemHeight` | `number` | no | no | Contract for itemHeight; use the exact type shown in this row. |
| `itemPadding` | `number` | no | no | Contract for itemPadding; use the exact type shown in this row. |
| `getRowHeight` | `(row: T, index: number) => number` | no | no | Contract for getRowHeight; use the exact type shown in this row. |
| `frozenColumnIndex` | `number` | no | no | Contract for frozenColumnIndex; use the exact type shown in this row. |
| `frozenRowCount` | `number` | no | no | Contract for frozenRowCount; use the exact type shown in this row. |
| `columns` | `BGridColumnWithOptionalWidth<T>[]` | yes | no | Contract for columns; use the exact type shown in this row. |
| `columnsGroup` | `BGridColumnGroup[]` | no | yes | Contract for columnsGroup; use the exact type shown in this row. |
| `columnGroups` | `BGridColumnGroupNode[]` | no | no | Contract for columnGroups; use the exact type shown in this row. |
| `onChangeColumns` | `(columnIndex: number \| null, info: BGridChangeColumnsInfo<T>) => void` | no | no | Contract for onChangeColumns; use the exact type shown in this row. |
| `data` | `BGridDataItem<T>[]` | no | no | Contract for data; use the exact type shown in this row. |
| `onChangeData` | `(<br>    index: number,<br>    columnIndex: number \| null,<br>    item: T,<br>    column: BGridColumn<T> \| null,<br>    meta?: BGridChangeDataMeta<T>,<br>  ) => void` | no | no | Contract for onChangeData; use the exact type shown in this row. |
| `page` | `BGridPage` | no | no | Contract for page; use the exact type shown in this row. |
| `enableLoadMore` | `boolean` | no | no | Contract for enableLoadMore; use the exact type shown in this row. |
| `onLoadMore` | `(params: { scrollLeft: number; scrollTop: number }) => void` | no | no | Contract for onLoadMore; use the exact type shown in this row. |
| `endLoadMoreRender` | `() => React.ReactNode` | no | no | Contract for endLoadMoreRender; use the exact type shown in this row. |
| `scrollbar` | `BGridScrollbarOptions` | no | no | Contract for scrollbar; use the exact type shown in this row. |
| `status` | `BGridStatusOptions` | no | no | Contract for status; use the exact type shown in this row. |
| `pagination` | `BGridPaginationViewOptions` | no | no | Contract for pagination; use the exact type shown in this row. |
| `className` | `string` | no | no | Contract for className; use the exact type shown in this row. |
| `style` | `React.CSSProperties` | no | no | Contract for style; use the exact type shown in this row. |
| `loading` | `boolean` | no | no | Contract for loading; use the exact type shown in this row. |
| `spinning` | `boolean` | no | no | Contract for spinning; use the exact type shown in this row. |
| `disabled` | `boolean` | no | no | Contract for disabled; use the exact type shown in this row. |
| `scrollTop` | `number` | no | no | Contract for scrollTop; use the exact type shown in this row. |
| `scrollLeft` | `number` | no | no | Contract for scrollLeft; use the exact type shown in this row. |
| `rowChecked` | `BGridRowChecked<T>` | no | no | Contract for rowChecked; use the exact type shown in this row. |
| `sort` | `BGridSortInfo` | no | no | Contract for sort; use the exact type shown in this row. |
| `onClick` | `(params: BGridClickParams<T>) => void` | no | no | Contract for onClick; use the exact type shown in this row. |
| `msg` | `{<br>    emptyList?: string;<br>    toolbox?: {<br>      sort?: string;<br>      sortAscending?: string;<br>      sortDescending?: string;<br>      clearSort?: string;<br>      filterApplied?: string;<br>      openColumnOptions?: string;<br>      filter?: string;<br>      textFilter?: string;<br>      valueFilter?: string;<br>      numberFilter?: string;<br>      contains?: string;<br>      equals?: string;<br>      notEquals?: string;<br>      numberEquals?: string;<br>      numberNotEquals?: string;<br>      greaterThan?: string;<br>      greaterThanOrEqual?: string;<br>      lessThan?: string;<br>      lessThanOrEqual?: string;<br>      between?: string;<br>      searchPlaceholder?: string;<br>      textPlaceholder?: string;<br>      numberPlaceholder?: string;<br>      minimumPlaceholder?: string;<br>      maximumPlaceholder?: string;<br>      invalidRange?: string;<br>      clear?: string;<br>      apply?: string;<br>      emptyValue?: string;<br>      selectAll?: string;<br>      noValues?: string;<br>      noResults?: string;<br>      extraMenu?: string;<br>      columns?: string;<br>      hiddenColumns?: string;<br>      showAllColumns?: string;<br>      hideThisColumn?: string;<br>      lastVisibleColumn?: string;<br>      hiddenColumnCount?: (count: number) => string;<br>      moreValues?: (count: number) => string;<br>    };<br>  }` | no | no | Contract for msg; use the exact type shown in this row. |
| `rowKey` | `React.Key \| React.Key[]` | no | no | Contract for rowKey; use the exact type shown in this row. |
| `selectedRowKey` | `React.Key \| React.Key[]` | no | no | Contract for selectedRowKey; use the exact type shown in this row. |
| `editable` | `boolean` | no | no | Contract for editable; use the exact type shown in this row. |
| `editTrigger` | `BGridEditTrigger` | no | no | Contract for editTrigger; use the exact type shown in this row. |
| `showLineNumber` | `boolean` | no | no | Contract for showLineNumber; use the exact type shown in this row. |
| `getRowClassName` | `(ri: number, item: BGridDataItem<T>) => string \| undefined` | no | no | Contract for getRowClassName; use the exact type shown in this row. |
| `cellMergeOptions` | `{<br>    columnsMap: Record<number, BGridCellMergeColumn>;<br>  }` | no | no | Contract for cellMergeOptions; use the exact type shown in this row. |
| `cellSelectionOptions` | `{<br>    enabled?: boolean;<br>    /** Controls which cell remains active after a multi-cell selection. */<br>    multiSelectFocusMode?: 'first' \| 'last';<br>    clearOnEscape?: boolean;<br>    clearOnOutsideClick?: boolean;<br>    maxClipboardCells?: number;<br>    maxClipboardTextLength?: number;<br>    onCopyError?: (error: BGridCellSelectionCopyError) => void;<br>    onPasteError?: (error: BGridCellSelectionPasteError) => void;<br>    /** Creates missing trailing rows while pasting. Returned rows are always marked as `new`. */<br>    createRowOnPaste?: (context: BGridCellSelectionPasteRowContext<T>) => BGridDataItem<T> \| undefined;<br>  }` | no | no | Contract for cellSelectionOptions; use the exact type shown in this row. |
| `cellNavigationOptions` | `BGridCellNavigationOptions` | no | no | Contract for cellNavigationOptions; use the exact type shown in this row. |
| `variant` | `'default' \| 'vertical-bordered'` | no | no | Contract for variant; use the exact type shown in this row. |
| `summary` | `BGridSummaryOptions<T>` | no | no | Contract for summary; use the exact type shown in this row. |
| `columnSortable` | `boolean` | no | no | Contract for columnSortable; use the exact type shown in this row. |
| `reorder` | `BGridReorderInfo<T>` | no | no | Contract for reorder; use the exact type shown in this row. |
| `reorderingInfo` | `BGridReorderingInfo` | no | no | Contract for reorderingInfo; use the exact type shown in this row. |
| `pivot` | `BGridPivotOptions<T>` | no | no | Contract for pivot; use the exact type shown in this row. |
| `dataControl` | `BGridDataControl` | no | no | Contract for dataControl; use the exact type shown in this row. |
| `icons` | `BGridToolboxIcons` | no | no | Contract for icons; use the exact type shown in this row. |
| `columnVisibility` | `boolean \| BGridColumnVisibilityOptions<T>` | no | no | Contract for columnVisibility; use the exact type shown in this row. |
| `searchOptions` | `BGridSearchOptions<T>` | no | no | Contract for searchOptions; use the exact type shown in this row. |
| `contextMenuOptions` | `BGridContextMenuOptions<T>` | no | no | Contract for contextMenuOptions; use the exact type shown in this row. |
| `tree` | `BGridTreeOptions<T>` | no | no | Contract for tree; use the exact type shown in this row. |
| `masterDetail` | `BGridMasterDetailOptions<T>` | no | no | Contract for masterDetail; use the exact type shown in this row. |


### BGridColumn

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L202

```ts
export interface BGridColumn<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `id` | `string` | no | no | Contract for id; use the exact type shown in this row. |
| `key` | `string \| string[]` | yes | no | Contract for key; use the exact type shown in this row. |
| `label` | `ReactNode` | yes | no | Contract for label; use the exact type shown in this row. |
| `width` | `number` | yes | no | Contract for width; use the exact type shown in this row. |
| `align` | `AlignDirection` | no | no | Contract for align; use the exact type shown in this row. |
| `headerAlign` | `AlignDirection` | no | no | Contract for headerAlign; use the exact type shown in this row. |
| `sortDisable` | `boolean` | no | no | Contract for sortDisable; use the exact type shown in this row. |
| `className` | `string` | no | no | Contract for className; use the exact type shown in this row. |
| `getClassName` | `(item: BGridDataItem<T>) => string` | no | no | Contract for getClassName; use the exact type shown in this row. |
| `headerClassName` | `string` | no | no | Contract for headerClassName; use the exact type shown in this row. |
| `headerStyle` | `React.CSSProperties` | no | no | Contract for headerStyle; use the exact type shown in this row. |
| `itemRender` | `React.FC<BGridItemRenderProps<T>>` | no | no | Contract for itemRender; use the exact type shown in this row. |
| `editor` | `BGridCellEditorConfig<T>` | no | no | Contract for editor; use the exact type shown in this row. |
| `editTrigger` | `BGridEditTrigger` | no | no | Contract for editTrigger; use the exact type shown in this row. |
| `editorIcon` | `BGridEditorIconConfig<T>` | no | no | Contract for editorIcon; use the exact type shown in this row. |
| `onChangeValue` | `(params: BGridChangeValueParams<T>) => void \| Promise<void>` | no | no | Contract for onChangeValue; use the exact type shown in this row. |
| `getClipboardText` | `(params: BGridCellClipboardTextParams<T>) => any` | no | no | Contract for getClipboardText; use the exact type shown in this row. |
| `parseClipboardText` | `(text: string, params: BGridCellClipboardParseParams<T>) => unknown` | no | no | Contract for parseClipboardText; use the exact type shown in this row. |
| `searchable` | `boolean` | no | no | Contract for searchable; use the exact type shown in this row. |
| `getSearchText` | `(params: BGridSearchCellParams<T>) => unknown` | no | no | Contract for getSearchText; use the exact type shown in this row. |
| `editable` | `boolean` | no | no | Contract for editable; use the exact type shown in this row. |
| `hideable` | `boolean` | no | no | Contract for hideable; use the exact type shown in this row. |
| `toolbox` | `boolean \| BGridToolboxConfig<T>` | no | no | Contract for toolbox; use the exact type shown in this row. |
| `filter` | `false \| BGridColumnFilterConfig<T>` | no | no | Contract for filter; use the exact type shown in this row. |
| `sortComparator` | `(<br>    a: unknown,<br>    b: unknown,<br>    params: {<br>      column: BGridColumn<T>;<br>      aItem: BGridDataItem<T>;<br>      bItem: BGridDataItem<T>;<br>    },<br>  ) => number` | no | no | Contract for sortComparator; use the exact type shown in this row. |
| `exportable` | `boolean` | no | no | Contract for exportable; use the exact type shown in this row. |
| `exportHeader` | `string \| ((column: BGridColumn<T>) => string)` | no | no | Contract for exportHeader; use the exact type shown in this row. |
| `getExportValue` | `(params: BGridCellExportValueParams<T>) => unknown` | no | no | Contract for getExportValue; use the exact type shown in this row. |


### BGridDataItem

Public type used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L306

```ts
export type BGridDataItem<T> = {
  values: T;
  status?: BGridDataItemStatus;
  /** Column instances directly edited since the data owner last cleared the edit state. */
  editedColumnIds?: string[];
  /** Stable key tokens whose underlying values changed since the data owner last cleared the change state. */
  changedKeys?: string[];
  checked?: boolean;
  parentItemIndex?: number;
  meta?: Record<string, any>;
};
```


### AlignDirection

Public type used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L3

```ts
export type AlignDirection = 'left' | 'center' | 'right';
```


### BGridCellClipboardParseParams

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L174

```ts
export interface BGridCellClipboardParseParams<T> extends BGridCellClipboardTextParams<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `text` | `string` | yes | no | Contract for text; use the exact type shown in this row. |


### BGridCellClipboardTextParams

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L165

```ts
export interface BGridCellClipboardTextParams<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `column` | `BGridColumn<T>` | yes | no | Contract for column; use the exact type shown in this row. |
| `index` | `number` | yes | no | Contract for index; use the exact type shown in this row. |
| `columnIndex` | `number` | yes | no | Contract for columnIndex; use the exact type shown in this row. |
| `item` | `BGridDataItem<T>` | yes | no | Contract for item; use the exact type shown in this row. |
| `values` | `T` | yes | no | Contract for values; use the exact type shown in this row. |
| `value` | `any` | yes | no | Contract for value; use the exact type shown in this row. |


### BGridColumnWithOptionalWidth

Public type used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L788

```ts
export type BGridColumnWithOptionalWidth<T> = Partial<Pick<BGridColumn<T>, 'width'>> & Omit<BGridColumn<T>, 'width'>;
```


### BGridDataItemStatus

Public enum used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L300

```ts
export enum BGridDataItemStatus
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `new` | `number` | yes | no | Contract for new; use the exact type shown in this row. |
| `edit` | `number` | yes | no | Contract for edit; use the exact type shown in this row. |
| `remove` | `number` | yes | no | Contract for remove; use the exact type shown in this row. |


### BGridItemRenderProps

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L13

```ts
export interface BGridItemRenderProps<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `column` | `BGridColumn<T>` | yes | no | Contract for column; use the exact type shown in this row. |
| `index` | `number` | yes | no | Contract for index; use the exact type shown in this row. |
| `columnIndex` | `number` | yes | no | Contract for columnIndex; use the exact type shown in this row. |
| `item` | `BGridDataItem<T>` | yes | no | Contract for item; use the exact type shown in this row. |
| `values` | `T` | yes | no | Contract for values; use the exact type shown in this row. |
| `value` | `any` | yes | no | Contract for value; use the exact type shown in this row. |
| `editable` | `boolean` | no | no | Contract for editable; use the exact type shown in this row. |
| `handleSave` | `(value: any, columnDirection?: MoveDirection, rowDirection?: MoveDirection) => void` | no | no | Contract for handleSave; use the exact type shown in this row. |
| `handleCancel` | `() => void` | no | no | Contract for handleCancel; use the exact type shown in this row. |
| `handleMove` | `(columnDirection: MoveDirection, rowDirection: MoveDirection) => void` | no | no | Contract for handleMove; use the exact type shown in this row. |


### BGridRef

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L904

```ts
export interface BGridRef<T = any>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `scrollToRow` | `(rowIndex: number, options?: BGridScrollToRowOptions) => void` | yes | no | Contract for scrollToRow; use the exact type shown in this row. |
| `getExportData` | `(options?: BGridExportDataOptions) => BGridExportData<T>` | yes | no | Contract for getExportData; use the exact type shown in this row. |
| `exportCsv` | `(options?: BGridCsvExportOptions) => void` | yes | no | Contract for exportCsv; use the exact type shown in this row. |
| `exportExcel` | `(options?: BGridExcelExportOptions) => void` | yes | no | Contract for exportExcel; use the exact type shown in this row. |


### MoveDirection

Public type used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L4

```ts
export type MoveDirection = 'prev' | 'next' | 'current';
```


## Data and events

### BGridCellExportValueParams

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L192

```ts
export interface BGridCellExportValueParams<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `column` | `BGridColumn<T>` | yes | no | Contract for column; use the exact type shown in this row. |
| `columnId` | `string` | yes | no | Contract for columnId; use the exact type shown in this row. |
| `visibleIndex` | `number` | no | no | Contract for visibleIndex; use the exact type shown in this row. |
| `sourceIndex` | `number` | yes | no | Contract for sourceIndex; use the exact type shown in this row. |
| `item` | `BGridDataItem<T>` | yes | no | Contract for item; use the exact type shown in this row. |
| `values` | `T` | yes | no | Contract for values; use the exact type shown in this row. |
| `value` | `unknown` | yes | no | Contract for value; use the exact type shown in this row. |


### BGridChangeColumnsInfo

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L486

```ts
export interface BGridChangeColumnsInfo<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `width` | `number` | no | no | Contract for width; use the exact type shown in this row. |
| `columns` | `BGridColumn<T>[]` | yes | no | Contract for columns; use the exact type shown in this row. |
| `columnsGroup` | `BGridColumnGroup[]` | no | no | Contract for columnsGroup; use the exact type shown in this row. |
| `columnGroups` | `BGridColumnGroupNode[]` | no | no | Contract for columnGroups; use the exact type shown in this row. |


### BGridChangeDataMeta

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L1228

```ts
export interface BGridChangeDataMeta<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `source` | `BGridEditSource` | yes | no | Contract for source; use the exact type shown in this row. |
| `originColumn` | `BGridColumn<T>` | yes | no | Contract for originColumn; use the exact type shown in this row. |
| `changes` | `readonly BGridCellValueChange<T>[]` | yes | no | Contract for changes; use the exact type shown in this row. |
| `dataItem` | `BGridDataItem<T>` | yes | no | Contract for dataItem; use the exact type shown in this row. |
| `tree` | `BGridTreeChangeDataMeta` | no | no | Contract for tree; use the exact type shown in this row. |
| `transaction` | `{<br>    merged: boolean;<br>    canonicalCell: BGridCellAddress;<br>    visibleIndexes: readonly number[];<br>    sourceIndexes: readonly number[];<br>  }` | yes | no | Contract for transaction; use the exact type shown in this row. |


### BGridClickParams

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L479

```ts
export interface BGridClickParams<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `index` | `number` | yes | no | Contract for index; use the exact type shown in this row. |
| `columnIndex` | `number` | yes | no | Contract for columnIndex; use the exact type shown in this row. |
| `item` | `T` | yes | no | Contract for item; use the exact type shown in this row. |
| `column` | `BGridColumn<T>` | yes | no | Contract for column; use the exact type shown in this row. |


### BGridCsvExportOptions

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L886

```ts
export interface BGridCsvExportOptions extends BGridExportDataOptions
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `fileName` | `string` | no | no | Contract for fileName; use the exact type shown in this row. |
| `delimiter` | `string` | no | no | Contract for delimiter; use the exact type shown in this row. |
| `newline` | `'\n' \| '\r\n'` | no | no | Contract for newline; use the exact type shown in this row. |
| `includeHeader` | `boolean` | no | no | Contract for includeHeader; use the exact type shown in this row. |
| `bom` | `boolean` | no | no | Contract for bom; use the exact type shown in this row. |
| `preventFormulaInjection` | `boolean` | no | no | Contract for preventFormulaInjection; use the exact type shown in this row. |


### BGridCsvSerializeOptions

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L878

```ts
export interface BGridCsvSerializeOptions
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `delimiter` | `string` | no | no | Contract for delimiter; use the exact type shown in this row. |
| `newline` | `'\n' \| '\r\n'` | no | no | Contract for newline; use the exact type shown in this row. |
| `includeHeader` | `boolean` | no | no | Contract for includeHeader; use the exact type shown in this row. |
| `bom` | `boolean` | no | no | Contract for bom; use the exact type shown in this row. |
| `preventFormulaInjection` | `boolean` | no | no | Contract for preventFormulaInjection; use the exact type shown in this row. |


### BGridExcelExportOptions

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L900

```ts
export interface BGridExcelExportOptions extends BGridExportDataOptions, BGridExcelSerializeOptions
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `fileName` | `string` | no | no | Contract for fileName; use the exact type shown in this row. |


### BGridExcelSerializeOptions

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L895

```ts
export interface BGridExcelSerializeOptions
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `sheetName` | `string` | no | no | Contract for sheetName; use the exact type shown in this row. |
| `includeHeader` | `boolean` | no | no | Contract for includeHeader; use the exact type shown in this row. |


### BGridExportColumn

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L852

```ts
export interface BGridExportColumn<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `columnId` | `string` | yes | no | Contract for columnId; use the exact type shown in this row. |
| `header` | `string` | yes | no | Contract for header; use the exact type shown in this row. |
| `column` | `BGridColumn<T>` | yes | no | Contract for column; use the exact type shown in this row. |
| `columnIndex` | `number` | yes | no | Contract for columnIndex; use the exact type shown in this row. |


### BGridExportColumnScope

Public type used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L850

```ts
export type BGridExportColumnScope = 'visible' | 'all' | readonly string[];
```


### BGridExportData

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L868

```ts
export interface BGridExportData<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `columns` | `BGridExportColumn<T>[]` | yes | no | Contract for columns; use the exact type shown in this row. |
| `rows` | `BGridExportRow<T>[]` | yes | no | Contract for rows; use the exact type shown in this row. |


### BGridExportDataOptions

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L873

```ts
export interface BGridExportDataOptions
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `rows` | `BGridExportRowScope` | no | no | Contract for rows; use the exact type shown in this row. |
| `columns` | `BGridExportColumnScope` | no | no | Contract for columns; use the exact type shown in this row. |


### BGridExportRow

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L859

```ts
export interface BGridExportRow<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `visibleIndex` | `number` | no | no | Contract for visibleIndex; use the exact type shown in this row. |
| `sourceIndex` | `number` | yes | no | Contract for sourceIndex; use the exact type shown in this row. |
| `rowKey` | `React.Key` | no | no | Contract for rowKey; use the exact type shown in this row. |
| `item` | `BGridDataItem<T>` | yes | no | Contract for item; use the exact type shown in this row. |
| `values` | `T` | yes | no | Contract for values; use the exact type shown in this row. |
| `cells` | `unknown[]` | yes | no | Contract for cells; use the exact type shown in this row. |


### BGridExportRowScope

Public type used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L848

```ts
export type BGridExportRowScope = 'displayed' | 'checked' | 'source';
```


### BGridPage

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L324

```ts
export interface BGridPage
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `currentPage` | `number` | no | no | Contract for currentPage; use the exact type shown in this row. |
| `pageSize` | `number` | no | no | Contract for pageSize; use the exact type shown in this row. |
| `totalPages` | `number` | no | no | Contract for totalPages; use the exact type shown in this row. |
| `totalElements` | `number` | no | no | Contract for totalElements; use the exact type shown in this row. |
| `loading` | `boolean` | no | no | Contract for loading; use the exact type shown in this row. |
| `onChange` | `(currentPage: number, pageSize?: number) => void` | no | no | Contract for onChange; use the exact type shown in this row. |
| `displayPaginationLength` | `number` | no | no | Contract for displayPaginationLength; use the exact type shown in this row. |
| `statusRender` | `() => void` | no | no | Contract for statusRender; use the exact type shown in this row. |
| `paginationRender` | `() => void` | no | no | Contract for paginationRender; use the exact type shown in this row. |


### BGridProcessedRow

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L318

```ts
export interface BGridProcessedRow<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `item` | `BGridDataItem<T>` | yes | no | Contract for item; use the exact type shown in this row. |
| `sourceIndex` | `number` | yes | no | Contract for sourceIndex; use the exact type shown in this row. |
| `rowKey` | `React.Key` | no | no | Contract for rowKey; use the exact type shown in this row. |


### BGridRowChecked

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L336

```ts
export interface BGridRowChecked<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `isRadio` | `boolean` | no | no | Contract for isRadio; use the exact type shown in this row. |
| `checkedIndexes` | `number[]` | no | no | Contract for checkedIndexes; use the exact type shown in this row. |
| `checkedRowKeys` | `React.Key[]` | no | no | Contract for checkedRowKeys; use the exact type shown in this row. |
| `disabled` | `(index: number, item: BGridDataItem<T>) => boolean` | no | no | Contract for disabled; use the exact type shown in this row. |
| `onChange` | `(checkedIndexes: number[], checkedRowKeys: React.Key[], checkedAll?: CheckedAll) => void` | yes | no | Contract for onChange; use the exact type shown in this row. |


### CheckedAll

Public type used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L1226

```ts
export type CheckedAll = true | false | 'indeterminate';
```


## Sort, filter, and toolbox

### BGridColumnFilterConfig

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L402

```ts
export interface BGridColumnFilterConfig<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `type` | `'values' \| 'text' \| 'number'` | yes | no | Contract for type; use the exact type shown in this row. |
| `caseSensitive` | `boolean` | no | no | Contract for caseSensitive; use the exact type shown in this row. |
| `values` | `BGridFilterValue[]` | no | no | Contract for values; use the exact type shown in this row. |
| `getValue` | `(item: BGridDataItem<T>) => unknown` | no | no | Contract for getValue; use the exact type shown in this row. |
| `predicate` | `(params: { item: BGridDataItem<T>; value: unknown; filter: BGridFilterParam }) => boolean` | no | no | Contract for predicate; use the exact type shown in this row. |
| `formatValue` | `(value: unknown) => React.ReactNode` | no | no | Contract for formatValue; use the exact type shown in this row. |
| `maxValueListItems` | `number` | no | no | Contract for maxValueListItems; use the exact type shown in this row. |


### BGridColumnVisibilityChangeEvent

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L442

```ts
export interface BGridColumnVisibilityChangeEvent<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `type` | `'hide' \| 'show' \| 'showAll'` | yes | no | Contract for type; use the exact type shown in this row. |
| `columnId` | `string` | no | no | Contract for columnId; use the exact type shown in this row. |
| `column` | `BGridColumn<T>` | no | no | Contract for column; use the exact type shown in this row. |


### BGridColumnVisibilityOptions

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L449

```ts
export interface BGridColumnVisibilityOptions<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `enabled` | `boolean` | no | no | Contract for enabled; use the exact type shown in this row. |
| `hiddenColumnIds` | `readonly string[]` | no | no | Contract for hiddenColumnIds; use the exact type shown in this row. |
| `defaultHiddenColumnIds` | `readonly string[]` | no | no | Contract for defaultHiddenColumnIds; use the exact type shown in this row. |
| `onChange` | `(hiddenColumnIds: string[], event: BGridColumnVisibilityChangeEvent<T>) => void` | no | no | Contract for onChange; use the exact type shown in this row. |


### BGridContextMenuItem

Public type used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L633

```ts
export type BGridContextMenuItem<T> =
  | {
      type?: 'item';
      id: string;
      label: React.ReactNode;
      icon?: React.ReactNode;
      shortcut?: string;
      disabled?: boolean;
      onSelect: (target: BGridContextMenuTarget<T>) => void | Promise<void>;
    }
  | {
      type: 'separator';
      id: string;
    };
```


### BGridContextMenuOptions

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L648

```ts
export interface BGridContextMenuOptions<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `enabled` | `boolean` | no | no | Contract for enabled; use the exact type shown in this row. |
| `items` | `(target: BGridContextMenuTarget<T>) => readonly BGridContextMenuItem<T>[]` | no | no | Contract for items; use the exact type shown in this row. |
| `onOpenChange` | `(open: boolean, target?: BGridContextMenuTarget<T>) => void` | no | no | Contract for onOpenChange; use the exact type shown in this row. |


### BGridContextMenuTarget

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L620

```ts
export interface BGridContextMenuTarget<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `cell` | `BGridCellAddress` | yes | no | Contract for cell; use the exact type shown in this row. |
| `visibleIndex` | `number` | yes | no | Contract for visibleIndex; use the exact type shown in this row. |
| `sourceIndex` | `number` | yes | no | Contract for sourceIndex; use the exact type shown in this row. |
| `rowKey` | `React.Key` | no | no | Contract for rowKey; use the exact type shown in this row. |
| `columnIndex` | `number` | yes | no | Contract for columnIndex; use the exact type shown in this row. |
| `columnId` | `string` | yes | no | Contract for columnId; use the exact type shown in this row. |
| `column` | `BGridColumn<T>` | yes | no | Contract for column; use the exact type shown in this row. |
| `item` | `BGridDataItem<T>` | yes | no | Contract for item; use the exact type shown in this row. |
| `values` | `T` | yes | no | Contract for values; use the exact type shown in this row. |
| `value` | `unknown` | yes | no | Contract for value; use the exact type shown in this row. |


### BGridDataControl

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L395

```ts
export interface BGridDataControl
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `mode` | `'manual' \| 'client'` | no | no | Contract for mode; use the exact type shown in this row. |
| `multiSort` | `boolean` | no | no | Contract for multiSort; use the exact type shown in this row. |
| `query` | `BGridDataQuery` | yes | no | Contract for query; use the exact type shown in this row. |
| `onChange` | `(query: BGridDataQuery, event: BGridDataQueryChangeEvent) => void` | yes | no | Contract for onChange; use the exact type shown in this row. |


### BGridDataQuery

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L384

```ts
export interface BGridDataQuery
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `sortParams` | `BGridSortParam[]` | yes | no | Contract for sortParams; use the exact type shown in this row. |
| `filterParams` | `BGridFilterParam[]` | yes | no | Contract for filterParams; use the exact type shown in this row. |


### BGridDataQueryChangeEvent

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L389

```ts
export interface BGridDataQueryChangeEvent
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `type` | `'sort' \| 'filter'` | yes | no | Contract for type; use the exact type shown in this row. |
| `columnId` | `string` | yes | no | Contract for columnId; use the exact type shown in this row. |
| `action` | `'apply' \| 'clear'` | yes | no | Contract for action; use the exact type shown in this row. |


### BGridFilterOperator

Public type used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L357

```ts
export type BGridFilterOperator = 'contains' | 'equals' | 'notEquals' | 'gt' | 'gte' | 'lt' | 'lte' | 'between';
```


### BGridFilterParam

Public type used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L366

```ts
export type BGridFilterParam =
  | (BGridFilterParamBase & {
      type: 'values';
      values: BGridFilterValue[];
    })
  | (BGridFilterParamBase & {
      type: 'text';
      operator: 'contains' | 'equals' | 'notEquals';
      value: string;
    })
  | (BGridFilterParamBase & {
      type: 'number';
      operator: Exclude<BGridFilterOperator, 'contains'>;
      value?: number;
      min?: number;
      max?: number;
    });
```


### BGridFilterValue

Public type used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L359

```ts
export type BGridFilterValue = string | number | boolean | null;
```


### BGridSearchCellParams

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L179

```ts
export interface BGridSearchCellParams<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `cell` | `BGridCellAddress` | yes | no | Contract for cell; use the exact type shown in this row. |
| `visibleIndex` | `number` | yes | no | Contract for visibleIndex; use the exact type shown in this row. |
| `sourceIndex` | `number` | yes | no | Contract for sourceIndex; use the exact type shown in this row. |
| `rowKey` | `React.Key` | no | no | Contract for rowKey; use the exact type shown in this row. |
| `columnIndex` | `number` | yes | no | Contract for columnIndex; use the exact type shown in this row. |
| `columnId` | `string` | yes | no | Contract for columnId; use the exact type shown in this row. |
| `column` | `BGridColumn<T>` | yes | no | Contract for column; use the exact type shown in this row. |
| `item` | `BGridDataItem<T>` | yes | no | Contract for item; use the exact type shown in this row. |
| `values` | `T` | yes | no | Contract for values; use the exact type shown in this row. |
| `value` | `unknown` | yes | no | Contract for value; use the exact type shown in this row. |


### BGridSearchIcons

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L581

```ts
export interface BGridSearchIcons
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `search` | `React.ReactNode` | no | no | Contract for search; use the exact type shown in this row. |
| `previous` | `React.ReactNode` | no | no | Contract for previous; use the exact type shown in this row. |
| `next` | `React.ReactNode` | no | no | Contract for next; use the exact type shown in this row. |
| `close` | `React.ReactNode` | no | no | Contract for close; use the exact type shown in this row. |


### BGridSearchLabels

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L588

```ts
export interface BGridSearchLabels
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `inputAriaLabel` | `string` | no | no | Contract for inputAriaLabel; use the exact type shown in this row. |
| `placeholder` | `string` | no | no | Contract for placeholder; use the exact type shown in this row. |
| `previousAriaLabel` | `string` | no | no | Contract for previousAriaLabel; use the exact type shown in this row. |
| `nextAriaLabel` | `string` | no | no | Contract for nextAriaLabel; use the exact type shown in this row. |
| `closeAriaLabel` | `string` | no | no | Contract for closeAriaLabel; use the exact type shown in this row. |
| `searching` | `string` | no | no | Contract for searching; use the exact type shown in this row. |
| `noResults` | `string` | no | no | Contract for noResults; use the exact type shown in this row. |
| `contextMenuItem` | `React.ReactNode` | no | no | Contract for contextMenuItem; use the exact type shown in this row. |
| `formatResultCount` | `(params: {<br>    activeResult: number;<br>    totalResults: number;<br>    loadedRowCount: number;<br>    paged: boolean;<br>  }) => React.ReactNode` | no | no | Contract for formatResultCount; use the exact type shown in this row. |


### BGridSearchOpenReason

Public type used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L573

```ts
export type BGridSearchOpenReason =
  | 'shortcut'
  | 'contextMenu'
  | 'external'
  | 'escape'
  | 'closeButton'
  | 'surfaceConflict';
```


### BGridSearchOptions

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L605

```ts
export interface BGridSearchOptions<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `enabled` | `boolean` | no | no | Contract for enabled; use the exact type shown in this row. |
| `shortcut` | `boolean` | no | no | Contract for shortcut; use the exact type shown in this row. |
| `contextMenu` | `boolean` | no | no | Contract for contextMenu; use the exact type shown in this row. |
| `open` | `boolean` | no | no | Contract for open; use the exact type shown in this row. |
| `defaultOpen` | `boolean` | no | no | Contract for defaultOpen; use the exact type shown in this row. |
| `onOpenChange` | `(open: boolean, reason: BGridSearchOpenReason) => void` | no | no | Contract for onOpenChange; use the exact type shown in this row. |
| `query` | `string` | no | no | Contract for query; use the exact type shown in this row. |
| `defaultQuery` | `string` | no | no | Contract for defaultQuery; use the exact type shown in this row. |
| `onQueryChange` | `(query: string) => void` | no | no | Contract for onQueryChange; use the exact type shown in this row. |
| `getSearchText` | `(params: BGridSearchCellParams<T>) => unknown` | no | no | Contract for getSearchText; use the exact type shown in this row. |
| `icons` | `BGridSearchIcons` | no | no | Contract for icons; use the exact type shown in this row. |
| `labels` | `BGridSearchLabels` | no | no | Contract for labels; use the exact type shown in this row. |


### BGridSortInfo

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L351

```ts
export interface BGridSortInfo
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `multiSort` | `boolean` | no | no | Contract for multiSort; use the exact type shown in this row. |
| `sortParams` | `BGridSortParam[]` | yes | no | Contract for sortParams; use the exact type shown in this row. |
| `onChange` | `(sortParams: BGridSortParam[]) => void` | yes | no | Contract for onChange; use the exact type shown in this row. |


### BGridSortParam

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L344

```ts
export interface BGridSortParam
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `columnId` | `string` | no | no | Contract for columnId; use the exact type shown in this row. |
| `key` | `string` | no | no | Contract for key; use the exact type shown in this row. |
| `index` | `number` | no | no | Contract for index; use the exact type shown in this row. |
| `orderBy` | `'asc' \| 'desc'` | yes | no | Contract for orderBy; use the exact type shown in this row. |


### BGridToolboxConfig

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L471

```ts
export interface BGridToolboxConfig<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `sort` | `boolean` | no | no | Contract for sort; use the exact type shown in this row. |
| `filter` | `boolean` | no | no | Contract for filter; use the exact type shown in this row. |
| `icons` | `BGridToolboxIcons` | no | no | Contract for icons; use the exact type shown in this row. |
| `extraItems` | `BGridToolboxItem<T>[]` | no | no | Contract for extraItems; use the exact type shown in this row. |
| `render` | `React.FC<BGridToolboxRenderProps<T>>` | no | no | Contract for render; use the exact type shown in this row. |


### BGridToolboxIcons

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L426

```ts
export interface BGridToolboxIcons
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `sortAsc` | `React.ReactNode` | no | no | Contract for sortAsc; use the exact type shown in this row. |
| `sortDesc` | `React.ReactNode` | no | no | Contract for sortDesc; use the exact type shown in this row. |
| `filter` | `React.ReactNode` | no | no | Contract for filter; use the exact type shown in this row. |
| `filterBadge` | `React.ReactNode` | no | no | Contract for filterBadge; use the exact type shown in this row. |
| `dropdown` | `React.ReactNode` | no | no | Contract for dropdown; use the exact type shown in this row. |
| `sortClear` | `React.ReactNode` | no | no | Contract for sortClear; use the exact type shown in this row. |
| `hideColumn` | `React.ReactNode` | no | no | Contract for hideColumn; use the exact type shown in this row. |
| `showColumn` | `React.ReactNode` | no | no | Contract for showColumn; use the exact type shown in this row. |
| `columns` | `React.ReactNode` | no | no | Contract for columns; use the exact type shown in this row. |


### BGridToolboxItem

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L412

```ts
export interface BGridToolboxItem<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `id` | `string` | yes | no | Contract for id; use the exact type shown in this row. |
| `label` | `React.ReactNode` | yes | no | Contract for label; use the exact type shown in this row. |
| `disabled` | `boolean` | no | no | Contract for disabled; use the exact type shown in this row. |
| `onClick` | `(params: { column: BGridColumn<T>; columnId: string; columnIndex: number }) => void` | yes | no | Contract for onClick; use the exact type shown in this row. |


### BGridToolboxRenderProps

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L419

```ts
export interface BGridToolboxRenderProps<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `column` | `BGridColumn<T>` | yes | no | Contract for column; use the exact type shown in this row. |
| `columnId` | `string` | yes | no | Contract for columnId; use the exact type shown in this row. |
| `columnIndex` | `number` | yes | no | Contract for columnIndex; use the exact type shown in this row. |
| `close` | `() => void` | yes | no | Contract for close; use the exact type shown in this row. |


## Selection and editing

### BGridCellAddress

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L568

```ts
export interface BGridCellAddress
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `rowIndex` | `number` | yes | no | Contract for rowIndex; use the exact type shown in this row. |
| `columnIndex` | `number` | yes | no | Contract for columnIndex; use the exact type shown in this row. |


### BGridCellCommitController

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L55

```ts
export interface BGridCellCommitController<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `commit` | `(changes: readonly BGridCellValueChange<T>[], options?: BGridCommitOptions) => Promise<void>` | yes | no | Contract for commit; use the exact type shown in this row. |
| `cancel` | `() => void` | yes | no | Contract for cancel; use the exact type shown in this row. |


### BGridCellEditorConfig

Public type used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L160

```ts
export type BGridCellEditorConfig<T> =
  | BGridTextEditorConfig<T>
  | BGridCheckboxEditorConfig<T>
  | BGridPluginEditorConfig<T>;
```


### BGridCellEditSession

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L685

```ts
export interface BGridCellEditSession extends BGridCellInteractionSessionBase
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `kind` | `'editor'` | yes | no | Contract for kind; use the exact type shown in this row. |
| `mode` | `'preserve' \| 'replace'` | yes | no | Contract for mode; use the exact type shown in this row. |
| `activation` | `BGridCellEditActivation` | yes | no | Contract for activation; use the exact type shown in this row. |
| `originalValue` | `unknown` | yes | no | Contract for originalValue; use the exact type shown in this row. |


### BGridCellMoveDirection

Public type used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L707

```ts
export type BGridCellMoveDirection =
  | 'up'
  | 'down'
  | 'left'
  | 'right'
  | 'home'
  | 'end'
  | 'pageUp'
  | 'pageDown'
  | 'first'
  | 'last'
  | 'next'
  | 'prev';
```


### BGridCellNavigationOptions

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L728

```ts
export interface BGridCellNavigationOptions
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `enabled` | `boolean` | no | no | Contract for enabled; use the exact type shown in this row. |
| `activeCell` | `BGridCellAddress` | no | no | Contract for activeCell; use the exact type shown in this row. |
| `defaultActiveCell` | `BGridCellAddress` | no | no | Contract for defaultActiveCell; use the exact type shown in this row. |
| `onActiveCellChange` | `(cell?: BGridCellAddress) => void` | no | no | Contract for onActiveCellChange; use the exact type shown in this row. |
| `wrap` | `boolean` | no | no | Contract for wrap; use the exact type shown in this row. |
| `editOnEnter` | `boolean` | no | no | Contract for editOnEnter; use the exact type shown in this row. |
| `keyRepeat` | `{<br>    enabled?: boolean;<br>    interval?: number;<br>  }` | no | no | Contract for keyRepeat; use the exact type shown in this row. |


### BGridCellSelectionCopyError

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L750

```ts
export interface BGridCellSelectionCopyError
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `reason` | `BGridCellSelectionCopyErrorReason` | yes | no | Contract for reason; use the exact type shown in this row. |
| `actual` | `number` | no | no | Contract for actual; use the exact type shown in this row. |
| `limit` | `number` | no | no | Contract for limit; use the exact type shown in this row. |
| `selectedCellCount` | `number` | yes | no | Contract for selectedCellCount; use the exact type shown in this row. |
| `maxClipboardCells` | `number` | yes | no | Contract for maxClipboardCells; use the exact type shown in this row. |
| `maxClipboardTextLength` | `number` | yes | no | Contract for maxClipboardTextLength; use the exact type shown in this row. |
| `error` | `unknown` | no | no | Contract for error; use the exact type shown in this row. |


### BGridCellSelectionCopyErrorReason

Public type used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L748

```ts
export type BGridCellSelectionCopyErrorReason = 'maxClipboardCells' | 'maxClipboardTextLength' | 'clipboardWriteFailed';
```


### BGridCellSelectionRange

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L741

```ts
export interface BGridCellSelectionRange
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `startRowIndex` | `number` | yes | no | Contract for startRowIndex; use the exact type shown in this row. |
| `startColumnIndex` | `number` | yes | no | Contract for startColumnIndex; use the exact type shown in this row. |
| `endRowIndex` | `number` | yes | no | Contract for endRowIndex; use the exact type shown in this row. |
| `endColumnIndex` | `number` | yes | no | Contract for endColumnIndex; use the exact type shown in this row. |


### BGridCellValueChange

Public type used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L39

```ts
export type BGridCellValueChange<T> =
  | {
      key: BGridColumn<T>['key'];
      columnId?: never;
      value: unknown;
    }
  | {
      columnId: string;
      key?: never;
      value: unknown;
    };
```


### BGridChangeValueParams

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L70

```ts
export interface BGridChangeValueParams<T> extends BGridCellCommitController<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `source` | `BGridEditSource` | yes | no | Contract for source; use the exact type shown in this row. |
| `column` | `BGridColumn<T>` | yes | no | Contract for column; use the exact type shown in this row. |
| `index` | `number` | yes | no | Contract for index; use the exact type shown in this row. |
| `columnIndex` | `number` | yes | no | Contract for columnIndex; use the exact type shown in this row. |
| `item` | `BGridDataItem<T>` | yes | no | Contract for item; use the exact type shown in this row. |
| `values` | `T` | yes | no | Contract for values; use the exact type shown in this row. |
| `nextValues` | `T` | yes | no | Contract for nextValues; use the exact type shown in this row. |
| `changes` | `readonly BGridCellValueChange<T>[]` | yes | no | Contract for changes; use the exact type shown in this row. |
| `rows` | `readonly BGridChangeValueRow<T>[]` | yes | no | Contract for rows; use the exact type shown in this row. |


### BGridChangeValueRow

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L62

```ts
export interface BGridChangeValueRow<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `index` | `number` | yes | no | Contract for index; use the exact type shown in this row. |
| `sourceIndex` | `number` | yes | no | Contract for sourceIndex; use the exact type shown in this row. |
| `item` | `BGridDataItem<T>` | yes | no | Contract for item; use the exact type shown in this row. |
| `values` | `T` | yes | no | Contract for values; use the exact type shown in this row. |
| `nextValues` | `T` | yes | no | Contract for nextValues; use the exact type shown in this row. |


### BGridCheckboxEditorConfig

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L123

```ts
export interface BGridCheckboxEditorConfig<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `type` | `'checkbox'` | yes | no | Contract for type; use the exact type shown in this row. |
| `trueValue` | `unknown` | no | no | Contract for trueValue; use the exact type shown in this row. |
| `falseValue` | `unknown` | no | no | Contract for falseValue; use the exact type shown in this row. |
| `header` | `boolean \| BGridCheckboxHeaderConfig` | no | no | Contract for header; use the exact type shown in this row. |
| `ariaLabel` | `string \| ((context: BGridCheckboxEditorContext<T>) => string)` | no | no | Contract for ariaLabel; use the exact type shown in this row. |
| `label` | `ReactNode \| ((context: BGridCheckboxEditorContext<T>) => ReactNode)` | no | no | Contract for label; use the exact type shown in this row. |
| `disabled` | `boolean \| ((context: BGridCheckboxEditorContext<T>) => boolean)` | no | no | Contract for disabled; use the exact type shown in this row. |


### BGridCheckboxEditorContext

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L34

```ts
export interface BGridCheckboxEditorContext<T> extends BGridTextEditorContext<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `sourceIndex` | `number` | yes | no | Contract for sourceIndex; use the exact type shown in this row. |
| `value` | `unknown` | yes | no | Contract for value; use the exact type shown in this row. |


### BGridCheckboxHeaderConfig

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L118

```ts
export interface BGridCheckboxHeaderConfig
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `ariaLabel` | `string` | no | no | Contract for ariaLabel; use the exact type shown in this row. |
| `disabled` | `boolean` | no | no | Contract for disabled; use the exact type shown in this row. |


### BGridCommitOptions

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L51

```ts
export interface BGridCommitOptions
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `move` | `BGridCellMoveDirection` | no | no | Contract for move; use the exact type shown in this row. |


### BGridEditorIconClickHandler

Public type used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L94

```ts
export type BGridEditorIconClickHandler<T> = (
  params: BGridEditorIconClickParams<T>,
) => void | (() => void) | Promise<void | (() => void)>;
```


### BGridEditorIconClickParams

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L92

```ts
export interface BGridEditorIconClickParams<T> extends BGridEditorIconParams<T>, BGridCellCommitController<T>
```


### BGridEditorIconConfig

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L98

```ts
export interface BGridEditorIconConfig<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `render` | `React.ReactNode \| ((params: BGridEditorIconParams<T>) => React.ReactNode)` | yes | no | Contract for render; use the exact type shown in this row. |
| `ariaLabel` | `string \| ((params: BGridEditorIconParams<T>) => string)` | no | no | Contract for ariaLabel; use the exact type shown in this row. |
| `visibility` | `'always' \| 'hover' \| 'active'` | no | no | Contract for visibility; use the exact type shown in this row. |
| `onClick` | `BGridEditorIconClickHandler<T>` | no | no | Contract for onClick; use the exact type shown in this row. |


### BGridEditorIconParams

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L82

```ts
export interface BGridEditorIconParams<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `column` | `BGridColumn<T>` | yes | no | Contract for column; use the exact type shown in this row. |
| `index` | `number` | yes | no | Contract for index; use the exact type shown in this row. |
| `columnIndex` | `number` | yes | no | Contract for columnIndex; use the exact type shown in this row. |
| `item` | `BGridDataItem<T>` | yes | no | Contract for item; use the exact type shown in this row. |
| `values` | `T` | yes | no | Contract for values; use the exact type shown in this row. |
| `value` | `unknown` | yes | no | Contract for value; use the exact type shown in this row. |
| `active` | `boolean` | yes | no | Contract for active; use the exact type shown in this row. |


### BGridEditorPluginProps

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L136

```ts
export interface BGridEditorPluginProps<T> extends BGridTextEditorContext<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `sessionId` | `number` | yes | no | Contract for sessionId; use the exact type shown in this row. |
| `value` | `unknown` | yes | no | Contract for value; use the exact type shown in this row. |
| `mode` | `'preserve' \| 'replace'` | yes | no | Contract for mode; use the exact type shown in this row. |
| `activation` | `BGridCellEditActivation` | yes | no | Contract for activation; use the exact type shown in this row. |
| `commit` | `BGridCellCommitController<T>['commit']` | yes | no | Contract for commit; use the exact type shown in this row. |
| `cancel` | `BGridCellCommitController<T>['cancel']` | yes | no | Contract for cancel; use the exact type shown in this row. |
| `move` | `(direction: BGridCellMoveDirection) => void` | yes | no | Contract for move; use the exact type shown in this row. |
| `getPortalContainer` | `() => HTMLElement` | yes | no | Contract for getPortalContainer; use the exact type shown in this row. |


### BGridEditSource

Public type used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L60

```ts
export type BGridEditSource = 'text' | 'plugin' | 'checkbox' | 'itemRender' | 'editorIcon';
```


### BGridEditTrigger

Public type used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L5

```ts
export type BGridEditTrigger = 'click' | 'dblclick';
```


### BGridMoveActiveCellOptions

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L721

```ts
export interface BGridMoveActiveCellOptions
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `extendSelection` | `boolean` | no | no | Contract for extendSelection; use the exact type shown in this row. |
| `toBoundary` | `boolean` | no | no | Contract for toBoundary; use the exact type shown in this row. |
| `pageSize` | `number` | no | no | Contract for pageSize; use the exact type shown in this row. |
| `selectionEnabled` | `boolean` | no | no | Contract for selectionEnabled; use the exact type shown in this row. |


### BGridPluginEditorConfig

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L147

```ts
export interface BGridPluginEditorConfig<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `type` | `'plugin'` | yes | no | Contract for type; use the exact type shown in this row. |
| `id` | `string` | yes | no | Contract for id; use the exact type shown in this row. |
| `component` | `React.ComponentType<BGridEditorPluginProps<T>>` | yes | no | Contract for component; use the exact type shown in this row. |
| `getClipboardText` | `(params: BGridCellClipboardTextParams<T>) => any` | no | no | Contract for getClipboardText; use the exact type shown in this row. |
| `parseClipboardText` | `(text: string, params: BGridCellClipboardParseParams<T>) => unknown` | no | no | Contract for parseClipboardText; use the exact type shown in this row. |


### BGridTextEditorConfig

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L105

```ts
export interface BGridTextEditorConfig<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `type` | `'text'` | yes | no | Contract for type; use the exact type shown in this row. |
| `startOnInput` | `boolean` | no | no | Contract for startOnInput; use the exact type shown in this row. |
| `commitOnBlur` | `boolean` | no | no | Contract for commitOnBlur; use the exact type shown in this row. |
| `formatValue` | `(value: unknown, context: BGridTextEditorContext<T>) => string` | no | no | Contract for formatValue; use the exact type shown in this row. |
| `parseValue` | `(text: string, context: BGridTextEditorContext<T>) => unknown` | no | no | Contract for parseValue; use the exact type shown in this row. |
| `ariaLabel` | `string \| ((context: BGridTextEditorContext<T>) => string)` | no | no | Contract for ariaLabel; use the exact type shown in this row. |
| `inputProps` | `Pick<<br>    React.InputHTMLAttributes<HTMLInputElement>,<br>    'placeholder' \| 'maxLength' \| 'inputMode' \| 'autoComplete' \| 'spellCheck'<br>  >` | no | no | Contract for inputProps; use the exact type shown in this row. |


### BGridTextEditorContext

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L26

```ts
export interface BGridTextEditorContext<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `index` | `number` | yes | no | Contract for index; use the exact type shown in this row. |
| `columnIndex` | `number` | yes | no | Contract for columnIndex; use the exact type shown in this row. |
| `item` | `BGridDataItem<T>` | yes | no | Contract for item; use the exact type shown in this row. |
| `values` | `T` | yes | no | Contract for values; use the exact type shown in this row. |
| `column` | `BGridColumn<T>` | yes | no | Contract for column; use the exact type shown in this row. |


## Layout and display

### BGridCellMergeColumn

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L264

```ts
export interface BGridCellMergeColumn
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `wordWrap` | `boolean` | no | no | Contract for wordWrap; use the exact type shown in this row. |
| `mergeBy` | `string \| string[]` | yes | no | Contract for mergeBy; use the exact type shown in this row. |


### BGridColumnGroup

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L247

```ts
export interface BGridColumnGroup
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `label` | `ReactNode` | yes | no | Contract for label; use the exact type shown in this row. |
| `groupStartIndex` | `number` | yes | no | Contract for groupStartIndex; use the exact type shown in this row. |
| `groupEndIndex` | `number` | yes | no | Contract for groupEndIndex; use the exact type shown in this row. |
| `align` | `AlignDirection` | no | no | Contract for align; use the exact type shown in this row. |
| `headerAlign` | `AlignDirection` | no | no | Contract for headerAlign; use the exact type shown in this row. |


### BGridColumnGroupNode

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L255

```ts
export interface BGridColumnGroupNode
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `id` | `string` | yes | no | Contract for id; use the exact type shown in this row. |
| `label` | `ReactNode` | yes | no | Contract for label; use the exact type shown in this row. |
| `headerAlign` | `AlignDirection` | no | no | Contract for headerAlign; use the exact type shown in this row. |
| `className` | `string` | no | no | Contract for className; use the exact type shown in this row. |
| `headerStyle` | `React.CSSProperties` | no | no | Contract for headerStyle; use the exact type shown in this row. |
| `children` | `Array<string \| BGridColumnGroupNode>` | yes | no | Contract for children; use the exact type shown in this row. |


### BGridHorizontalScrollbarOptions

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L814

```ts
export interface BGridHorizontalScrollbarOptions extends BGridViewStyleProps
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `visible` | `boolean` | no | no | Contract for visible; use the exact type shown in this row. |


### BGridPaginationViewOptions

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L810

```ts
export interface BGridPaginationViewOptions extends BGridViewStyleProps
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `visible` | `boolean` | no | no | Contract for visible; use the exact type shown in this row. |


### BGridScrollbarOptions

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L822

```ts
export interface BGridScrollbarOptions
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `variant` | `BGridScrollbarVariant` | no | no | Contract for variant; use the exact type shown in this row. |
| `horizontal` | `BGridHorizontalScrollbarOptions` | no | no | Contract for horizontal; use the exact type shown in this row. |
| `vertical` | `BGridVerticalScrollbarOptions` | no | no | Contract for vertical; use the exact type shown in this row. |


### BGridScrollbarVariant

Public type used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L790

```ts
export type BGridScrollbarVariant = 'native' | 'classic' | 'modern';
```


### BGridScrollToRowOptions

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L843

```ts
export interface BGridScrollToRowOptions
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `align` | `'start' \| 'center' \| 'end' \| 'nearest'` | no | no | Contract for align; use the exact type shown in this row. |


### BGridStatusContent

Public type used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L798

```ts
export type BGridStatusContent = React.ReactNode | ((context: BGridStatusContext) => React.ReactNode);
```


### BGridStatusContext

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L792

```ts
export interface BGridStatusContext
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `totalItems` | `number` | yes | no | Contract for totalItems; use the exact type shown in this row. |
| `visibleItems` | `number` | yes | no | Contract for visibleItems; use the exact type shown in this row. |
| `page` | `BGridPage` | no | no | Contract for page; use the exact type shown in this row. |


### BGridStatusOptions

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L805

```ts
export interface BGridStatusOptions extends BGridViewStyleProps
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `visible` | `boolean` | no | no | Contract for visible; use the exact type shown in this row. |
| `content` | `BGridStatusContent` | no | no | Contract for content; use the exact type shown in this row. |


### BGridSummaryColumn

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L276

```ts
export interface BGridSummaryColumn<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `columnIndex` | `number` | yes | no | Contract for columnIndex; use the exact type shown in this row. |
| `align` | `AlignDirection` | no | no | Contract for align; use the exact type shown in this row. |
| `colSpan` | `number` | no | no | Contract for colSpan; use the exact type shown in this row. |
| `className` | `string` | no | no | Contract for className; use the exact type shown in this row. |
| `style` | `React.CSSProperties` | no | no | Contract for style; use the exact type shown in this row. |
| `getClassName` | `(key: string \| string[]) => string` | no | no | Contract for getClassName; use the exact type shown in this row. |
| `itemRender` | `(props: BGridSummaryItemRenderProps<T>) => React.ReactNode` | no | no | Contract for itemRender; use the exact type shown in this row. |


### BGridSummaryItemRenderProps

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L269

```ts
export interface BGridSummaryItemRenderProps<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `column` | `BGridColumn<T>` | yes | no | Contract for column; use the exact type shown in this row. |
| `columnIndex` | `number` | yes | no | Contract for columnIndex; use the exact type shown in this row. |
| `rowIndex` | `number` | no | no | Contract for rowIndex; use the exact type shown in this row. |
| `data` | `BGridDataItem<T>[]` | yes | no | Contract for data; use the exact type shown in this row. |


### BGridVerticalScrollbarOptions

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L818

```ts
export interface BGridVerticalScrollbarOptions extends BGridViewStyleProps
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `visible` | `boolean` | no | no | Contract for visible; use the exact type shown in this row. |


### BGridViewStyleProps

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L800

```ts
export interface BGridViewStyleProps
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `className` | `string` | no | no | Contract for className; use the exact type shown in this row. |
| `style` | `React.CSSProperties` | no | no | Contract for style; use the exact type shown in this row. |


## Reordering

### BGridReorderInfo

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L493

```ts
export interface BGridReorderInfo<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `enabled` | `boolean` | no | no | Contract for enabled; use the exact type shown in this row. |
| `handleIcon` | `React.ReactNode` | no | no | Contract for handleIcon; use the exact type shown in this row. |
| `onReorder` | `(data: BGridDataItem<T>[]) => void \| boolean` | no | no | Contract for onReorder; use the exact type shown in this row. |


### BGridReorderingInfo

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L498

```ts
export interface BGridReorderingInfo
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `fromIndex` | `number` | no | no | Contract for fromIndex; use the exact type shown in this row. |
| `toIndex` | `number` | no | no | Contract for toIndex; use the exact type shown in this row. |
| `phase` | `'dragging' \| 'settling' \| 'cancelling'` | no | no | Contract for phase; use the exact type shown in this row. |
| `input` | `'pointer' \| 'keyboard'` | no | no | Contract for input; use the exact type shown in this row. |


## Pivot

### BGridPivotAggregate

Public type used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L524

```ts
export type BGridPivotAggregate<T> =
  | 'sum'
  | 'count'
  | 'avg'
  | 'min'
  | 'max'
  | 'first'
  | ((params: BGridPivotAggregateParams<T>) => any);
```


### BGridPivotAggregateParams

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L516

```ts
export interface BGridPivotAggregateParams<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `values` | `any[]` | yes | no | Contract for values; use the exact type shown in this row. |
| `items` | `BGridDataItem<T>[]` | yes | no | Contract for items; use the exact type shown in this row. |
| `rowValues` | `any[]` | yes | no | Contract for rowValues; use the exact type shown in this row. |
| `columnValues` | `any[]` | yes | no | Contract for columnValues; use the exact type shown in this row. |
| `value` | `BGridPivotValue<T>` | yes | no | Contract for value; use the exact type shown in this row. |


### BGridPivotField

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L505

```ts
export interface BGridPivotField
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `key` | `string \| string[]` | yes | no | Contract for key; use the exact type shown in this row. |
| `label` | `ReactNode` | no | no | Contract for label; use the exact type shown in this row. |
| `width` | `number` | no | no | Contract for width; use the exact type shown in this row. |
| `align` | `AlignDirection` | no | no | Contract for align; use the exact type shown in this row. |
| `headerAlign` | `AlignDirection` | no | no | Contract for headerAlign; use the exact type shown in this row. |
| `className` | `string` | no | no | Contract for className; use the exact type shown in this row. |
| `headerClassName` | `string` | no | no | Contract for headerClassName; use the exact type shown in this row. |
| `headerStyle` | `React.CSSProperties` | no | no | Contract for headerStyle; use the exact type shown in this row. |


### BGridPivotOptions

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L559

```ts
export interface BGridPivotOptions<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `enabled` | `boolean` | no | no | Contract for enabled; use the exact type shown in this row. |
| `rows` | `BGridPivotField[]` | yes | no | Contract for rows; use the exact type shown in this row. |
| `columns` | `BGridPivotField[]` | yes | no | Contract for columns; use the exact type shown in this row. |
| `values` | `BGridPivotValue<T>[]` | yes | no | Contract for values; use the exact type shown in this row. |
| `columnLabelSeparator` | `string` | no | no | Contract for columnLabelSeparator; use the exact type shown in this row. |
| `emptyValue` | `ReactNode` | no | no | Contract for emptyValue; use the exact type shown in this row. |


### BGridPivotValue

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L533

```ts
export interface BGridPivotValue<T> extends BGridPivotField
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `aggregate` | `BGridPivotAggregate<T>` | no | no | Contract for aggregate; use the exact type shown in this row. |
| `itemRender` | `React.FC<BGridPivotValueItemRenderProps<T>>` | no | no | Contract for itemRender; use the exact type shown in this row. |
| `getClipboardText` | `(params: BGridPivotValueClipboardTextParams<T>) => any` | no | no | Contract for getClipboardText; use the exact type shown in this row. |


### BGridPivotValueClipboardTextParams

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L553

```ts
export interface BGridPivotValueClipboardTextParams<T> extends Omit<BGridCellClipboardTextParams<Record<string, any>>, 'column'>,
    BGridPivotValueContext<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `column` | `BGridColumn<Record<string, any>>` | yes | no | Contract for column; use the exact type shown in this row. |


### BGridPivotValueContext

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L539

```ts
export interface BGridPivotValueContext<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `sourceItems` | `BGridDataItem<T>[]` | yes | no | Contract for sourceItems; use the exact type shown in this row. |
| `rowValues` | `any[]` | yes | no | Contract for rowValues; use the exact type shown in this row. |
| `columnValues` | `any[]` | yes | no | Contract for columnValues; use the exact type shown in this row. |
| `pivotValue` | `BGridPivotValue<T>` | yes | no | Contract for pivotValue; use the exact type shown in this row. |
| `aggregate` | `BGridPivotAggregate<T>` | no | no | Contract for aggregate; use the exact type shown in this row. |


### BGridPivotValueItemRenderProps

Public interface used by BeautifulGrid configuration or callbacks. The declaration below is generated from the library source.

Source: https://github.com/axisj/beautiful-grid/blob/main/beautiful-grid/types.ts#L547

```ts
export interface BGridPivotValueItemRenderProps<T> extends Omit<BGridItemRenderProps<Record<string, any>>, 'column'>,
    BGridPivotValueContext<T>
```

| Member | Type | Required | Deprecated | Description |
| --- | --- | --- | --- | --- |
| `column` | `BGridColumn<Record<string, any>>` | yes | no | Contract for column; use the exact type shown in this row. |