Select选择器

下拉选择器。

何时使用

  • 弹出一个下拉菜单给用户选择操作,用于代替原生的选择器,或者需要一个更优雅的多选器时。

  • 当选项少时(少于 5 项),建议直接将选项平铺,使用 Radio 是更好的选择。

代码演示

Select 选择器 - 图1

基本使用

基本使用。

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

Select 选择器 - 图2

三种大小

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

  1. import { Select, Radio } from 'choerodon-ui';
  2. const Option = Select.Option;
  3. const children = [];
  4. for (let i = 10; i < 36; i++) {
  5. children.push(<Option key={i.toString(36) + i}>{i.toString(36) + i}</Option>);
  6. }
  7. function handleChange(value) {
  8. console.log(`Selected: ${value}`);
  9. }
  10. class SelectSizesDemo extends React.Component {
  11. state = {
  12. size: 'default',
  13. };
  14. handleSizeChange = e => {
  15. this.setState({ size: e.target.value });
  16. };
  17. render() {
  18. const { size } = this.state;
  19. return (
  20. <div>
  21. <Radio.Group value={size} onChange={this.handleSizeChange}>
  22. <Radio.Button value="large">Large</Radio.Button>
  23. <Radio.Button value="default">Default</Radio.Button>
  24. <Radio.Button value="small">Small</Radio.Button>
  25. </Radio.Group>
  26. <br />
  27. <br />
  28. <Select size={size} defaultValue="a1" onChange={handleChange} style={{ width: 200 }}>
  29. {children}
  30. </Select>
  31. <br />
  32. <Select
  33. mode="combobox"
  34. size={size}
  35. defaultValue="a1"
  36. onChange={handleChange}
  37. style={{ width: 200 }}
  38. >
  39. {children}
  40. </Select>
  41. <br />
  42. <Select
  43. mode="multiple"
  44. size={size}
  45. placeholder="Please select"
  46. defaultValue={['a10', 'c12']}
  47. onChange={handleChange}
  48. style={{ width: '100%' }}
  49. >
  50. {children}
  51. </Select>
  52. <br />
  53. <Select
  54. mode="tags"
  55. size={size}
  56. placeholder="Please select"
  57. defaultValue={['a10', 'c12']}
  58. onChange={handleChange}
  59. style={{ width: '100%' }}
  60. >
  61. {children}
  62. </Select>
  63. </div>
  64. );
  65. }
  66. }
  67. ReactDOM.render(<SelectSizesDemo />, mountNode);
  1. .code-box-demo .c7n-select {
  2. margin: 0 8px 10px 0;
  3. }
  4. #components-select-demo-search-box .code-box-demo .c7n-select {
  5. margin: 0;
  6. }

Select 选择器 - 图3

标签

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

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

Select 选择器 - 图4

分组

OptGroup 进行选项分组。

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

Select 选择器 - 图5

搜索框

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

  1. import { Select } from 'choerodon-ui';
  2. import jsonp from 'fetch-jsonp';
  3. import queryString from 'querystringify';
  4. const Option = Select.Option;
  5. let timeout;
  6. let currentValue;
  7. function fetch(value, callback) {
  8. if (timeout) {
  9. clearTimeout(timeout);
  10. timeout = null;
  11. }
  12. currentValue = value;
  13. function fake() {
  14. const str = queryString.stringify({
  15. code: 'utf-8',
  16. q: value,
  17. });
  18. jsonp(`https://suggest.taobao.com/sug?${str}`)
  19. .then(response => response.json())
  20. .then(d => {
  21. if (currentValue === value) {
  22. const result = d.result;
  23. const data = [];
  24. result.forEach(r => {
  25. data.push({
  26. value: r[0],
  27. text: r[0],
  28. });
  29. });
  30. callback(data);
  31. }
  32. });
  33. }
  34. timeout = setTimeout(fake, 300);
  35. }
  36. class SearchInput extends React.Component {
  37. state = {
  38. data: [],
  39. value: '',
  40. };
  41. handleChange = value => {
  42. this.setState({ value });
  43. fetch(value, data => this.setState({ data }));
  44. };
  45. render() {
  46. const options = this.state.data.map(d => <Option key={d.value}>{d.text}</Option>);
  47. return (
  48. <Select
  49. mode="combobox"
  50. value={this.state.value}
  51. placeholder={this.props.placeholder}
  52. style={this.props.style}
  53. defaultActiveFirstOption={false}
  54. showArrow={false}
  55. filterOption={false}
  56. onChange={this.handleChange}
  57. >
  58. {options}
  59. </Select>
  60. );
  61. }
  62. }
  63. ReactDOM.render(<SearchInput placeholder="input search text" style={{ width: 200 }} />, mountNode);

Select 选择器 - 图6

自动分词

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

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

Select 选择器 - 图7

带搜索框

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

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

Select 选择器 - 图8

多选

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

  1. import { Select, Button } from 'choerodon-ui';
  2. const Option = Select.Option;
  3. const children = [];
  4. for (let i = 10; i < 36; i++) {
  5. children.push(<Option key={i}>{i.toString(36) + i}</Option>);
  6. }
  7. class SelectMulitpleDemo extends React.Component {
  8. state = {
  9. loading: true,
  10. options: [],
  11. };
  12. componentDidMount() {
  13. this.getOptions();
  14. }
  15. getOptions = () => {
  16. setTimeout(() => {
  17. this.setState({
  18. options: children,
  19. loading: false,
  20. });
  21. }, 3000);
  22. };
  23. handleChoiceRemove = value => {
  24. return value >= 15;
  25. };
  26. render() {
  27. const { options, loading } = this.state;
  28. return (
  29. <Select
  30. mode="multiple"
  31. style={{ width: '100%' }}
  32. label="多选用例"
  33. optionFilterProp="children"
  34. footer={
  35. <Button funcType="raised" type="primary">
  36. 这里是footer
  37. </Button>
  38. }
  39. loading={loading}
  40. choiceRemove={this.handleChoiceRemove}
  41. filter
  42. allowClear
  43. >
  44. {options}
  45. </Select>
  46. );
  47. }
  48. }
  49. ReactDOM.render(<SelectMulitpleDemo />, mountNode);

Select 选择器 - 图9

智能提示

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

推荐使用 AutoComplete 组件。

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

Select 选择器 - 图10

联动

省市联动是典型的例子。

推荐使用 Cascader 组件。

  1. import { Select } from 'choerodon-ui';
  2. const Option = Select.Option;
  3. const provinceData = ['Zhejiang', 'Jiangsu'];
  4. const cityData = {
  5. Zhejiang: ['Hangzhou', 'Ningbo', 'Wenzhou'],
  6. Jiangsu: ['Nanjing', 'Suzhou', 'Zhenjiang'],
  7. };
  8. class App extends React.Component {
  9. state = {
  10. cities: cityData[provinceData[0]],
  11. secondCity: cityData[provinceData[0]][0],
  12. };
  13. handleProvinceChange = value => {
  14. this.setState({
  15. cities: cityData[value],
  16. secondCity: cityData[value][0],
  17. });
  18. };
  19. onSecondCityChange = value => {
  20. this.setState({
  21. secondCity: value,
  22. });
  23. };
  24. render() {
  25. const provinceOptions = provinceData.map(province => (
  26. <Option key={province}>{province}</Option>
  27. ));
  28. const cityOptions = this.state.cities.map(city => <Option key={city}>{city}</Option>);
  29. return (
  30. <div>
  31. <Select
  32. defaultValue={provinceData[0]}
  33. style={{ width: 90 }}
  34. onChange={this.handleProvinceChange}
  35. >
  36. {provinceOptions}
  37. </Select>
  38. <Select
  39. value={this.state.secondCity}
  40. style={{ width: 90 }}
  41. onChange={this.onSecondCityChange}
  42. >
  43. {cityOptions}
  44. </Select>
  45. </div>
  46. );
  47. }
  48. }
  49. ReactDOM.render(<App />, mountNode);

Select 选择器 - 图11

获得选项的文本

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

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

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

Select 选择器 - 图12

图标下拉框

图标下拉框。

  1. import { IconSelect } from 'choerodon-ui';
  2. ReactDOM.render(
  3. <IconSelect showAll style={{ width: '300px' }} defaultValue={['root']} />,
  4. mountNode);

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