StickyRowsConfig
Since v2.7.0
Configuration for StickyRowsPlugin.
Example
Section titled “Example”import '@toolbox-web/grid/features/sticky-rows';grid.gridConfig = { features: { stickyRows: { isSticky: 'isSection' } } };Properties
Section titled “Properties”| Property | Type | Description |
|---|---|---|
isSticky | string | StickyPredicate | Either a field name on the row (truthy value marks the row as sticky) or a predicate that returns a truthy/falsy value per row. |
mode? | StickyRowsMode | Behavior when multiple sticky rows would be stuck simultaneously. |
maxStacked? | number | Maximum number of rows stacked below the header in 'stack' mode. Ignored in 'push' mode (which is always 1). |
className? | string | Optional class added to the stuck-row clones for custom styling. |
Property Details
Section titled “Property Details”isSticky
Section titled “isSticky”Either a field name on the row (truthy value marks the row as sticky) or a predicate that returns a truthy/falsy value per row.
Required — without it the plugin renders nothing.
Default: 'push'
maxStacked
Section titled “maxStacked”Default: Infinity