AutoComplete 自动完成
输入框自动完成功能。
何时使用
需要自动完成时。
代码演示
基本使用
基本使用。通过 dataSource 设置自动完成的数据源
import React from 'react';
import ReactDOM from 'react-dom';
import { AutoComplete } from 'choerodon-ui';
function onSelect(value) {
console.log('onSelect', value);
}
class Complete extends React.Component {
state = {
dataSource: [],
}
handleSearch = (value) => {
this.setState({
dataSource: !value ? [] : [
value,
value + value,
value + value + value,
],
});
}
render() {
const { dataSource } = this.state;
return (
<AutoComplete
dataSource={dataSource}
style={{ width: 200 }}
自定义选项
也可以直接传 AutoComplete.Option
作为 AutoComplete
的 children
,而非使用 dataSource
。
import React from 'react';
import ReactDOM from 'react-dom';
import { AutoComplete } from 'choerodon-ui';
const Option = AutoComplete.Option;
class Complete extends React.Component {
state = {
result: [],
}
handleSearch = (value) => {
let result;
if (!value || value.indexOf('@') >= 0) {
result = [];
} else {
result = ['gmail.com', '163.com', 'qq.com'].map(domain => `${value}@${domain}`);
}
this.setState({ result });
}
render() {
const { result } = this.state;
const children = result.map((email) => {
return <Option key={email}>{email}</Option>;
});
return (
<AutoComplete
style={{ width: 200 }}
自定义输入组件
自定义输入组件。
import React from 'react';
import ReactDOM from 'react-dom';
import { AutoComplete, Input } from 'choerodon-ui';
const { TextArea } = Input;
function onSelect(value) {
console.log('onSelect', value);
}
class Complete extends React.Component {
state = {
dataSource: [],
};
handleSearch = value => {
this.setState({
dataSource: !value ? [] : [value, value + value, value + value + value],
});
};
handleKeyPress = ev => {
console.log('handleKeyPress', ev);
};
render() {
const { dataSource } = this.state;
return (
<AutoComplete
不区分大小写
不区分大小写的 AutoComplete
import React from 'react';
import ReactDOM from 'react-dom';
import { AutoComplete } from 'choerodon-ui';
const dataSource = ['Burns Bay Road', 'Downing Street', 'Wall Street'];
function Complete() {
return (
<AutoComplete
style={{ width: 200 }}
dataSource={dataSource}
placeholder="try to type `b`"
filterOption={(inputValue, option) => option.props.children.toUpperCase().indexOf(inputValue.toUpperCase()) !== -1}
/>
);
}
ReactDOM.render(<Complete />, document.getElementById('container'));
查询模式 - 确定类目
查询模式: 确定类目 示例。
import React from 'react';
import ReactDOM from 'react-dom';
import { Button, Input, AutoComplete } from 'choerodon-ui';
const Option = AutoComplete.Option;
const OptGroup = AutoComplete.OptGroup;
const dataSource = [{
title: '话题',
children: [{
title: 'AntDesign',
count: 10000,
}, {
title: 'AntDesign UI',
count: 10600,
}],
}, {
title: '问题',
children: [{
title: 'AntDesign UI 有多好',
count: 60100,
}, {
title: 'AntDesign 是啥',
count: 30010,
}],
}, {
title: '文章',
children: [{
title: 'AntDesign 是一个设计语言',
查询模式 - 不确定类目
查询模式: 不确定类目 示例。
import React from 'react';
import ReactDOM from 'react-dom';
import { Button, Input, AutoComplete } from 'choerodon-ui';
const Option = AutoComplete.Option;
function onSelect(value) {
console.log('onSelect', value);
}
function getRandomInt(max, min = 0) {
return Math.floor(Math.random() * (max - min + 1)) + min; // eslint-disable-line no-mixed-operators
}
function searchResult(query) {
return (new Array(getRandomInt(5))).join('.').split('.')
.map((item, idx) => ({
query,
category: `${query}${idx}`,
count: getRandomInt(200, 100),
}));
}
function renderOption(item) {
return (
<Option key={item.category} text={item.category}>
{item.query} 在
<a
href={`https://s.taobao.com/search?q=${item.query}`}
API
const dataSource = ['12345', '23456', '34567'];
<AutoComplete dataSource={dataSource} />
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
allowClear | 支持清除, 单选模式有效 | boolean | false |
autoFocus | 自动获取焦点 | boolean | false |
backfill | 使用键盘选择选项的时候把选中项回填到输入框中 | boolean | false |
children (自动完成的数据源) | 自动完成的数据源 | React.ReactElement | - |
children (自定义输入框) | 自定义输入框 | HTMLInputElement / HTMLTextAreaElement / React.ReactElement | <Input /> |
dataSource | 自动完成的数据源 | DataSourceItemType[] | |
defaultActiveFirstOption | 是否默认高亮第一个选项。 | boolean | true |
defaultValue | 指定默认选中的条目 | string|string[]|{ key: string, label: string|ReactNode }|Array<{ key: string, label: string|ReactNode}> | 无 |
disabled | 是否禁用 | boolean | false |
filterOption | 是否根据输入项进行筛选。当其为一个函数时,会接收 inputValue option 两个参数,当 option 符合筛选条件时,应返回 true ,反之则返回 false 。 | boolean or function(inputValue, option) | true |
optionLabelProp | 回填到选择框的 Option 的属性值,默认是 Option 的子元素。比如在子元素需要高亮效果时,此值可以设为 value 。 | string | children |
placeholder | 输入框提示 | string | - |
value | 指定当前选中的条目 | string|string[]|{ key: string, label: string|ReactNode }|Array<{ key: string, label: string|ReactNode }> | 无 |
onChange | 选中 option,或 input 的 value 变化时,调用此函数 | function(value) | 无 |
onSearch | 搜索补全项的时候调用 | function(value) | 无 |
onSelect | 被选中时调用,参数为选中项的 value 值 | function(value, option) | 无 |
方法
名称 | 描述 |
---|---|
blur() | 移除焦点 |
focus() | 获取焦点 |
当前内容版权归 Choerodon UI 或其关联方所有,如需对内容或内容相关联开源项目进行关注与资助,请访问 Choerodon UI .