Settings

ColumnBorderMode, GridFooterConfig, GridHeaderConfig, GridHeaderMenuConfig and 4 more: generated from the source of active-grid.

Exported by @workspace/active-grid. Generated from the package source; part of the index of every export.

Functions, hooks and constants#

resolveColumnBorderMode

Internal. Normalize showColumnBorders (boolean | string) to a ColumnBorderMode. Used internally by the grid layout; exported for theme/preset authors.

(value: boolean | "none" | "partial" | "full" | undefined) => ColumnBorderMode

Types#

ColumnBorderMode

type ColumnBorderMode = 'none' | 'partial' | 'full';

GridFooterConfig

Configuration for the Sticky Footer (Aggregations).

interface GridFooterConfig {
  className?: string;
  cellClassName?: string;
}

GridHeaderConfig

Configuration for the Grid Header.

interface GridHeaderConfig {
  filterRowClassName?: string;
  menuPosition?: 'left' | 'right';
  showMenuOnHover?: boolean;
  showFilterIcon?: boolean;
  showColumnSeparators?: boolean;
}

GridHeaderMenuConfig

Configuration for the Header Menu (the 3 dots per column).

interface GridHeaderMenuConfig {
  enabled?: boolean;
  showLabels?: boolean;
  className?: string;
  itemClassName?: string;
  separatorClassName?: string;
  features?: {
    sort?: boolean;
    pin?: boolean;
    resize?: boolean;
    visibility?: boolean;
    reset?: boolean;
    grouping?: boolean;
  };
}

GridPaginationStyleConfig

Configuration for the Pagination Bar.

interface GridPaginationStyleConfig {
  containerClassName?: string;
}

GridRowMenuConfig

Configuration for the Row Context Menu (Right-click).

interface GridRowMenuConfig {
  enabled?: boolean;
  className?: string;
  itemClassName?: string;
  separatorClassName?: string;
  subContentClassName?: string;
  features?: {
    copy?: boolean;
    export?: boolean;
    reset?: boolean;
  };
}

GridSettings

interface GridSettings<TData = DefaultRowData> {
  rowHeight?: number;
  headerHeight?: number;
  groupHeaderHeight?: number;
  filterBarHeight?: number;
  showFilterRow?: boolean;
  paginationHeight?: number;
  stripedRows?: boolean;
  stripeClassName?: string;
  showColumnBorders?: boolean | 'none' | 'partial' | 'full';
  autoSizeMaxBodyWidth?: number;
  disableHoverEffect?: boolean;
  noDataMessage?: string;
  noDataOverlay?: React.ReactNode;
  rowClassRules?: Record<string, (data: TData) => boolean>;
  footer?: GridFooterConfig;
  header?: GridHeaderConfig;
  pagination?: GridPaginationStyleConfig;
}