MultiCascader 级联多项选择器

对有层级关系结构的数据进行多项选择。

获取组件

import { MultiCascader } from 'rsuite';

演示

默认

外观

尺寸

级联

默认值

受控

撑满

位置

自定义选项

禁用与只读

不可选状态

异步

容器与防止溢出

Inline

可访问性

ARIA 属性

  • MultiCascader 组件的 role 属性为 combobox
  • aria-haspopup="tree" 属性来指示 combobox 有一个弹出的树形列表框。
  • aria-expanded 属性来指示树形列表框是否打开。
  • aria-controls 属性来指示树形列表框元素的 ID。
  • aria-activedescendant 属性来指示焦点树节点的 ID。
  • 当设置了 label, aria-labelledby 属性被添加到 combobox 元素和 tree 元素上,并将值设置为 labelid 属性值。
  • tree 有 aria-multiselectable=true 属性来指示树形列表框是多选的。

键盘交互

  • - 移动焦点到下一个树节点。
  • - 移动焦点到上一个树节点。
  • - 展开当前树节点。
  • - 收起当前树节点。
  • Enter - 选择聚焦的树节点。
  • Esc - 关闭树形列表框。

Props

ts:ItemDataType

interface ItemDataType {
  /** The value of the option corresponds to the `valueKey` in the data. **/
  value: string;

  /** The content displayed by the option corresponds to the `labelKey` in the data. **/
  label: ReactNode;

  /**
   * The data of the child option corresponds to the `childrenKey` in the data.
   * Properties owned by tree structure components, such as TreePicker, Cascader.
   */
  children?: ItemDataType[];

  /**
   * Properties of grouping functional components, such as CheckPicker, InputPicker
   */
  groupBy?: string;

  /**
   * The children under the current node are loading.
   * Used for components that have cascading relationships and lazy loading of children. E.g. Cascader, MultiCascader
   */
  loading?: boolean;
}

<MultiCascader>

属性名称 类型(默认值) 描述
appearance 'default' | 'subtle' ('default') 设置外观
block boolean 堵塞整行
caretAs ElementType 自定义右侧箭头图标的组件
cascade boolean (true) 是否级联选择
childrenKey string ('children') 设置选项子节点在 data 中的 key
classPrefix string ('picker') 组件 CSS 类的前缀
cleanable boolean (true) 可以清除
container HTMLElement | (() => HTMLElement) 设置渲染的容器
countable boolean (true) 可以计数已选项
data * ItemDataType[] 组件数据
defaultOpen boolean 默认打开
defaultValue ValueType 设置默认值
disabled boolean 禁用组件
disabledItemValues ValueType 禁用选项
height number (320) 设置 Dropdown 的高度
inline boolean 在组件初始后直接展示菜单
labelKey string ('label') 设置选项显示内容在 data 中的 key
loading boolean (false) 是否显示一个加载中状态指示器
locale PickerLocaleType 本地化的文本
menuClassName string 选项菜单的 className
menuHeight number (200) 设置菜单的高度
menuWidth number (156) 设置菜单的宽度
onChange (value: ValueType, event) => void value 发生改变时的回调函数
onCheck (value: ValueType, item:ItemDataType, checked:boolean, event) => void; 复选框选中状态发生变化的回调函数
onClean (event) => void 值清理时触发回调
onClose () => void 关闭回调函数
onEnter () => void 显示前动画过渡的回调函数
onEntered () => void 显示后动画过渡的回调函数
onEntering () => void 显示中动画过渡的回调函数
onExit () => void 退出前动画过渡的回调函数
onExited () => void 退出后动画过渡的回调函数
onExiting () => void 退出中动画过渡的回调函数
onOpen () => void 打开回调函数
onSearch (searchKeyword:string, event) => void 搜索的回调函数
onSelect (item:ItemDataType, selectedPaths: ItemDataType[], event) => void 选项被点击选择后的回调函数
open boolean 打开 (受控)
placeholder ReactNode ('Select') 占位符
placement Placement('bottomStart') 打开位置
preventOverflow boolean 防止浮动元素溢出
renderExtraFooter () => ReactNode 自定义页脚内容
renderMenu (children: object[], menu:ReactNode, parentNode?: object, layer?: number) => ReactNode 自定义渲染菜单列表
renderMenuItem (label:ReactNode, item: ItemDataType ) => ReactNode 自定义选项
renderValue (value:ValueType, selectedItems: ItemDataType[], selectedElement: ReactNode ) => ReactNode 自定义被选中的选项
searchable boolean (true) 可以搜索
size 'lg' | 'md' | 'sm' | 'xs' ('md') 设置组件尺寸
toggleAs ElementType ('a') 为组件自定义元素类型
uncheckableItemValues ValueType 设置不显示复选框的选项值
value ValueType 设置值(受控)
valueKey string ('value') 设置选项值在 data 中的 key

ts:ItemDataType

interface ItemDataType {
  /** The value of the option corresponds to the `valueKey` in the data. **/
  value: string;

  /** The content displayed by the option corresponds to the `labelKey` in the data. **/
  label: ReactNode;

  /**
   * The data of the child option corresponds to the `childrenKey` in the data.
   * Properties owned by tree structure components, such as TreePicker, Cascader.
   */
  children?: ItemDataType[];

  /**
   * Properties of grouping functional components, such as CheckPicker, InputPicker
   */
  groupBy?: string;

  /**
   * The children under the current node are loading.
   * Used for components that have cascading relationships and lazy loading of children. E.g. Cascader, MultiCascader
   */
  loading?: boolean;
}

ts:Placement

type Placement = 'bottomStart' | 'topStart' | 'autoVerticalStart';

ts:ValueType

type ValueType = (string | number)[];
Vercel banner