@serenity-is/sleekgrid / GroupItemMetadataProviderOptions

Interface: GroupItemMetadataProviderOptions

Defined in: src/data/groupitemmetadataprovider.tsx:6

Options controlling how GroupItemMetadataProvider renders group and totals rows.

Properties

enableExpandCollapse?

optional enableExpandCollapse: boolean

Defined in: src/data/groupitemmetadataprovider.tsx:8

Whether group rows show an expand/collapse toggle and respond to clicks/keys. Defaults to true.

---

groupCellCssClass?

optional groupCellCssClass: string

Defined in: src/data/groupitemmetadataprovider.tsx:10

CSS class applied to the group cell (the spanned cell). Defaults to "slick-group-cell".

---

groupCssClass?

optional groupCssClass: string

Defined in: src/data/groupitemmetadataprovider.tsx:12

CSS class applied to the entire group row. Defaults to "slick-group".

---

groupFocusable?

optional groupFocusable: boolean

Defined in: src/data/groupitemmetadataprovider.tsx:16

Whether group rows can receive focus. Defaults to true.

---

groupFormat?

optional groupFormat: ColumnFormat<Group<any>>

Defined in: src/data/groupitemmetadataprovider.tsx:18

Modern formatter for the group title/aggregated content.

---

groupFormatter?

optional groupFormatter: CompatFormatter<Group<any>>

Defined in: src/data/groupitemmetadataprovider.tsx:23

Legacy formatter for group rows.

Deprecated

Use GroupItemMetadataProviderOptions.groupFormat instead.

---

groupIndentation?

optional groupIndentation: number

Defined in: src/data/groupitemmetadataprovider.tsx:14

Indentation in pixels per grouping level for the toggle. Defaults to 15.

---

groupLevelPrefix?

optional groupLevelPrefix: string

Defined in: src/data/groupitemmetadataprovider.tsx:25

CSS class prefix for grouping level (appended with level number). Defaults to "slick-group-level-".

---

groupRowTotals?

optional groupRowTotals: boolean

Defined in: src/data/groupitemmetadataprovider.tsx:27

Whether totals rows should be considered part of the group row span calculation.

---

groupTitleCssClass?

optional groupTitleCssClass: string

Defined in: src/data/groupitemmetadataprovider.tsx:29

CSS class applied to the title span inside the group cell. Defaults to "slick-group-title".

---

hasSummaryType()?

optional hasSummaryType: (column) => boolean

Defined in: src/data/groupitemmetadataprovider.tsx:36

Predicate determining whether a column has a summary/aggregate. Used to locate the spanned group cell position.

Parameters

column

Column

Column to test.

Returns

boolean

true if the column contributes a total/summary.

---

toggleCollapsedCssClass?

optional toggleCollapsedCssClass: string

Defined in: src/data/groupitemmetadataprovider.tsx:42

CSS class added when the toggle represents a collapsed group. Defaults to "collapsed".

---

toggleCssClass?

optional toggleCssClass: string

Defined in: src/data/groupitemmetadataprovider.tsx:38

CSS class for the expand/collapse toggle element. Defaults to "slick-group-toggle".

---

toggleExpandedCssClass?

optional toggleExpandedCssClass: string

Defined in: src/data/groupitemmetadataprovider.tsx:40

CSS class added when the toggle represents an expanded group. Defaults to "expanded".

---

totalsCssClass?

optional totalsCssClass: string

Defined in: src/data/groupitemmetadataprovider.tsx:44

CSS class applied to totals rows. Defaults to "slick-group-totals".

---

totalsFocusable?

optional totalsFocusable: boolean

Defined in: src/data/groupitemmetadataprovider.tsx:46

Whether totals rows can receive focus. Defaults to false.

---

totalsFormat?

optional totalsFormat: ColumnFormat<IGroupTotals<any>>

Defined in: src/data/groupitemmetadataprovider.tsx:48

Modern formatter for totals rows.

---

totalsFormatter?

optional totalsFormatter: CompatFormatter<IGroupTotals<any>>

Defined in: src/data/groupitemmetadataprovider.tsx:53

Legacy formatter for totals rows.

Deprecated

Use GroupItemMetadataProviderOptions.totalsFormat instead.