Skip to content

PinnedRowsConfig

Configuration options for the status bar plugin

PropertyTypeDescription
slots?PinnedRowSlot[]Unified ordered list of pinned-row slots. When provided, aggregationRows, customPanels, position, showRowCount, showSelectedCount and showFilteredCount are ignored — slots are rendered in declared order within their position (‘top’ or ‘bottom’, default ‘bottom’).
position?PinnedRowsPosition⚠️ Position of the info bar (default: ‘bottom’).
showRowCount?boolean⚠️ Show total row count in info bar (default: true).
showSelectedCount?boolean⚠️ Show selected row count in info bar (default: true).
showFilteredCount?boolean⚠️ Show filtered row count when filter is active (default: true).
customPanels?PinnedRowsPanel[]⚠️ Custom panels to display in the info bar.
aggregationRows?AggregationRowConfig[]⚠️ Aggregation rows (footer/header rows with computed values).
fullWidth?booleanDefault fullWidth mode for all aggregation rows. When true, each aggregation row renders as a single spanning cell with label and aggregated values inline. When false (default), rows render per-column cells aligned to the grid template. Individual AggregationRowConfig.fullWidth (or AggregationSlot.fullWidth) overrides this.

Unified ordered list of pinned-row slots. When provided, aggregationRows, customPanels, position, showRowCount, showSelectedCount and showFilteredCount are ignored — slots are rendered in declared order within their position (‘top’ or ‘bottom’, default ‘bottom’).

When omitted, the plugin synthesizes a slot list from the legacy fields so existing consumers keep their current DOM byte-identical.

import { rowCountPanel, selectedCountPanel } from '@toolbox-web/grid/plugins/pinned-rows';
new PinnedRowsPlugin({
slots: [
{ position: 'top', render: rowCountPanel() },
{ position: 'top', aggregators: { price: 'sum' }, label: 'Total' },
{ position: 'bottom', render: selectedCountPanel() },
],
});

Default: false


AI assistants: For complete API documentation, implementation guides, and code examples for this library, see https://raw.githubusercontent.com/OysteinAmundsen/toolbox/main/llms-full.txt