New to KendoReactStart a free 30-day trial

Defines the props of the ColumnMenu component.

Definition

Package:@progress/kendo-react-data-tools

Properties

Sets the initial expand state of the filters.

Default:

false

field?

string

Sets the column field the menu operates on.

filter?

CompositeFilterDescriptor[]

Sets the CompositeFilterDescriptor[] applied to the data.

Provides the filtering UI components in render order. Supply up to three components: first filter, logic, second filter.

Returns the initial CompositeFilterDescriptor based on the current field. Use to customize starting filter values.

Parameters:fieldstringReturns:

CompositeFilterDescriptor

Fires before the ColumnMenu items render. Use to add or remove items. defaultRendering holds sorting and filtering elements. props exposes the column field and closeMenu() helper.

Parameters:defaultRenderingnull | ReactElement​<HTMLDivElement, string | JSXElementConstructor​<any>>[]props{ field?: string; closeMenu: () => void }Returns:

ReactNode

onFilterChange?

(event: SyntheticEvent​<any, Event>, filter: CompositeFilterDescriptor[], field: string) => void

Fires when filtering changes. Receives the browser event, the new CompositeFilterDescriptor[], and the column field.

Parameters:eventSyntheticEvent​<any, Event>filterCompositeFilterDescriptor[]fieldstring

onSortChange?

(event: SyntheticEvent​<any, Event>, sort: SortDescriptor[], field: string) => void

Fires when sorting changes. Receives the browser event, the new SortDescriptor[], and the column field.

Parameters:eventSyntheticEvent​<any, Event>sortSortDescriptor[]fieldstring

Fires before the ColumnMenu renders. Use to override the entire rendering. defaultRendering contains the menu button and popup elements (and license watermark when present).

Parameters:defaultRenderingReactElement​<any, string | JSXElementConstructor​<any>>[]Returns:

ReactNode

sort?

SortDescriptor[]

Sets the SortDescriptor[] applied to the data.

sortAsc?

boolean

Shows the ascending sort button when true.

Default:

false

sortDesc?

boolean

Shows the descending sort button when true.

Default:

false