• What is KendoReact
  • Getting Started
  • Server Components
  • Components
    • Animation
    • Barcodes
    • Buttons
    • Chartsupdated
    • Common Utilities
    • Conversational UIupdated
    • Data Gridupdated
    • Data Query
    • Data Tools
    • Date Inputs
    • Date Math
    • Dialogs
    • Drawing
    • Dropdownsupdated
    • Editor
    • Excel Export
    • File Saver
    • Formupdated
    • Ganttupdated
    • Gauges
    • Indicators
    • Inputsupdated
    • Labels
    • Layoutupdated
    • ListBoxupdated
    • ListView
    • Map
    • Notification
    • OrgChartnew
    • PDF Processing
    • PDFViewer
    • PivotGrid
    • Popup
    • Progress Bars
    • Ripple
    • Scheduler
    • ScrollView
    • Sortable
    • Spreadsheetupdated
    • TaskBoard
    • Tooltips
    • TreeList
    • TreeViewupdated
    • Upload
  • Sample Applications
  • Styling & Themes
  • Common Features
  • Project Setup
  • Knowledge Base
  • Changelog
  • Updates
  • Troubleshooting
Components / Data Tools / API / ColumnMenuProps / 

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.

initialFilter?

(field: string) => CompositeFilterDescriptor

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

itemsRender?

(defaultRendering: undefined[], props: { closeMenu: () => void; field?: string; }) => ReactNode

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.

onFilterChange?

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

Fires when the ColumnMenu filter is changed.

onSortChange?

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

Fires when the sorting of the ColumnMenu is changed.

render?

(defaultRendering: ReactElement<any>[]) => ReactNode

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.

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.

In this article

Not finding the help you need?

Contact Support