Select 选择器

下拉选择器。

何时使用

  • 弹出一个下拉菜单给用户选择操作,用于代替原生的选择器,或者需要一个更优雅的多选器时。
  • 当选项少时(少于 5 项),建议直接将选项平铺,使用 Radio 是更好的选择。

代码演示

基本使用

基本使用。

Select选择器 - 图1

  1. import React from 'react';
  2. import ReactDOM from 'react-dom';
  3. import { Select } from 'choerodon-ui';
  4. const Option = Select.Option;
  5. function handleChange(value) {
  6. console.log(`selected ${value}`);
  7. }
  8. ReactDOM.render(
  9. <div>
  10. <Select
  11. label="Select"
  12. placeholder="Please Select"
  13. allowClear
  14. style={{ width: 200 }}
  15. onChange={handleChange}
  16. >
  17. <Option value="jack">Jack</Option>
  18. <Option value="lucy">Lucy</Option>
  19. <Option value="disabled" disabled>
  20. Disabled
  21. </Option>
  22. <Option value="Yiminghe">yiminghe</Option>
  23. </Select>
  24. <Select defaultValue="lucy" style={{ width: 200 }} allowClear disabled>
  25. <Option value="lucy">Lucy</Option>
  26. </Select>
  27. </div>,

带搜索框

展开后可对选项进行搜索。

Select选择器 - 图2

  1. import React from 'react';
  2. import ReactDOM from 'react-dom';
  3. import { Select } from 'choerodon-ui';
  4. const Option = Select.Option;
  5. ReactDOM.render(
  6. <Select
  7. style={{ width: 300 }}
  8. placeholder="Select a person"
  9. optionFilterProp="children"
  10. filterOption={(input, option) =>
  11. option.props.children.toLowerCase().indexOf(input.toLowerCase()) >= 0
  12. }
  13. filter
  14. >
  15. <Option value="jack">Jack</Option>
  16. <Option value="lucy">Lucy</Option>
  17. <Option value="tom">Tom</Option>
  18. <Option value="jack1">Jack1</Option>
  19. <Option value="lucy1">Lucy1</Option>
  20. <Option value="tom1">Tom1</Option>
  21. <Option value="jack2">Jack2</Option>
  22. <Option value="lucy2">Lucy2</Option>
  23. <Option value="tom2">Tom2</Option>
  24. </Select>,
  25. document.getElementById('container'),
  26. );

三种大小

三种大小的选择框,当 size 分别为 largesmall 时,输入框高度为 40px24px ,默认高度为 32px

Select选择器 - 图3

  1. import React from 'react';
  2. import ReactDOM from 'react-dom';
  3. import { Select, Radio } from 'choerodon-ui';
  4. const Option = Select.Option;
  5. const children = [];
  6. for (let i = 10; i < 36; i++) {
  7. children.push(<Option key={i.toString(36) + i}>{i.toString(36) + i}</Option>);
  8. }
  9. function handleChange(value) {
  10. console.log(`Selected: ${value}`);
  11. }
  12. class SelectSizesDemo extends React.Component {
  13. state = {
  14. size: 'default',
  15. };
  16. handleSizeChange = e => {
  17. this.setState({ size: e.target.value });
  18. };
  19. render() {
  20. const { size } = this.state;
  21. return (
  22. <div>
  23. <Radio.Group value={size} onChange={this.handleSizeChange}>
  24. <Radio.Button value="large">Large</Radio.Button>

多选

多选,从已有条目中选择(scroll the menu)

Select选择器 - 图4

  1. import React from 'react';
  2. import ReactDOM from 'react-dom';
  3. import { Select, Button } from 'choerodon-ui';
  4. const Option = Select.Option;
  5. const children = [];
  6. for (let i = 10; i < 36; i++) {
  7. children.push(<Option key={i}>{i.toString(36) + i}</Option>);
  8. }
  9. class SelectMulitpleDemo extends React.Component {
  10. state = {
  11. loading: true,
  12. options: [],
  13. };
  14. componentDidMount() {
  15. this.getOptions();
  16. }
  17. getOptions = () => {
  18. setTimeout(() => {
  19. this.setState({
  20. options: children,
  21. loading: false,
  22. });
  23. }, 3000);
  24. };

标签

tags select,随意输入的内容(scroll the menu)

Select选择器 - 图5

  1. import React from 'react';
  2. import ReactDOM from 'react-dom';
  3. import { Select } from 'choerodon-ui';
  4. import classNames from 'classnames';
  5. const Option = Select.Option;
  6. const children = [];
  7. for (let i = 10; i < 36; i++) {
  8. children.push(<Option key={i.toString(36) + i}>{i.toString(36) + i}</Option>);
  9. }
  10. function handleChange(value) {
  11. console.log(`selected ${value}`);
  12. }
  13. function handleRender(liNode, value) {
  14. console.log(value);
  15. return React.cloneElement(liNode, {
  16. className: classNames(liNode.props.className, 'choice-render'),
  17. });
  18. }
  19. ReactDOM.render(
  20. <Select
  21. mode="tags"
  22. style={{ width: '100%' }}
  23. label="标签用例"
  24. placeholder="tags"
  25. onChange={handleChange}

智能提示

输入框自动完成功能,下面是一个账号注册表单的例子。

推荐使用 AutoComplete 组件。

Select选择器 - 图6

  1. import React from 'react';
  2. import ReactDOM from 'react-dom';
  3. import { Select } from 'choerodon-ui';
  4. const Option = Select.Option;
  5. class App extends React.Component {
  6. state = {
  7. options: [],
  8. };
  9. handleChange = value => {
  10. let options;
  11. if (!value || value.indexOf('@') >= 0) {
  12. options = [];
  13. } else {
  14. options = ['gmail.com', '163.com', 'qq.com'].map(domain => {
  15. const email = `${value}@${domain}`;
  16. return <Option key={email}>{email}</Option>;
  17. });
  18. }
  19. this.setState({ options });
  20. };
  21. render() {
  22. // filterOption needs to be false,as the value is dynamically generated
  23. return (
  24. <Select
  25. mode="combobox"
  26. style={{ width: 200 }}

分组

OptGroup 进行选项分组。

Select选择器 - 图7

  1. import React from 'react';
  2. import ReactDOM from 'react-dom';
  3. import { Select } from 'choerodon-ui';
  4. const { Option, OptGroup } = Select;
  5. function handleChange(value) {
  6. console.log(`selected ${value}`);
  7. }
  8. ReactDOM.render(
  9. <Select defaultValue="lucy" style={{ width: 200 }} onChange={handleChange}>
  10. <OptGroup label="Manager">
  11. <Option value="jack">Jack</Option>
  12. <Option value="lucy">Lucy</Option>
  13. </OptGroup>
  14. <OptGroup label="Engineer">
  15. <Option value="Yiminghe">yiminghe</Option>
  16. </OptGroup>
  17. </Select>,
  18. document.getElementById('container'),
  19. );

联动

省市联动是典型的例子。

推荐使用 Cascader 组件。

Select选择器 - 图8

  1. import React from 'react';
  2. import ReactDOM from 'react-dom';
  3. import { Select } from 'choerodon-ui';
  4. const Option = Select.Option;
  5. const provinceData = ['Zhejiang', 'Jiangsu'];
  6. const cityData = {
  7. Zhejiang: ['Hangzhou', 'Ningbo', 'Wenzhou'],
  8. Jiangsu: ['Nanjing', 'Suzhou', 'Zhenjiang'],
  9. };
  10. class App extends React.Component {
  11. state = {
  12. cities: cityData[provinceData[0]],
  13. secondCity: cityData[provinceData[0]][0],
  14. };
  15. handleProvinceChange = value => {
  16. this.setState({
  17. cities: cityData[value],
  18. secondCity: cityData[value][0],
  19. });
  20. };
  21. onSecondCityChange = value => {
  22. this.setState({
  23. secondCity: value,
  24. });
  25. };

搜索框

自动补全和远程数据结合。

Select选择器 - 图9

  1. import React from 'react';
  2. import ReactDOM from 'react-dom';
  3. import { Select } from 'choerodon-ui';
  4. import jsonp from 'fetch-jsonp';
  5. import queryString from 'querystringify';
  6. const Option = Select.Option;
  7. let timeout;
  8. let currentValue;
  9. function fetch(value, callback) {
  10. if (timeout) {
  11. clearTimeout(timeout);
  12. timeout = null;
  13. }
  14. currentValue = value;
  15. function fake() {
  16. const str = queryString.stringify({
  17. code: 'utf-8',
  18. q: value,
  19. });
  20. jsonp(`https://suggest.taobao.com/sug?${str}`)
  21. .then(response => response.json())
  22. .then(d => {
  23. if (currentValue === value) {
  24. const result = d.result;
  25. const data = [];
  26. result.forEach(r => {

获得选项的文本

默认情况下 onChange 里只能拿到 value,如果需要拿到选中的节点文本 label,可以使用 labelInValue 属性。

选中项的 label 会被包装到 value 中传递给 onChange 等函数,此时 value 是一个对象。

Select选择器 - 图10

  1. import React from 'react';
  2. import ReactDOM from 'react-dom';
  3. import { Select } from 'choerodon-ui';
  4. const Option = Select.Option;
  5. function handleChange(value) {
  6. console.log(value); // { key: "lucy", label: "Lucy (101)" }
  7. }
  8. ReactDOM.render(
  9. <Select
  10. labelInValue
  11. defaultValue={{ key: 'lucy' }}
  12. style={{ width: 120 }}
  13. onChange={handleChange}
  14. >
  15. <Option value="jack">Jack (100)</Option>
  16. <Option value="lucy">Lucy (101)</Option>
  17. </Select>,
  18. document.getElementById('container'),
  19. );

自动分词

试下复制 露西,杰克 到输入框里。只在 tags 和 multiple 模式下可用。

Select选择器 - 图11

  1. import React from 'react';
  2. import ReactDOM from 'react-dom';
  3. import { Select } from 'choerodon-ui';
  4. const Option = Select.Option;
  5. const children = [];
  6. for (let i = 10; i < 36; i++) {
  7. children.push(<Option key={i.toString(36) + i}>{i.toString(36) + i}</Option>);
  8. }
  9. function handleChange(value) {
  10. console.log(`selected ${value}`);
  11. }
  12. ReactDOM.render(
  13. <Select mode="tags" style={{ width: '100%' }} onChange={handleChange} tokenSeparators={[',']}>
  14. {children}
  15. </Select>,
  16. document.getElementById('container'),
  17. );

图标下拉框

图标下拉框。

Select选择器 - 图12

  1. import React from 'react';
  2. import ReactDOM from 'react-dom';
  3. import { IconSelect } from 'choerodon-ui';
  4. ReactDOM.render(
  5. <IconSelect showAll style={{ width: '300px' }} defaultValue={['root']} />,
  6. document.getElementById('container'));

API

  1. <Select>
  2. <Option value="lucy">lucy</Option>
  3. </Select>

Select props

参数说明类型默认值
allowClear支持清除booleanfalse
autoFocus默认获取焦点booleanfalse
combobox输入框自动提示模式(2.9 之后废弃,请使用 modebooleanfalse
defaultActiveFirstOption是否默认高亮第一个选项。booleantrue
defaultValue指定默认选中的条目string|string[]|number|number[]-
disabled是否禁用booleanfalse
dropdownClassName下拉菜单的 className 属性string-
dropdownMatchSelectWidth下拉菜单和选择器同宽booleantrue
dropdownStyle下拉菜单的 style 属性object-
filterOption是否根据输入项进行筛选。当其为一个函数时,会接收 inputValue option 两个参数,当 option 符合筛选条件时,应返回 true,反之则返回 falseboolean or function(inputValue, option)true
firstActiveValue默认高亮的选项string|string[]-
getPopupContainer菜单渲染父节点。默认渲染到 body 上,如果你遇到菜单滚动定位问题,试试修改为滚动的区域,并相对其定位。示例Function(triggerNode)() => document.body
labelInValue是否把每个选项的 label 包装到 value 中,会把 Select 的 value 类型从 string 变为 {key: string, label: ReactNode} 的格式booleanfalse
maxTagCount最多显示多少个 tagnumber-
maxTagPlaceholder隐藏 tag 时显示的内容ReactNode/function(omittedValues)-
mode设置 Select 的模式(2.9 之后支持)‘multiple’ | ‘tags’ | ‘combobox’-
multiple支持多选(2.9 之后废弃,请使用 modebooleanfalse
notFoundContent当下拉列表为空时显示的内容string‘Not Found’
optionFilterProp搜索时过滤对应的 option 属性,如设置为 children 表示对内嵌内容进行搜索stringvalue
optionLabelProp回填到选择框的 Option 的属性值,默认是 Option 的子元素。比如在子元素需要高亮效果时,此值可以设为 valuestringchildren (combobox 模式下为 value
placeholder选择框默认文字string-
showArrow是否显示下拉小箭头booleantrue
size选择框大小,可选 large smallstringdefault
tags可以把随意输入的条目作为 tag,输入项不需要与下拉选项匹配(2.9 之后废弃,请使用 modebooleanfalse
tokenSeparators在 tags 和 multiple 模式下自动分词的分隔符string[]
value指定当前选中的条目string|string[]|number|number[]-
onBlur失去焦点的时回调function-
onChange选中 option,或 input 的 value 变化(combobox 模式下)时,调用此函数function(value, option:Option/Array<Option>)-
onDeselect取消选中时调用,参数为选中项的 value (或 key) 值,仅在 multiple 或 tags 模式下生效function(value,option:Option)-
onFocus获得焦点时回调function-
onMouseEnter鼠标移入时回调function-
onMouseLeave鼠标移出时回调function-
onPopupScroll下拉列表滚动时的回调function-
onPopupFocus下拉列表获得焦点时的回调function-
onSearch文本框值变化时回调function(value: string)
onSelect被选中时调用,参数为选中项的 value (或 key) 值function(value, option:Option)-
showCheckAll是否显示下拉菜单的全选按钮booleantrue
footer下拉菜单底部内容string| ReactNode-
choiceRender仅适用于tags 函数返回值为 Select value展示内容function(liDom, value)-
filter下拉框顶部查询框booleanfalse
filterValue下拉框顶部查询框值string-
onFilterChange下拉框顶部查询框值改变回调function(value)-
loading数据是否加载中boolean|object ([更多]
choiceRemove仅适用于tags multiple 是否可以直接删除valueboolean | function(value)true | (value) => true
onChoiceRemove仅适用于tags multiple 删除每一个值的回调function(value)-

注意,如果发现下拉菜单跟随页面滚动,或者需要在其他弹层中触发 Select,请尝试使用 getPopupContainer={triggerNode => triggerNode.parentNode} 将下拉弹层渲染节点固定在触发器的父元素中。

Select Methods

名称说明
blur()取消焦点
focus()获取焦点

Option props

参数说明类型默认值
disabled是否禁用booleanfalse
key和 value 含义一致。如果 React 需要你设置此项,此项值与 value 的值相同,然后可以省略 value 设置string
title选中该 Option 后,Select 的 titlestring-
value默认根据此属性值进行筛选string|number-

OptGroup props

参数说明类型默认值
keystring-
label组名string|React.Element