CheckPicker 多项选择器

用于多项数据选择，支持分组。

获取组件

MainIndividual
import { CheckPicker } from 'rsuite';

演示

默认

具有标签

外观

尺寸

置顶已选项

设置 sticky属性， 把选项中已选择的选项置顶在最前面。

撑满

加载中状态

当选择器处于加载中状态时，会显示一个旋转效果作为提示。 在加载中状态时，点击选择器不会展开选项菜单。

分组

位置与防止溢出

自定义选项

禁用与只读

禁用搜索框

自定义页脚

自定义一个全选功能

异步

受控

虚拟化长列表

响应式

可访问性

ARIA 属性

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

键盘交互

  • ↓ - 移动焦点到下一个选项。
  • ↑ - 移动焦点到上一个选项。
  • Enter - 选择焦点选项。
  • Esc - 关闭列表框。

Props

<CheckPicker>

属性名称 类型(默认值) 描述
appearance 'default' | 'subtle' ('default') 设置外观
block boolean 堵塞整行
caretAs ElementType 自定义右侧箭头图标的组件
classPrefix string ('picker') 组件 CSS 类的前缀
cleanable boolean (true) 可以清除
container HTMLElement | (() => HTMLElement) 设置渲染的容器
countable boolean (true) 是否显示选中条目的数量
data * Option[] 组件数据
defaultValue Value 默认值（非受控）
disabled boolean 禁用组件
disabledItemValues Value 禁用选项
groupBy string 设置分组条件在 data 中的 key
label ReactNode 在按钮开头显示的标签
labelKey string ('label') 设置选项显示内容在 data 中的 key
listboxMaxHeight number (320) 设置 Listbox 的最大高度
listProps ListProps 虚拟化长列表的相关属性
loading boolean (false) 是否显示一个加载中状态指示器
locale PickerLocaleType 本地化的文本
onChange (value: Value , event) => void value 发生改变时的回调函数
onClean (event) => void 清空值时触发回调
onClose () => void 关闭回调函数
onEnter () => void 显示前动画过渡的回调函数
onEntered () => void 显示后动画过渡的回调函数
onEntering () => void 显示中动画过渡的回调函数
onExit () => void 退出前动画过渡的回调函数
onExited () => void 退出后动画过渡的回调函数
onExiting () => void 退出中动画过渡的回调函数
onGroupTitleClick (event) => void 点击分组标题的回调函数
onOpen () => void 打开回调函数
onSearch (search:string, event) => void 搜索的回调函数
onSelect (value:Value, item: Option , event) => void 选项被点击选择后的回调函数
open boolean 是否打开
placeholder ReactNode ('Select') 占位符
placement Placement('bottomStart') 位置
popupClassName string 自定义弹出框的 className
popupStyle CSSProperties 自定义弹出框的样式
preventOverflow boolean 防止浮动元素溢出
renderExtraFooter () => ReactNode 自定义页脚内容
renderListbox (listbox:ReactNode) => ReactNode 自定义渲染 Listbox
renderOption (label: ReactNode, item: Option) => ReactNode 自定义选项
renderOptionGroup (title: ReactNode, item: Option) => ReactNode 自定义选项组
renderValue (value: Value, items: any[],selected:ReactNode) => ReactNode 自定义被选中的选项
searchable boolean (true) 可以搜索
searchBy (keyword: string, label: ReactNode, item: Option) => boolean 自定义搜索规则
size 'lg' | 'md' | 'sm' | 'xs' ('md') 设置组件尺寸
sort (isGroup: boolean) => (a: any, b: any) => number 对选项排序
sticky boolean 把选项中已选择的选项置顶在最前面
toggleAs ElementType ('a') 为组件自定义元素类型
value Value 当前值（受控）
valueKey string ('value') 设置选项值在 data 中的 key
virtualized boolean 是否开启虚拟列表

Option 

interface Option<V> {
  /** The value of the option corresponds to the `valueKey` in the data. **/
  value: V;

  /** 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?: Option<V>[];

  /**
   * 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;
}

Placement 

type Placement =
  | 'bottomStart'
  | 'bottomEnd'
  | 'topStart'
  | 'topEnd'
  | 'leftStart'
  | 'leftEnd'
  | 'rightStart'
  | 'rightEnd'
  | 'auto'
  | 'autoVerticalStart'
  | 'autoVerticalEnd'
  | 'autoHorizontalStart'
  | 'autoHorizontalEnd';

ListProps 

interface ListProps {
  /**
   * Size of a item in the direction being windowed.
   */
  itemSize?: number | ((index: number) => number);

  /**
   * Scroll offset for initial render.
   */
  initialScrollOffset?: number;

  /**
   * Called when the items rendered by the list change.
   */
  onItemsRendered?: (props: ListOnItemsRenderedProps) => void;

  /**
   * Called when the list scroll positions changes, as a result of user scrolling or scroll-to method calls.
   */
  onScroll?: (props: ListOnScrollProps) => void;
}

Value 

type Value = (string | number)[];