Public interfaces & types

Public interface exported for DataGrid configuration and callbacks.

export interface BGridProps<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridColumn<T>

Public type exported for DataGrid configuration and callbacks.

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>;
};

Public type exported for DataGrid configuration and callbacks.

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

Public interface exported for DataGrid configuration and callbacks.

export interface BGridCellClipboardParseParams<T> extends BGridCellClipboardTextParams<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridCellClipboardTextParams<T>

Public type exported for DataGrid configuration and callbacks.

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

Public enum exported for DataGrid configuration and callbacks.

export enum BGridDataItemStatus

Public interface exported for DataGrid configuration and callbacks.

export interface BGridItemRenderProps<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridRef<T = any>

Public type exported for DataGrid configuration and callbacks.

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

Public interface exported for DataGrid configuration and callbacks.

export interface BGridCellExportValueParams<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridChangeColumnsInfo<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridChangeDataMeta<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridClickParams<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridCsvExportOptions extends BGridExportDataOptions

Public interface exported for DataGrid configuration and callbacks.

export interface BGridCsvSerializeOptions

Public interface exported for DataGrid configuration and callbacks.

export interface BGridExcelExportOptions extends BGridExportDataOptions, BGridExcelSerializeOptions

Public interface exported for DataGrid configuration and callbacks.

export interface BGridExcelSerializeOptions

Public interface exported for DataGrid configuration and callbacks.

export interface BGridExportColumn<T>

Public type exported for DataGrid configuration and callbacks.

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

Public interface exported for DataGrid configuration and callbacks.

export interface BGridExportData<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridExportDataOptions

Public interface exported for DataGrid configuration and callbacks.

export interface BGridExportRow<T>

Public type exported for DataGrid configuration and callbacks.

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

Public interface exported for DataGrid configuration and callbacks.

export interface BGridPage

Public interface exported for DataGrid configuration and callbacks.

export interface BGridProcessedRow<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridRowChecked<T>

Public type exported for DataGrid configuration and callbacks.

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

Public interface exported for DataGrid configuration and callbacks.

export interface BGridColumnFilterConfig<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridColumnVisibilityChangeEvent<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridColumnVisibilityOptions<T>

Public type exported for DataGrid configuration and callbacks.

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;
    };

Public interface exported for DataGrid configuration and callbacks.

export interface BGridContextMenuOptions<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridContextMenuTarget<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridDataControl

Public interface exported for DataGrid configuration and callbacks.

export interface BGridDataQuery

Public interface exported for DataGrid configuration and callbacks.

export interface BGridDataQueryChangeEvent

Public type exported for DataGrid configuration and callbacks.

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

Public type exported for DataGrid configuration and callbacks.

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;
    });

Public type exported for DataGrid configuration and callbacks.

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

Public interface exported for DataGrid configuration and callbacks.

export interface BGridSearchCellParams<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridSearchIcons

Public interface exported for DataGrid configuration and callbacks.

export interface BGridSearchLabels

Public type exported for DataGrid configuration and callbacks.

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

Public interface exported for DataGrid configuration and callbacks.

export interface BGridSearchOptions<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridSortInfo

Public interface exported for DataGrid configuration and callbacks.

export interface BGridSortParam

Public interface exported for DataGrid configuration and callbacks.

export interface BGridToolboxConfig<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridToolboxIcons

Public interface exported for DataGrid configuration and callbacks.

export interface BGridToolboxItem<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridToolboxRenderProps<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridCellAddress

Public interface exported for DataGrid configuration and callbacks.

export interface BGridCellCommitController<T>

Public type exported for DataGrid configuration and callbacks.

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

Public interface exported for DataGrid configuration and callbacks.

export interface BGridCellEditSession extends BGridCellInteractionSessionBase

Public type exported for DataGrid configuration and callbacks.

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

Public interface exported for DataGrid configuration and callbacks.

export interface BGridCellNavigationOptions

Public interface exported for DataGrid configuration and callbacks.

export interface BGridCellSelectionCopyError

Public type exported for DataGrid configuration and callbacks.

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

Public interface exported for DataGrid configuration and callbacks.

export interface BGridCellSelectionRange

Public type exported for DataGrid configuration and callbacks.

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

Public interface exported for DataGrid configuration and callbacks.

export interface BGridChangeValueParams<T> extends BGridCellCommitController<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridChangeValueRow<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridCheckboxEditorConfig<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridCheckboxEditorContext<T> extends BGridTextEditorContext<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridCheckboxHeaderConfig

Public interface exported for DataGrid configuration and callbacks.

export interface BGridCommitOptions

Public type exported for DataGrid configuration and callbacks.

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

Public interface exported for DataGrid configuration and callbacks.

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

Public interface exported for DataGrid configuration and callbacks.

export interface BGridEditorIconConfig<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridEditorIconParams<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridEditorPluginProps<T> extends BGridTextEditorContext<T>

Public type exported for DataGrid configuration and callbacks.

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

Public type exported for DataGrid configuration and callbacks.

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

Public interface exported for DataGrid configuration and callbacks.

export interface BGridMoveActiveCellOptions

Public interface exported for DataGrid configuration and callbacks.

export interface BGridPluginEditorConfig<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridTextEditorConfig<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridTextEditorContext<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridCellMergeColumn

Public interface exported for DataGrid configuration and callbacks.

export interface BGridColumnGroup

Public interface exported for DataGrid configuration and callbacks.

export interface BGridColumnGroupNode

Public interface exported for DataGrid configuration and callbacks.

export interface BGridHorizontalScrollbarOptions extends BGridViewStyleProps

Public interface exported for DataGrid configuration and callbacks.

export interface BGridPaginationViewOptions extends BGridViewStyleProps

Public interface exported for DataGrid configuration and callbacks.

export interface BGridScrollbarOptions

Public type exported for DataGrid configuration and callbacks.

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

Public interface exported for DataGrid configuration and callbacks.

export interface BGridScrollToRowOptions

Public type exported for DataGrid configuration and callbacks.

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

Public interface exported for DataGrid configuration and callbacks.

export interface BGridStatusContext

Public interface exported for DataGrid configuration and callbacks.

export interface BGridStatusOptions extends BGridViewStyleProps

Public interface exported for DataGrid configuration and callbacks.

export interface BGridSummaryColumn<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridSummaryItemRenderProps<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridVerticalScrollbarOptions extends BGridViewStyleProps

Public interface exported for DataGrid configuration and callbacks.

export interface BGridViewStyleProps

Public interface exported for DataGrid configuration and callbacks.

export interface BGridReorderInfo<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridReorderingInfo

Public type exported for DataGrid configuration and callbacks.

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

Public interface exported for DataGrid configuration and callbacks.

export interface BGridPivotAggregateParams<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridPivotField

Public interface exported for DataGrid configuration and callbacks.

export interface BGridPivotOptions<T>

Public interface exported for DataGrid configuration and callbacks.

export interface BGridPivotValue<T> extends BGridPivotField

Public interface exported for DataGrid configuration and callbacks.

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

Public interface exported for DataGrid configuration and callbacks.

export interface BGridPivotValueContext<T>

Public interface exported for DataGrid configuration and callbacks.

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