Group By

Wrap with the Filter Provider to apply the selected group by to child components.

GitHub

Storybook

Example

Props API

query

GroupByQueryProps

GroupBy query props

selectProps

Omit<SelectProps<{ label: string; value: string; }>, "options" | "disableClearable">

Props that the select input will receive

columns

string[]

Columns to group by for static mode, if passed, the component will ignore the built-in GraphQL operations

boolean

When true, shows a skeleton loader

prettifyColumnNames

boolean

If true, it will format camelCase and snake_case column names to a readable format

nameFormatter

(name: string) => string

Function to format column names

includeColumns

string[]

Columns to include, if not passed, all columns will be included, pass ["*"] to include all columns

maxGroupBy

number

Maximum number of group by columns

defaultOpen

boolean

If true, the dropdown will be open by default