ant-design/components/cascader/index.en-US.md

1.7 KiB
Raw Blame History

category type title
Components Form Controls Cascader

Cascade selection box.

When to use

  • When you need to select from a set of associated data set. Such as province/city/district, company level, things classification.
  • When selecting from a large data set, with multi-stage classification separated for easy selection.
  • chooses cascade items in one float layer for better user experience.

API

<Cascader options={options} onChange={onChange} />
Property Description Type Default
options data options of cascade object -
defaultValue initial selected value array []
value selected value array -
onChange callback when finishing cascader select function(value, selectedOptions) -
displayRender render function of displaying selected options function(label, selectedOptions) label => label.join(' / ')
style additional style string -
className additional css class string -
popupClassName additional className of popup overlay string -
popupPlacement use preset popup align config from builtinPlacementsbottomLeft bottomRight topLeft topRight string bottomLeft
placeholder input placeholder string 'Please select'
size input size, one of large default small string default
disabled whether disabled select boolean false
allowClear whether allow clear boolean true
expandTrigger expand current item when click or hover, one of 'click' 'hover' string 'click'
changeOnSelect change value on each selection if set to true, see above demo for details boolean false