Components
    • Animation
    • Barcodes
    • Buttons
    • Charts
    • Common Utilities
    • Conversational UI
    • Data Grid
    • Data Query
    • Data Tools
    • Date Inputs
    • Date Math
    • Dialogs
    • Drawing
    • Dropdowns
    • Editor
    • Excel Export
    • File Saver
    • Form
    • Gantt
    • Gauges
    • Indicators
    • Inputs
    • Labels
    • Layout
    • ListBox
    • ListView
    • Mapbeta
    • Notification
    • PDF Processing
    • PivotGrid
    • Popup
    • Progress Bars
    • Ripple
    • Scheduler
    • ScrollView
    • Sortable
    • TaskBoard
    • Tooltips
    • TreeList
    • TreeView
    • Upload
    Sample Applications
    Styling & Themes
    Common Features
    Project Setup
    Changelog

ColumnMenuProps

The props of the ColumnMenu component.

NameTypeDefaultDescription

expandFilters?

boolean

Defines the initial expand state of the filters. Defaults to false.

field?

string

The field to which the ColumnMenu is bound.

filter?

CompositeFilterDescriptor[]

The descriptors by which the data is filtered.

filterContent?

any[]

Defines the filtering UI and accepts an array with components.

sort?

SortDescriptor[]

The descriptors by which the data is sorted.

sortAsc?

boolean

If set to true, a button for sorting in asc direction will be rendered.

sortDesc?

boolean

If set to true, a button for sorting in desc direction will be rendered.

Methods

initialFilter

A function that returns the initial filter descriptor base on the ColumnMenu field. Use it to customize the initial values of the filtering components.

Parameters

field

string

Returns

CompositeFilterDescriptor

itemsRender

Fires when the ColumnMenu items are about to be rendered. Use it to add or remove menu items. The defaultRendering is an array with the sorting and filtering components. props contains the column's field and the closeMenu function which closes the ColumnMenu.

Parameters

defaultRendering

undefined[]

props

{ field?: string; closeMenu: closeMenu; }

Returns

ReactNode

onFilterChange

Fires when the ColumnMenu filter is changed.

Parameters

event

SyntheticEvent<any>

filter

CompositeFilterDescriptor[]

field

string

onSortChange

Fires when the sorting of the ColumnMenu is changed.

Parameters

event

SyntheticEvent<any>

sort

SortDescriptor[]

field

string

render

Fires when the ColumnMenu is about to be rendered. Use it to override the default rendering of the ColumnMenu. The defaultRendering is an array with the button React.ReactElement<HTMLSpanElement> and popup React.ReactElement<PopupProps> components.

Parameters

defaultRendering

ReactElement<any>[]

Returns

ReactNode