输入类

选择器

用户可以通过 Select 选择器从一个选项集合中去选中一个或多个选项,并呈现最终选择结果

代码演示

如何引入

import { Select } from '@fibrous/semi-ui-react';
const Option = Select.Option;

基本使用

每个 Option 标签都必须声明 value 属性,Option 的 children 或 label 将会被渲染至下拉列表中





代码
import { Select } from '@fibrous/semi-ui-react';

export default function SelectDemo() {
    return (
        <>
            <Select aria-label="业务线" defaultValue="douyin" style={{ width: 120 }}>
                <Select.Option value="douyin">抖音</Select.Option>
                <Select.Option value="ulikecam">轻颜相机</Select.Option>
                <Select.Option value="jianying" disabled>
                    剪映
                </Select.Option>
                <Select.Option value="xigua">西瓜视频</Select.Option>
            </Select>
            <br />
            <br />
            <Select aria-label="业务线" defaultValue="douyin" disabled style={{ width: 120 }}>
                <Select.Option value="douyin">抖音</Select.Option>
                <Select.Option value="ulikecam">轻颜相机</Select.Option>
            </Select>
            <br />
            <br />
            <Select aria-label="业务线" placeholder="请选择业务线" style={{ width: 120 }}>
                <Select.Option value="douyin">抖音</Select.Option>
                <Select.Option value="ulikecam">轻颜相机</Select.Option>
                <Select.Option value="jianying" disabled>
                    剪映
                </Select.Option>
                <Select.Option value="xigua">西瓜视频</Select.Option>
            </Select>
        </>
    );
}

以数组形式传入 Option

可以直接通过optionList传入一个对象数组,每个对象必须包含 value/label 属性(当然其他属性也可以通过此方式传入)

代码
import { Select } from '@fibrous/semi-ui-react';

export default function SelectDemo() {
    const list = [
        { value: 'douyin', label: '抖音', otherKey: 0 },
        { value: 'ulikecam', label: '轻颜相机', disabled: true, otherKey: 1 },
        { value: 'jianying', label: '剪映', otherKey: 2 },
        { value: 'toutiao', label: '今日头条', otherKey: 3 },
    ];
    return <Select aria-label="业务线" placeholder="请选择业务线" style={{ width: 180 }} optionList={list} />;
}

多选

自 v2.28后,select 的选择器会自带 maxHeight 270,内容超出后可以通过垂直滚动查看。

配置multiple属性,可以支持多选

配置 maxTagCount 可以限制已选项展示的数量,超出部分将以+N 的方式展示

配置 ellipsisTrigger (>= v2.28.0) 对溢出部分的 tag 做自适应处理,当宽度不足时,最后一个tag内容作截断处理。开启该功能后会有一定性能损耗,不推荐在大表单场景下使用

配置 expandRestTagsOnClick (>= v2.28.0) 可以在设置 maxTagCount 情况下通过点击展示全剩余的tag

使用 showRestTagsPopover (>= v2.22.0) 可以设置在超出 maxTagCount 后,hover +N 是否显示 Popover,默认为 false。并且,还可以在 restTagsPopoverProps 属性中配置 Popover。

配置 max 属性可限制最大可选的数量,超出最大限制数量后无法选中,同时会触发onExceed回调







代码
import { Select, Toast } from '@fibrous/semi-ui-react';

export default function SelectDemo() {
    return (
        <>
            <Select aria-label="Select 示例" multiple style={{ width: '320px' }} defaultValue={['douyin', 'ulikecam']}>
                <Select.Option value="douyin">抖音</Select.Option>
                <Select.Option value="ulikecam">轻颜相机</Select.Option>
                <Select.Option value="jianying">剪映</Select.Option>
                <Select.Option value="xigua">西瓜视频</Select.Option>
            </Select>
            <br />
            <br />
            <Select aria-label="Select 示例" multiple maxTagCount={2} showRestTagsPopover restTagsPopoverProps={{ position: 'top' }} style={{ width: '320px' }} defaultValue={['douyin', 'ulikecam', 'jianying']}>
                <Select.Option value="douyin">抖音</Select.Option>
                <Select.Option value="ulikecam">轻颜相机</Select.Option>
                <Select.Option value="jianying">剪映</Select.Option>
                <Select.Option value="xigua">西瓜视频</Select.Option>
            </Select>

            <br />
            <br />
            <Select aria-label="Select 示例" multiple style={{ width: '320px' }} defaultValue={['douyin']} max={2} onExceed={() => Toast.warning('最多只允许选择两项')}>
                <Select.Option value="douyin">抖音</Select.Option>
                <Select.Option value="ulikecam">轻颜相机</Select.Option>
                <Select.Option value="jianying">剪映</Select.Option>
                <Select.Option value="xigua">西瓜视频</Select.Option>
            </Select>
            <br />
            <br />
            <Select aria-label="Select 示例" multiple maxTagCount={2} showRestTagsPopover restTagsPopoverProps={{ position: 'top' }} style={{ width: '220px' }} defaultValue={['xigua', 'ulikecam', 'jianying', 'douyin']} ellipsisTrigger expandRestTagsOnClick>
                <Select.Option value="douyin">抖音</Select.Option>
                <Select.Option value="ulikecam">轻颜相机</Select.Option>
                <Select.Option value="jianying">剪映</Select.Option>
                <Select.Option value="xigua">西瓜视频</Select.Option>
            </Select>
        </>
    );
}

分组

用 OptGroup 进行分组(分组功能仅支持通过 jsx 方式声明 children 使用,不支持 optionList 方式传入)

代码
import { Select } from '@fibrous/semi-ui-react';

export default function SelectDemo() {
    return (
        <Select aria-label="地区" placeholder="" style={{ width: 180 }} filter>
            <Select.OptGroup label="Asia">
                <Select.Option value="a-1">China</Select.Option>
                <Select.Option value="a-2">Korea</Select.Option>
            </Select.OptGroup>
            <Select.OptGroup label="Europe">
                <Select.Option value="b-1">Germany</Select.Option>
                <Select.Option value="b-2">France</Select.Option>
            </Select.OptGroup>
            <Select.OptGroup label="South America">
                <Select.Option value="c-1">Peru</Select.Option>
            </Select.OptGroup>
        </Select>
    );
}
代码
import { Select } from '@fibrous/semi-ui-react';

export default function SelectDemo() {
    const data = [
        {
            label: 'Asia',
            children: [
                { value: 'a-1', label: 'China' },
                { value: 'a-2', label: 'Korea' },
            ],
        },
        {
            label: 'Europe',
            children: [
                { value: 'b-1', label: 'Germany' },
                { value: 'b-2', label: 'France' },
            ],
        },
        {
            label: 'South America',
            children: [{ value: 'c-1', label: 'Peru' }],
        },
    ];
    return (
        <Select aria-label="地区" placeholder="" style={{ width: 180 }} filter>
            {data.map((group, index) => (
                <Select.OptGroup label={group.label} key={`${index}-${group.label}`}>
                    {group.children.map((option, index2) => (
                        <Select.Option value={option.value} key={`${index2}-${group.label}`}>
                            {option.label}
                        </Select.Option>
                    ))}
                </Select.OptGroup>
            ))}
        </Select>
    );
}

不同尺寸

通过 Size 控制选择器的大小尺寸: small / default / large





代码
import { Select } from '@fibrous/semi-ui-react';

export default function SelectDemo() {
    return (
        <>
            <Select aria-label="small" placeholder="请选择业务线" style={{ width: '180px' }} size="small">
                <Select.Option value="ulikecam">轻颜相机</Select.Option>
            </Select>
            <br />
            <br />
            <Select aria-label="default" placeholder="请选择业务线" style={{ width: '180px' }}>
                <Select.Option value="ulikecam">轻颜相机</Select.Option>
            </Select>
            <br />
            <br />
            <Select aria-label="large" placeholder="请选择业务线" style={{ width: '180px' }} size="large">
                <Select.Option value="ulikecam">轻颜相机</Select.Option>
            </Select>
        </>
    );
}

不同校验状态样式

validateStatus: default / warning / error
仅影响背景颜色等样式表现





代码
import { Select } from '@fibrous/semi-ui-react';

export default function SelectDemo() {
    return (
        <>
            <Select aria-label="default" style={{ width: '180px' }}>
                <Select.Option value="ulikecam">轻颜相机</Select.Option>
            </Select>
            <br />
            <br />
            <Select aria-label="warning" style={{ width: '180px' }} validateStatus="warning">
                <Select.Option value="ulikecam">轻颜相机</Select.Option>
            </Select>
            <br />
            <br />
            <Select aria-label="error" style={{ width: '180px' }} validateStatus="error">
                <Select.Option value="ulikecam">轻颜相机</Select.Option>
            </Select>
        </>
    );
}

配置前缀、后缀、清除按钮

  • 可以通过prefix传入选择框前缀,通过suffix传入选择框后缀,可以为文本或者 ReactNode
    当 prefix、suffix 传入的内容为文本或者 Icon 时,会自动带上左右间隔,若为自定义 ReactNode,则左右间隔为 0
  • 通过showClear控制清除按钮是否展示
  • 通过showArrow控制右侧下拉箭头是否展示


代码
import { IconVigoLogo, IconGift } from '@fibrous/semi-icons-react';
import { Select } from '@fibrous/semi-ui-react';

export default function SelectDemo() {
    return (
        <>
            <Select aria-label="Select 示例" style={{ width: '320px' }} defaultValue="ulikecam" prefix={<IconVigoLogo />} showClear>
                <Select.Option value="douyin">抖音</Select.Option>
                <Select.Option value="ulikecam">轻颜相机</Select.Option>
                <Select.Option value="jianying">剪映</Select.Option>
                <Select.Option value="xigua">西瓜视频</Select.Option>
            </Select>
            <br />
            <br />
            <Select aria-label="Select 示例" style={{ width: '320px' }} defaultValue="ulikecam" prefix={<IconVigoLogo />} suffix={<IconGift />} showArrow={false}>
                <Select.Option value="douyin">抖音</Select.Option>
                <Select.Option value="ulikecam">轻颜相机</Select.Option>
                <Select.Option value="jianying">剪映</Select.Option>
                <Select.Option value="xigua">西瓜视频</Select.Option>
            </Select>
        </>
    );
}

在顶部/底部渲染附加项

我们在弹出层顶部、底部分别预留了插槽,当你需要在弹出层中添加自定义 node 时
可以通过innerBottomSlot或者outerBottomSlot传入,自定义 node 将会被渲染在弹出层底部;可以通过innerTopSlot或者outerTopSlot传入,自定义 node 将会被渲染在弹出层顶部。

  • innerTopSlot 和 innerBottomSlot将会被渲染在 optionList 内部,当滚动到 optionList 顶部/底部时展现
  • outerTopSlot 和 outerBottomSlot将会被渲染为与 optionList 平级,无论 optionList 是否滚动,都会始终展现

outerBottomSlot:

innerBottomSlot:

代码
import { Select } from '@fibrous/semi-ui-react';

export default function SelectDemo() {
    let innerSlotStyle = {
        backgroundColor: 'var(--color-white)',
        height: '36px',
        display: 'flex',
        alignItems: 'center',
        cursor: 'pointer',
        paddingLeft: 32,
        borderTop: '1px solid var(--semi-color-border)',
        borderRadius: '0 0 6px 6px',
        color: 'var(--semi-color-link)',
    };
    let innerSlotNode = <div style={innerSlotStyle}>点击加载更多</div>;
    let outSlotStyle = {
        backgroundColor: 'var(--semi-color-fill-0)',
        height: '36px',
        display: 'flex',
        paddingLeft: 32,
        color: 'var(--semi-color-link)',
        alignItems: 'center',
        cursor: 'pointer',
        borderTop: '1px solid var(--semi-color-border)',
        borderRadius: '0 0 6px 6px',
    };
    let outSlotNode = (
        <div style={outSlotStyle}>
            <span style={{ color: 'var(--semi-color-link)' }}>未找到应用?</span>
        </div>
    );

    return (
        <div>
            <p>outerBottomSlot:</p>
            <Select aria-label="outerBottomSlot" style={{ width: 300 }} dropdownStyle={{ width: 180 }} maxHeight={150} outerBottomSlot={outSlotNode} placeholder="自定义外侧底部slot,始终显示" defaultOpen autoAdjustOverflow={false} position="bottom">
                <Select.Option value="douyin">抖音</Select.Option>
                <Select.Option value="ulikecam">轻颜相机</Select.Option>
                <Select.Option value="jianying">剪映</Select.Option>
                <Select.Option value="duoshan">多闪</Select.Option>
                <Select.Option value="xigua">西瓜视频</Select.Option>
            </Select>
            <p style={{ marginTop: 200 }}>innerBottomSlot:</p>
            <Select aria-label="innerBottomSlot" style={{ width: 300 }} dropdownStyle={{ width: 180 }} maxHeight={150} innerBottomSlot={innerSlotNode} placeholder="自定义内侧底部slot,滚动至底部显示">
                <Select.Option value="douyin">抖音</Select.Option>
                <Select.Option value="ulikecam">轻颜相机</Select.Option>
                <Select.Option value="jianying">剪映</Select.Option>
                <Select.Option value="duoshan">多闪</Select.Option>
                <Select.Option value="xigua">西瓜视频</Select.Option>
            </Select>
        </div>
    );
}

通过 outerTopSlot 将内容插入顶部插槽

代码
import { useState } from 'react';
import { RadioGroup, Select } from '@fibrous/semi-ui-react';

interface Item {
    value: string;
    label: string;
}

export default function SelectDemo() {
    const list: Record<string, Item[]> = {
        component: [
            { value: 'select', label: '选择器' },
            { value: 'tabs', label: '标签' },
            { value: 'avatar', label: '头像' },
            { value: 'button', label: '按钮' },
        ],
        design: [
            { value: 'color', label: '颜色' },
            { value: 'dark', label: '暗色模式' },
            { value: 'icon', label: '图标' },
            { value: 'font', label: '字体' },
        ],
        feedback: [
            { value: 'faq', label: '常见问题' },
            { value: 'join', label: '加入用户群' },
            { value: 'hornbill', label: '犀鸟反馈问题' },
        ],
    };

    const [key, setKey] = useState('component');
    const [value, setValue] = useState<Item | undefined>({ value: 'faq', label: '常见问题' });

    const categoryWrapper = {
        padding: '8px 12px',
        borderBottom: '0.5px solid var(--semi-color-border)',
    };
    const categoryOptions = [
        { value: 'component', label: '组件' },
        { value: 'design', label: '设计' },
        { value: 'feedback', label: '反馈' },
    ];

    // The radio group switches with arrow keys, so categories need no tabpanel association
    const outerTopSlotNode = (
        <div style={categoryWrapper}>
            <RadioGroup type="button" buttonSize="small" aria-label="选项分类" options={categoryOptions} value={key} onChange={(e) => setKey(e.target.value)} />
        </div>
    );
    return <Select aria-label="选项" defaultOpen autoAdjustOverflow={false} value={value} onChangeWithObject onChange={(obj) => setValue(obj)} style={{ width: 200 }} outerTopSlot={outerTopSlotNode} optionList={list[key]} />;
}

受控组件

传入 value 时 Select 为受控组件,所选中的值完全由 value 决定。

代码
import { useState } from 'react';
import { Select } from '@fibrous/semi-ui-react';

export default function SelectDemo() {
    let [value, setValue] = useState<string | undefined>('xigua');
    return (
        <>
            <Select aria-label="业务线" value={value} style={{ width: '300px' }} onChange={setValue} placeholder="受控的Select">
                <Select.Option value="douyin">抖音</Select.Option>
                <Select.Option value="ulikecam">轻颜相机</Select.Option>
                <Select.Option value="jianying">剪映</Select.Option>
                <Select.Option value="xigua">西瓜视频</Select.Option>
            </Select>
        </>
    );
}

动态修改 Options

如果需要动态更新 Options,应该使用受控的 value



代码
import { useState } from 'react';
import { Select, Button } from '@fibrous/semi-ui-react';

export default function SelectDemo() {
    let [options, setOptions] = useState([1, 2, 3, 4]);
    function add() {
        let length = Math.ceil(Math.random() * 10);
        let newOptions = Array.from({ length }, (_v, i) => i + 1);
        setOptions(newOptions);
    }
    return (
        <>
            <Select aria-label="数字" style={{ width: '180px' }} placeholder="请选择" value={4}>
                {options.map((option) => (
                    <Select.Option value={option} key={option}>
                        {option}
                    </Select.Option>
                ))}
            </Select>
            <br />
            <br />
            <Button onClick={add}>changeOptions Dynamic</Button>
        </>
    );
}

联动

使用受控 value,实现不同 Select 之间的联动。如果是带有层级关系的复杂联动建议直接使用Cascader组件

代码
import { useState } from 'react';
import { Select } from '@fibrous/semi-ui-react';

export default function SelectDemo() {
    const provinces = ['四川', '广东'];
    const maps: Record<string, string[]> = {
        四川: ['成都', '都江堰'],
        广东: ['广州', '深圳', '东莞'],
    };

    const [province, setProvince] = useState(provinces[0]);
    const citys = maps[province];
    const [city, setCity] = useState<string | undefined>(citys[0]);

    const provinceChange = (newProvince?: string) => {
        if (!newProvince) {
            return;
        }
        setProvince(newProvince);
        setCity(maps[newProvince][0]);
    };
    const cityChange = (newCity?: string) => setCity(newCity);

    return (
        <>
            <Select aria-label="省份" style={{ width: '150px', margin: '10px' }} onChange={provinceChange} value={province}>
                {provinces.map((pro) => (
                    <Select.Option value={pro} key={pro}>
                        {pro}
                    </Select.Option>
                ))}
            </Select>
            <Select aria-label="城市" style={{ width: '150px', margin: '10px' }} value={city} onChange={cityChange}>
                {citys.map((c) => (
                    <Select.Option value={c} key={c}>
                        {c}
                    </Select.Option>
                ))}
            </Select>
        </>
    );
}

开启搜索

将 filter 置为 true,开启搜索能力。默认搜索策略将为 input 输入值与 option 的 label 值进行 include 对比
默认情况下,多选选中后会自动清空搜索关键字。若你希望保留,可以通过 autoClearSearchValue 设为 false 关闭默认行为(v2.3 后提供)

搜索框位置

默认搜索框展示于 Select 的 Trigger 触发器上。通过 searchPosition 可以指定不同的位置,可选 dropdown、trigger。 在 v2.61.0后提供若希望定制位于 dropdown 中的 Input 搜索框的 placeholder,可以通过 searchPlaceholder 控制
若 searchPosition 值为 trigger,当showClear=true 时,点击Trigger区域的清空按钮,将同时清空已选项以及搜索框中的文本
若 searchPosition 值为 dropdown,当showClear=true 时,点击Trigger区域清空按钮,仅清空已选项。点击搜索框中的清空按钮,仅清空搜索文本



代码
import { Select } from '@fibrous/semi-ui-react';

export default function SelectDemo() {
    return (
        <>
            <Select aria-label="单选" filter searchPosition="dropdown" style={{ width: 200 }} defaultValue="ulikecam" placeholder="我的搜索框在下拉菜单中" searchPlaceholder="带搜索功能的单选">
                <Select.Option value="douyin">抖音</Select.Option>
                <Select.Option value="ulikecam">轻颜相机</Select.Option>
                <Select.Option value="jianying">剪映</Select.Option>
                <Select.Option value="xigua">西瓜视频</Select.Option>
            </Select>
            <br />
            <br />
            <Select aria-label="多选" filter searchPosition="dropdown" multiple style={{ width: 300 }} defaultValue={['semi-1']} placeholder="我的搜索框在下拉菜单中" searchPlaceholder="带搜索功能的多选" autoClearSearchValue={false}>
                <Select.Option value="semi-0">Semi-0</Select.Option>
                <Select.Option value="semi-1">Semi-1</Select.Option>
                <Select.Option value="semi-2">Semi-2</Select.Option>
                <Select.Option value="semi-3">Semi-3</Select.Option>
                <Select.Option value="semi-4">Semi-4</Select.Option>
            </Select>
        </>
    );
}

远程搜索

带有远程搜索,防抖请求,加载状态的多选示例
通过filter开启搜索能力
将remote设置为 true 关闭对当前数据的筛选过滤通过动态更新optionList更新下拉菜单中的备选项

使用受控的 value 属性

自定义搜索逻辑

可以将 filter 置为自定义函数,定制你想要的搜索策略
如下例子,选项 label 值都是大写,默认的检索策略是字符串 include 对比,会区分大小写。
通过传入自定义 filter 函数,检索时输入小写字母也能搜到相应内容。

代码
import { Select, type SelectOptionProps } from '@fibrous/semi-ui-react';

export default function SelectDemo() {
    function searchLabel(sugInput: string, option: SelectOptionProps) {
        let label = String(option.label).toUpperCase();
        let sug = sugInput.toUpperCase();
        return label.includes(sug);
    }
    return (
        <Select aria-label="业务线" filter={searchLabel} style={{ width: '180px' }} placeholder="try douyin">
            <Select.Option value="douyin">douyin</Select.Option>
            <Select.Option value="ulikecam">HOTSOON</Select.Option>
            <Select.Option value="jianying">PIPIXIA</Select.Option>
            <Select.Option value="xigua">XIGUA</Select.Option>
        </Select>
    );
}

自定义已选项标签渲染

默认情况下,选中选项后会将 option.label 或 option.children 的内容回填到选择框中
但你可以通过 renderSelectedItem 自定义选择框中已选项标签的渲染结构

  • 单选时 renderSelectedItem(optionNode:object) => content:ReactNode
  • 多选时 renderSelectedItem(optionNode:object, { index:number, onClose:function }) => { isRenderInTag:bool, content:ReactNode }
    • isRenderInTag 为 true 时,会自动将 content 包裹在 Tag 中渲染(带有背景色以及关闭按钮)
    • isRenderInTag 为 false 时,将直接渲染返回的 content
代码
import { Select, Avatar, Tag, type SelectRenderMultipleSelectedItemFn as RenderMultipleSelectedItemFn, type SelectRenderSingleSelectedItemFn as RenderSingleSelectedItemFn } from '@fibrous/semi-ui-react';

interface ListItem {
    name: string;
    email: string;
    avatar: string;
}

export default function SelectDemo() {
    const list: ListItem[] = [
        {
            name: '夏可漫',
            email: 'xiakeman@example.com',
            avatar: '/assets/placeholder/avatar-a.svg',
        },
        {
            name: '申悦',
            email: 'shenyue@example.com',
            avatar: '/assets/root-web-sites/bag.jpeg',
        },
        {
            name: '曲晨一',
            email: 'quchenyi@example.com',
            avatar: '/assets/placeholder/avatar-c.svg',
        },
        {
            name: '文嘉茂',
            email: 'wenjiamao@example.com',
            avatar: '/assets/root-web-sites/6fbafc2d-e3e6-4cff-a1e2-17709c680624.png',
        },
    ];

    const renderSelectedItem: RenderSingleSelectedItemFn = (optionNode) => (
        <div key={optionNode.email} style={{ display: 'flex', alignItems: 'center' }}>
            <Avatar src={optionNode.avatar} alt="" size="small" />
            <span style={{ marginLeft: 8 }}>{optionNode.email}</span>
        </div>
    );

    const renderMultipleWithCustomTag: RenderMultipleSelectedItemFn = (optionNode, { onClose }) => {
        const content = (
            <Tag avatarSrc={optionNode.avatar} avatarShape="circle" closable onClose={onClose} size="large" key={optionNode.name}>
                {optionNode.name}
            </Tag>
        );
        return {
            isRenderInTag: false,
            content,
        };
    };

    const renderMultipleWithCustomTag2: RenderMultipleSelectedItemFn = (optionNode, { onClose }) => {
        const content = (
            <Tag avatarSrc={optionNode.avatar} avatarShape="square" closable onClose={onClose} size="large" key={optionNode.name}>
                {optionNode.name}
            </Tag>
        );
        return {
            isRenderInTag: false,
            content,
        };
    };

    const renderCustomOption = (item: ListItem) => {
        const optionStyle = {
            display: 'flex',
            paddingLeft: 24,
            paddingTop: 10,
            paddingBottom: 10,
        };
        return (
            <Select.Option value={item.name} style={optionStyle} showTick {...item} key={item.email}>
                <Avatar size="small" src={item.avatar} alt="" />
                <div style={{ marginLeft: 8 }}>
                    <div style={{ fontSize: 14 }}>{item.name}</div>
                    <div style={{ color: 'var(--color-text-2)', fontSize: 12, lineHeight: '16px', fontWeight: 'normal' }}>{item.email}</div>
                </div>
            </Select.Option>
        );
    };

    return (
        <>
            <Select placeholder="请选择" style={{ width: 280, height: 40 }} onChange={(v) => console.log(v)} defaultValue="申悦" renderSelectedItem={renderSelectedItem}>
                {list.map(renderCustomOption)}
            </Select>
            <Select placeholder="请选择" maxTagCount={2} style={{ width: 280, marginTop: 20 }} onChange={(v) => console.log(v)} defaultValue={['申悦', '曲晨一']} multiple renderSelectedItem={renderMultipleWithCustomTag}>
                {list.map(renderCustomOption)}
            </Select>
            <Select placeholder="请选择" maxTagCount={2} style={{ width: 280, marginTop: 20 }} onChange={(v) => console.log(v)} defaultValue={['申悦', '曲晨一']} multiple renderSelectedItem={renderMultipleWithCustomTag2}>
                {list.map(renderCustomOption)}
            </Select>
        </>
    );
}

自定义弹出层样式

你可以通过 dropdownClassName、dropdownStyle 控制弹出层的样式
例如当自定义弹出层的宽度时,可以通过 dropdownStyle 传入 width

代码
import { Select } from '@fibrous/semi-ui-react';

export default function SelectDemo() {
    return (
        <Select aria-label="业务线" placeholder="自定义弹出层样式的" style={{ width: 180 }} dropdownStyle={{ width: 250 }} dropdownClassName="test">
            <Select.Option value="douyin">抖音</Select.Option>
            <Select.Option value="ulikecam">轻颜相机</Select.Option>
            <Select.Option value="jianying">剪映</Select.Option>
            <Select.Option value="xigua">西瓜视频</Select.Option>
        </Select>
    );
}

获取选项的其他属性

默认情况下onChange只能拿到 value,如果需要拿选中节点的其他属性,可以使用onChangeWithObject属性
此时onChange函数的入参将会是 object,包含 option 的各种属性,例如 onChange({ value, label, ...rest })

onChange回调:

onChange回调:

代码
import { useState } from 'react';
import { Select, TextArea } from '@fibrous/semi-ui-react';

interface Item {
    value: string;
    label: string;
    type: number;
}

export default function SelectDemo() {
    const list: Item[] = [
        { value: 'douyin', label: '抖音', type: 1 },
        { value: 'ulikecam', label: '轻颜相机', type: 2 },
        { value: 'jianying', label: '剪映', type: 3 },
        { value: 'toutiao', label: '今日头条', type: 4 },
    ];
    const [cbValue, setCbValue] = useState<Item>();
    const [multipleCbValue, setMultipleCbValue] = useState<Item[]>();

    const onChange = (value?: Item) => {
        setCbValue(value);
        console.log(value);
    };

    const onMultipleChange = (value: Item[]) => {
        setMultipleCbValue(value);
        console.log(value);
    };

    return (
        <div>
            <div>
                <Select aria-label="单选" style={{ width: 150 }} onChangeWithObject optionList={list} placeholder="单选" defaultValue={list[0]} onChange={onChange} />
                <h4 id="select-on-change-with-object-single">onChange回调:</h4>
                <TextArea aria-labelledby="select-on-change-with-object-single" style={{ width: 320, marginBottom: 48 }} autosize value={JSON.stringify(cbValue)} rows={2} />
            </div>
            <div>
                <Select aria-label="多选" style={{ width: 320 }} onChangeWithObject multiple optionList={list} onChange={onMultipleChange} placeholder="多选" />
                <h4 id="select-on-change-with-object-multiple">onChange回调:</h4>
                <TextArea aria-labelledby="select-on-change-with-object-multiple" style={{ width: 320 }} autosize value={JSON.stringify(multipleCbValue)} />
            </div>
        </div>
    );
}

创建条目

设置allowCreate,可以创建并选中选项中不存在的条目

允许通过 renderCreateItem 自定义创建标签时的内容显示(通过返回 ReactNode,注意你需要自定义样式),该函数默认值为 (input, isFocus, style) => '创建' + input

可以配合defaultActiveFirstOption属性使用,自动选中第一项,当输入完内容直接回车时,可立即创建



With renderCreateItem
代码
import { Select } from '@fibrous/semi-ui-react';

export default function SelectDemo() {
    const optionList = [
        { value: 'douyin', label: '抖音' },
        { value: 'ulikecam', label: '轻颜相机' },
        { value: 'jianying', label: '剪映' },
        { value: 'toutiao', label: '今日头条' },
    ];
    return (
        <>
            <Select aria-label="业务线" style={{ width: 400 }} optionList={optionList} allowCreate multiple filter onChange={(v) => console.log(v)} defaultActiveFirstOption />
            <br />
            <br />
            <Select
                aria-label="业务线"
                style={{ width: 400 }}
                optionList={optionList}
                allowCreate
                multiple
                filter
                placeholder="With renderCreateItem"
                renderCreateItem={(input, _isFocus, style) => <div style={{ padding: 10, ...style }}>Create Item:{input}</div>}
                onChange={(v) => console.log(v)}
                defaultActiveFirstOption
            />
        </>
    );
}

虚拟化

传入virtualize时开启列表虚拟化,用于大量 Option 节点的情况优化性能
virtualize 是一个包含下列值的对象:

  • height: Option 列表高度值,默认 270 (v2.20.8 前为 300)
  • width: Option 列表宽度值,默认 100%
  • itemSize: 每行 Option 的高度,必传
代码
import { Select } from '@fibrous/semi-ui-react';

export default function SelectDemo() {
    const newOptions = Array.from({ length: 3000 }, (_v, i) => ({ label: `option-${i}`, value: i }));
    let virtualize = {
        height: 270,
        width: '100%',
        itemSize: 36, // px
    };
    return <Select aria-label="virtualize" placeholder="拥有3k个Option的Select" style={{ width: 260 }} filter virtualize={virtualize} optionList={newOptions} />;
}

自定义触发器

如果 Select 默认的触发器样式满足不了你的需求,可以用triggerRender自定义选择框的展示
如果想保留搜索筛选能力,又不希望自己渲染 Input 相关的结构,可以同时通过 searchPosition='dropdown',将默认的搜索框置于下拉列表中

triggerRender 入参如下

interface TriggerRenderProps {
    value: array<object>; // 当前所有已选中的options
    inputValue: string; // 当前input框的输入值
    onSearch: (inputValue: string) => void; // 用于更新 input框值的函数,当你在triggerRender自定义的Input组件值更新时你应该调用该函数,用于向Select内部同步状态。注意 filter 需同时设为true, v2.32 提供
    onRemove: (option: object) => void; // 用于移除单个已选项,option至少需带有 label、value 两项,v2.32提供
    onClear: () => void; // 用于清空值的函数
    disabled: boolean; // 是否禁用Select
    placeholder: ReactNode; // Select的placeholder
    componentProps: object; // 所有用户传给Select的props
}

不同背景色的触发器



使用 circle Tag 作为触发器

代码
import { useState } from 'react';
import { IconAppCenter, IconChevronDown } from '@fibrous/semi-icons-react';
import { Select, Tag, type SelectTriggerRenderProps } from '@fibrous/semi-ui-react';

export default function SelectDemo() {
    const [valList, setValList] = useState(['douyin', 'ulikecam']);
    const list = [
        { value: 'douyin', label: '抖音' },
        { value: 'ulikecam', label: '轻颜相机' },
        { value: 'jianying', label: '剪映' },
        { value: 'toutiao', label: '今日头条' },
    ];
    const triggerRender = ({ value }: SelectTriggerRenderProps) => {
        return (
            <div
                style={{
                    minWidth: '112px',
                    backgroundColor: 'var(--semi-color-primary-light-default)',
                    height: 32,
                    display: 'flex',
                    alignItems: 'center',
                    paddingLeft: 12,
                    borderRadius: 3,
                    color: 'var(--semi-color-primary)',
                }}
            >
                <div
                    style={{
                        fontWeight: 600,
                        flexShrink: 0,
                        fontSize: 14,
                    }}
                >
                    业务线
                </div>
                <div
                    style={{
                        margin: 4,
                        whiteSpace: 'nowrap',
                        textOverflow: 'ellipsis',
                        flexGrow: 1,
                        overflow: 'hidden',
                    }}
                >
                    {value.map((item) => item.label).join(' , ')}
                </div>
                <IconAppCenter style={{ marginRight: 8, flexShrink: 0 }} />
            </div>
        );
    };

    const triggerRender2 = ({ value }: SelectTriggerRenderProps) => {
        return (
            <div
                style={{
                    margin: 4,
                    whiteSpace: 'nowrap',
                    textOverflow: 'ellipsis',
                    flexGrow: 1,
                    overflow: 'hidden',
                    display: 'flex',
                    alignItems: 'center',
                }}
            >
                <Tag size="large" color="cyan" shape="circle" suffixIcon={<IconChevronDown />}>
                    {value.map((item) => item.label).join(' / ')}
                </Tag>
            </div>
        );
    };

    return (
        <div>
            <h4>不同背景色的触发器</h4>
            <Select aria-label="不同背景色的触发器" value={valList} triggerRender={triggerRender} optionList={list} onChange={(value) => setValList(value)} multiple filter searchPosition="dropdown" style={{ width: 240 }} />
            <br />
            <br />
            <h4>使用 circle Tag 作为触发器</h4>
            <Select aria-label="circle Tag 触发器" value={valList} onChange={(value) => setValList(value)} triggerRender={triggerRender2} optionList={list} filter multiple searchPosition="dropdown" style={{ width: 240, marginTop: 20, outline: 0 }} />
        </div>
    );
}

下例是更复杂的例子:复用了 TagInput 拖拽排序能力,通过自定义触发器为 Select 增加排序

可对已选项拖拽重新排序的 Select

代码
import { useState } from 'react';
import { Select, TagInput, type SelectTriggerRenderProps } from '@fibrous/semi-ui-react';

export default function SelectDemo() {
    const [valList, setValList] = useState(['douyin', 'ulikecam']);
    const [inputVal, setInputVal] = useState('');
    const list = [
        { value: 'douyin', label: '抖音' },
        { value: 'ulikecam', label: '轻颜相机' },
        { value: 'jianying', label: '剪映' },
        { value: 'toutiao', label: '今日头条' },
    ];

    const handleSort = (currentLabels: string[]) => {
        const newValue = currentLabels.flatMap((item) => list.find((i) => i.label === item)?.value ?? []);
        setValList(newValue);
    };

    const triggerRender = ({ value, onSearch }: SelectTriggerRenderProps) => {
        return (
            <div role="presentation" onKeyDown={(e) => e.stopPropagation()}>
                <TagInput
                    draggable
                    allowDuplicates={false}
                    value={value.map((item) => String(item.label))}
                    inputValue={inputVal}
                    onInputChange={(word) => {
                        onSearch(word);
                        setInputVal(word);
                    }}
                    onChange={handleSort}
                    showClear
                />
            </div>
        );
    };

    return (
        <>
            <h4>可对已选项拖拽重新排序的 Select </h4>
            <Select aria-label="可拖拽排序的 Select" value={valList} triggerRender={triggerRender} optionList={list} onChange={(value) => setValList(value)} multiple filter style={{ width: 240 }} />
        </>
    );
}

自定义候选项渲染

  • 简单的自定义:通过 Option 的 label 属性或者 children 传入 ReactNode,你可以控制候选项的渲染,此时内容会自动带上内边距、背景色等样式
  • 完全自定义:通过传入renderOptionItem,你可以完全接管列表中候选项的渲染,并且从回调入参中,获取到相关的状态值。实现更高自由度的结构渲染
    注意事项:
    1. props 传入的 style 需在 wrapper dom 上进行消费,否则在虚拟化场景下会无法正常使用
    2. props 传入的 className、onMouseEnter 需在 wrapper dom 上进行消费,否则上下键盘操作时显示会有问题
    3. 选中(selected)、聚焦(focused)、禁用(disabled)等状态的样式需自行加上,你可以从 props 中获取到相对的 boolean 值
    4. 如果你的自定义 item 为 Select.Option,需要将 renderProps.onClick 透传给 Option 的 onSelect prop
    5. props 传入的 id 需与 role="option"、aria-selected、aria-disabled 一起写在 wrapper dom 上:Select 的 aria-activedescendant 指向该 id,读屏才能读出方向键移到的候选项;打开下拉或方向键移动时也按该 id 把候选项滚进列表可视区


多选
代码
import { useState } from 'react';
import clsx from 'clsx';
import { Select, Checkbox, Highlight, type SelectOptionRenderProps } from '@fibrous/semi-ui-react';

export default function SelectDemo() {
    const [inputValue, setInputValue] = useState('');
    const renderOptionItem = ({ id, disabled, selected, label, focused, className, style, onMouseEnter, onClick }: SelectOptionRenderProps) => {
        const optionCls = clsx(className, {
            ['custom-option-render']: true,
            ['custom-option-render-focused']: focused,
            ['custom-option-render-disabled']: disabled,
            ['custom-option-render-selected']: selected,
        });
        const searchWords = [inputValue];

        // Put style on the outer DOM or the virtual list breaks; add selected/focused/disabled styles from props;
        // bind onMouseEnter and className on the outer DOM or arrow keys display wrongly; put id there so screen
        // readers announce the option the arrow keys reach

        return (
            <div id={id} role="option" aria-selected={selected} aria-disabled={disabled} style={style} className={optionCls} onClick={onClick} onMouseEnter={onMouseEnter}>
                <Checkbox checked={selected} />
                <div className="option-right">
                    <Highlight sourceString={label as string} searchWords={searchWords} />
                </div>
            </div>
        );
    };

    const optionList = [
        { value: 'douyin', label: '抖音', otherKey: 0 },
        { value: 'ulikecam', label: '轻颜相机', disabled: true, otherKey: 1 },
        { value: 'jianying', label: '剪映', otherKey: 2 },
        { value: 'toutiao', label: '今日头条', otherKey: 3 },
    ];

    return (
        <>
            <Select aria-label="单选" filter placeholder="单选" onSearch={(v) => setInputValue(v)} dropdownClassName="components-select-demo-renderOptionItem" optionList={optionList} style={{ width: 180 }} renderOptionItem={renderOptionItem} />
            <br />
            <br />
            <Select aria-label="多选" filter placeholder="多选" multiple onSearch={(v) => setInputValue(v)} dropdownClassName="components-select-demo-renderOptionItem" optionList={optionList} style={{ width: 320 }} renderOptionItem={renderOptionItem} />
        </>
    );
}
.components-select-demo-renderOptionItem {
    .custom-option-render {
        display: flex;
        font-size: 14px;
        line-height: 20px;
        word-break: break-all;
        padding-left: 12px;
        padding-right: 12px;
        padding-top: 8px;
        padding-bottom: 8px;
        color: var(--semi-color-text-0);
        position: relative;
        display: flex;
        align-items: center;
        cursor: pointer;
        box-sizing: border-box;
        .option-right {
            margin-left: 8px;
            display: inline-flex;
            align-items: center;
        }
        &:active {
            background-color: var(--semi-color-fill-1);
        }
        &-focused {
            background-color: var(--semi-color-fill-0);
        }
        &-selected {
            //font-weight: 700;
        }
        &-disabled {
            color: var(--semi-color-disabled-text);
            cursor: not-allowed;
        }
        &:first-of-type {
            margin-top: 4px;
        }
        &:last-of-type {
            margin-bottom: 4px;
        }
    }
}

API 参考

Select Props

Props

属性说明类型默认值
allowCreate是否允许创建下拉列表中不存在的条目,需配合 filter 使用。创建时触发 onCreate,创建项的内容可用 renderCreateItem 自定义。booleanfalse
aria-labelcombobox 的可访问名称,优先级低于 aria-labelledby,高于 insetLabel。React.AriaAttributes['aria-label']-
arrowIcon自定义右侧下拉箭头图标。showClear 开启且有已选值时,hover 会优先显示清除图标。React.ReactNodeType<IconChevronDown />
autoAdjustOverflow弹出层被遮挡时是否自动调整方向。booleantrue
autoClearSearchValue同时开启 multiple 与 filter 时,选中选项后是否自动清空搜索关键字。booleantrue
autoFocus初始渲染时是否自动聚焦。boolean-
borderless是否使用无边框样式。booleanfalse
children选项,直接子元素须为 Select.Option 或 Select.OptGroup,Fragment 会被展开。传入 optionList 时以 optionList 为准,忽略 children。React.ReactNode-
className类名,应用于触发器根元素。string-
clearIcon自定义清除按钮的图标,showClear 为 true 时有效。React.ReactNode-
clickToHide下拉列表已展开时,再次点击选择框是否收起下拉列表。boolean-
defaultActiveFirstOption没有选中值时是否默认高亮第一个未禁用的选项,按回车可直接选中。已有选中值时,打开下拉列表会高亮第一个已选的选项。booleantrue
defaultOpen是否默认展开下拉列表。booleanfalse
defaultValue初始选中的值,用于非受控模式。多选时为数组。TypeSelectValue<T>-
disabled是否禁用。booleanfalse
dropdownClassName弹出层的类名。string-
dropdownMatchSelectWidth下拉菜单的最小宽度是否与选择框相同。宽度本身不会被写死,需要固定宽度时用 dropdownStyle。booleantrue
dropdownStyle弹出层的样式,例如用 width 自定义弹出层的宽度。React.CSSProperties-
ellipsisTrigger同时设置 maxTagCount 且为多选时,是否对溢出的标签做自适应处理,宽度不足时截断最后一个标签的内容。开启后有一定性能损耗,大表单场景不推荐使用。booleanfalse
emptyContent无结果时展示的内容。未设置时展示语言包中的空状态文案;设为 null 时下拉列表不展示任何内容。React.ReactNode-
expandRestTagsOnClick同时设置 maxTagCount 且为多选时,下拉列表展开期间是否展示全部剩余标签。booleanfalse
filter是否可搜索。传入 true 时按选项的 label 是否包含输入值筛选;传入函数时,函数接收输入值与选项对象,返回 true 表示保留该选项。Typeboolean | ((inpueValue: string, option: OptionProps) => boolean)false
id触发器的 id,选项的 id 由它派生。未传时由组件生成。string-
innerBottomSlot渲染在下拉列表内部底部的自定义内容,随选项列表滚动,滚动到底部时展示。React.ReactNode-
innerTopSlot渲染在下拉列表内部顶部的自定义内容,随选项列表滚动,滚动到顶部时展示。React.ReactNode-
inputPropsfilter 为 true 时搜索输入框的额外属性,可用属性参考 Input 组件。不要传入 value、ref、onChange、onFocus,否则会覆盖 Select 的回调,影响组件行为。TypeOmit<InputProps, keyof { value?: InputProps['value']; onFocus?: InputProps['onFocus']; onChange?: InputProps['onChange']; }>-
insetLabel选择框内的内嵌标签,同时作为 combobox 与下拉列表的名称来源。设置了 prefix 时不渲染,也不作名称。React.ReactNode-
insetLabelIdinsetLabel 元素的 id,combobox 的 aria-labelledby 指向它。未传时由组件生成。string-
loading下拉列表是否展示加载动画。加载中不展示选项。boolean-
max最多可选的数量,仅多选时生效。超出后无法再选中该选项,并触发 onExceed。number-
maxHeight下拉菜单中选项列表的最大高度。使用虚拟化且 virtualize.height 大于默认的 270px 时,需将它设为相同的值,以避免出现双滚动条。string | number270
maxTagCount多选时,超过该数量的已选项以 +N 的形式展示。number-
motion弹出层是否使用动画。booleantrue
multiple是否多选。Multiplefalse
onBlur失去焦点时的回调。点击外部关闭已展开的下拉列表时,参数为该次 mousedown 的原生事件。Type(e: React.FocusEvent<HTMLElement> | globalThis.MouseEvent) => void-
onChange值变化时的回调。单选时入参为 T | undefined,多选时为 T[];onChangeWithObject 为 true 时入参为选项对象。Type(value: SelectChangeValue<T, Multiple>) => void-
onChangeWithObject是否将选项的其他属性随 onChange 回传。设为 true 后,onChange 的入参为 { value, label, ...rest } 形式的对象,value 与 defaultValue 也应为带有 value、label 键的对象。booleanfalse
onClear点击清除按钮时的回调。Type() => void-
onCreateallowCreate 为 true 时,创建备选项的回调,参数为新建的选项。Type(option: OptionProps) => void-
onDeselect取消选中时的回调,仅多选时有效。第一个参数为选项的原始 value,第二个参数为选项对象。Type(value: OptionProps['value'], option: Record<string, any>) => void-
onDropdownVisibleChange下拉列表展开或收起时的回调,参数为下拉列表是否可见。Type(visible: boolean) => void-
onExceed选中数量超过 max 时的回调,仅多选时生效,参数为被拒绝选中的选项。Type(option: OptionProps) => void-
onFocus获得焦点时的回调。Type(e: React.FocusEvent<HTMLElement>) => void-
onListScroll选项列表滚动时的回调。Type(e: React.UIEvent<HTMLDivElement>) => void-
onMouseEnter鼠标移入选择框时的回调。Type(e: React.MouseEvent) => any-
onMouseLeave鼠标移出选择框时的回调。Type(e: React.MouseEvent) => any-
onSearch搜索输入内容变化时的回调。第一个参数为输入值,第二个参数为引起变化的事件;通过 ref 的 search 方法或 triggerRender 触发时,第二个参数为 undefined。Type(value: string, event?: InputChangeEvent | React.KeyboardEvent | React.MouseEvent | globalThis.MouseEvent) => void-
onSelect选中时的回调。第一个参数总是选项的原始 value,开启 onChangeWithObject 时也是;第二个参数为选项对象。Type(value: OptionProps['value'], option: Record<string, any>) => void-
optionList以数组形式传入选项,每个对象须包含 value 与 label,其他属性也会随选项回传。OptionProps[]-
outerBottomSlot渲染在下拉弹出层底部、与选项列表平级的自定义内容,无论选项列表是否滚动都会展示。React.ReactNode-
outerTopSlot渲染在下拉弹出层顶部、与选项列表平级的自定义内容,无论选项列表是否滚动都会展示。React.ReactNode-
placeholder未选中任何选项时显示的文字。React.ReactNode""
position菜单展开的位置,可选值与 Tooltip 的 position 相同。未设置时,从左到右的文本方向下为 bottomLeft,从右到左的文本方向下为 bottomRight。Position-
prefix选择框的前缀,可以是文本或 ReactNode。文本与图标会自动带上左右间隔,自定义节点的左右间隔为 0。React.ReactNode-
preventScroll通过 focus 方法聚焦时,是否阻止浏览器滚动文档以显示被聚焦的元素。boolean-
ref指向 SelectHandle 句柄,通过它调用下方 Methods 中的方法。TypeReact.Ref<SelectHandle>-
remote是否为远程搜索。为 true 时输入内容变化后不再对当前选项做本地筛选,需由外部通过更新 optionList 提供结果。booleanfalse
renderCreateItemallowCreate 为 true 时,自定义创建条目的内容,参数为 (inputValue, isFocus, style),返回 ReactNode。未设置时展示语言包中的「创建」加输入内容。与虚拟化结合使用时,须把 style 用在自定义节点上。Type(inputValue: OptionProps['value'], focus: boolean, style?: React.CSSProperties) => React.ReactNode-
renderOptionItem完全接管下拉列表中候选项的渲染。参数包括 id、value、label、selected、focused、disabled、inputValue、className、style、onClick 与 onMouseEnter。style、className、onClick 与 onMouseEnter 须用在包装元素上,id 须与 role="option"、aria-selected、aria-disabled 一起写在包装元素上。Type(props: optionRenderProps) => React.ReactNode-
renderSelectedItem自定义选择框中已选项标签的渲染。单选时入参为选项对象,返回 ReactNode;多选时入参为选项对象与 { index, disabled, onClose },返回 { isRenderInTag, content },isRenderInTag 为 true 时,content 会包在带背景色与关闭按钮的标签中。TypeByMultiple<Multiple, RenderSingleSelectedItemFn, RenderMultipleSelectedItemFn>-
restTagsPopoverPropsshowRestTagsPopover 开启时,超出标签的 Popover 配置,可设置 position、trigger 等,参考 Popover 组件。PopoverProps{}
searchPlaceholder搜索框位于下拉列表中(searchPosition 为 dropdown)时,搜索框的占位文字。string-
searchPositionfilter 开启时搜索框的位置。trigger 表示搜索框在选择框内,dropdown 表示搜索框在下拉列表顶部。搭配 triggerRender 使用可以实现更自由的交互。'trigger' | 'dropdown'"trigger"
showArrow是否展示下拉箭头。booleantrue
showClear是否展示清除按钮。booleanfalse
showRestTagsPopover超过 maxTagCount 后,悬停到 +N 上时是否通过 Popover 展示剩余内容。booleanfalse
size尺寸,可选 small、default、large。未设置时为默认尺寸。SelectSize-
spacing浮层与选择器之间的距离,单位为 px。传入 { x, y } 对象时可分别设置水平与垂直距离。未设置时为 8。number | { x: number; y: number }-
stopPropagation是否阻止弹出层上的点击事件冒泡。booleantrue
style样式,应用于触发器根元素。React.CSSProperties-
suffix选择框的后缀,可以是文本或 ReactNode,规则与 prefix 相同。React.ReactNode-
triggerRender自定义选择框的触发器。入参包括 value、inputValue、onSearch、onRemove、onClear、disabled、placeholder 与 componentProps。若想保留搜索能力又不自行渲染输入框,可同时把 searchPosition 设为 dropdown。Type(props: TriggerRenderProps) => React.ReactNode-
validateStatus校验状态,可选 warning、error、default,仅影响背景色等样式。未设置时为 default。ValidateStatus-
value当前选中的值。传入后 Select 为受控组件,需配合 onChange 使用。多选时为数组。TypeSelectValue<T>-
virtualize开启列表虚拟化,用于大量选项时优化性能。包含 height(默认 270)、width(默认 100%)与 itemSize(每行选项的高度,必传)。virtualListProps-

Methods

方法说明类型
clearInput清空搜索框的值。Type() => void
close关闭下拉列表。Type() => void
deselectAll清空所有已选项。Type() => void
focus聚焦选择框。可搜索时聚焦搜索框并展开下拉列表;不可搜索时只聚焦触发器,不展开下拉列表。Type() => void
open展开下拉列表。Type() => void
rePosition按触发器当前位置立即重新计算下拉层位置。下拉层已随滚动、窗口尺寸变化、触发器移动以及触发器或列表的尺寸变化自动重新定位,一般无需调用;跟随触发器移动会晚一帧,需要同一帧内对齐时调用。Type() => void
search按输入了该值来搜索,该值会被置给搜索框。不传事件时,onSearch 的第二个参数为 undefined。Type(value: string, event?: any) => void
selectAll选中所有可见且未禁用的选项,仅多选时有效。Type() => void

其他原生属性(如 data-*)落在触发器根元素上,style 不会传给下拉弹出层(用 dropdownStyle)。aria-label、aria-labelledby、aria-describedby、aria-errormessage、aria-invalid、aria-required 落在 combobox 上;可搜索时搜索框挂载后它就是 combobox,这些属性随之移过去。

Option Props


选项以 value 作为标识,同一个 Select 内 value 不应重复;label 可以重复

Props

属性说明类型默认值
children选项的内容。未设置 label 时作为展示的内容。React.ReactNode-
className选项的类名。string-
current内部属性,由 AutoComplete 设置,标记该选项为当前项(aria-selected)。Select 的使用者无需设置。boolean-
disabled是否禁用该选项。boolean-
label展示的文本,可以是字符串、数字或 ReactNode。渲染时优先取 label,未设置时依次取 children 与 value。string | number | React.ReactNode-
showTick选中时是否展示 √ 图标。由 Select 渲染的选项默认展示。boolean-
style选项行的样式。React.CSSProperties-
value选项的值。同一个 Select 内 value 不应重复,label 可以重复。string | number-

className、style、data-* 落在选项行上;其他未声明的属性不会进入 DOM,随选项记录在 onSelect、onDeselect、renderSelectedItem 与 renderOptionItem 中回传。

OptGroup Props


Props

属性说明类型默认值
children分组内的选项,即 Select.Option。React.ReactNode-
className分组标题的类名。string-
label分组标题。设置后,分组内的选项位于以该标题命名的 group 中。React.ReactNode-
style分组标题的样式。React.CSSProperties-

className、style 与其他原生属性(如 id、data-*)落在分组标题元素上。

Methods

绑定在组件实例上的方法,可以通过 ref 调用实现某些特殊交互

方法列表见 Select Props 之后的 Methods 表。

Accessibility

ARIA

  • 按 ARIA 1.2 的 combobox 写法,任一时刻只有一个元素是 combobox,弹出层的 role 为 listbox,可选项的 role 为 option:
    • 不可搜索,或搜索框在下拉内(searchPosition="dropdown")时,Select trigger 是 select-only combobox,选中的内容是它的值
    • 搜索框在 trigger 内时,搜索框本身是 combobox,带 aria-autocomplete="list",trigger 不再有角色和 Tab 停靠点。单选的搜索框只在搜索时出现,未搜索时 trigger 仍是 combobox;搜索框在输入前为空,已选文本以 aria-describedby 关联为它的描述。多选的搜索框一直存在
    • 下拉内的搜索框保持文本框角色,带 aria-controls、aria-autocomplete、aria-activedescendant,名称与 combobox 相同
  • combobox 的名称按优先级取:aria-labelledby、aria-label、实际渲染出来的 insetLabel(combobox 的 aria-labelledby 指向它,未传 insetLabelId 时组件生成 id;有 prefix 时 insetLabel 不渲染,也不作名称),都没有时为语言包中的「选择」。建议传入与表单标签一致的名称。listbox 与下拉内的搜索框使用同一个名称来源,不指向 combobox 自身。选中的内容是 combobox 的值,不计入名称
  • combobox 具有 aria-haspopup、aria-expanded、aria-controls 属性,表示它与弹出层的关系
  • 多选时,listbox aria-multiselectable 为 true,表示当前可以多选
  • Option 选中时,aria-selected 为 true;当 Option 禁用时,aria-disabled 为 true
  • 带 label 的 OptGroup 中的选项位于 role="group" 内,以分组标题为名称(aria-labelledby),读屏会读出选项所属的分组;虚拟列表不显示分组标题,不包分组
  • 下拉打开时,属性 aria-activedescendant 指向键盘聚焦的 option,保证在朗读旁白时识别到当前的选择的 option;完全自定义候选项渲染时请把参数中的 id 写在 option 元素上(更多用法请参考Managing Focus in Composites Using aria-activedescendant)

键盘和焦点

不带 Filter 功能,或搜索框在下拉内(searchPosition="dropdown")的 Select:

  • Select 聚焦后,键盘用户可以通过 空格、上箭头、下箭头(含 Alt + 下箭头)或 Enter 键打开下拉菜单。已有选中值时焦点落在第一个已选的选项上,直接按 Enter 不改变值;没有选中值时保留当前高亮,初始高亮为第一个未禁用的选项(defaultActiveFirstOption 默认为 true)
  • Home、End 打开下拉菜单,并把焦点移到第一个、最后一个可用选项
  • 输入字符打开下拉菜单,并把焦点移到下一个以该字符开头的选项;快速连续输入时按整串匹配,重复输入同一字符时在以它开头的选项间轮换
  • 当下拉菜单打开时:
    • 使用 Esc 键或 Tab 键可以关闭菜单
    • 使用 上箭头 或 下箭头 可以切换选项,Home、End 移到首尾,输入字符移到以它开头的选项
    • 被聚焦的选项可以通过 Enter 或 空格 选中:单选选中后收起面板,多选切换选中状态并保持打开。快速连续输入字符的过程中,空格 计入匹配的字符串,不选中选项。焦点在下拉内的搜索框时,Home、End、空格 与字符用于编辑搜索内容,不移动选项焦点
  • 多选时焦点在已选标签上,按键只作用于标签:Backspace、Delete 删除标签,Enter、空格 不打开下拉菜单、不改变选中值
  • 当焦点在下拉菜单中,且用户使用的 innerBottomSlot 或 outerBottomSlot 属性的自定义 slot 中含有可交互元素时:
    • 可以使用 Tab 键切换到这些可交互元素上
    • 当焦点在自定义 slot 的首个可交互元素上时,使用 Shift + Tab ,焦点回到 Select 框上

带 Filter 功能的 Select:

  • Select 聚焦后,键盘用户可以通过 上箭头 或 下箭头 或 Enter 键打开下拉菜单。此时焦点仍然处于 Select 框,用户可以输入内容,同时也能使用 上箭头 或 下箭头 切换选项
  • 当下拉菜单打开时:使用 上箭头 或 下箭头 切换选项;Enter 选中被聚焦的选项,单选选中后收起面板,多选切换选中状态并保持打开;Esc 或 Tab 关闭菜单。Home、End、空格 与字符留给 Select 框内的输入框,用于编辑搜索内容,不移动选项焦点
  • 当焦点在 Select 框上,且用户使用的 innerBottomSlot 或 outerBottomSlot 属性的自定义 slot 中含有可交互元素时:
    • 可以使用 Tab 键切换到这些可交互元素上
    • 当焦点在自定义 slot 的首个可交互元素上时,使用 Shift + Tab ,焦点回到 Select 框上

清除按钮:

  • showClear 开启、有已选值或搜索文本且未禁用时,trigger 内渲染清除按钮。它是原生 button,名称为语言包中的「清空已选值」,在 hover、下拉打开或焦点位于 Select 内时显示
  • 焦点在 Select 框上时按 Tab 移到清除按钮,Enter 或 Space 清空,效果与鼠标点击相同;清空后焦点回到 Select 框

文案规范

  • 选择器标签
    • 用 1-3 个词描述需要用户所做的输入
    • 使用语句书写规范(首字母大写,其余小写)
    • 避免使用标点符号和介词(“the”, “an”, “a”)
    • 标签需是独立语句。不要让标签是前半句语句,选项是后半句语句。
    • 使用描述性语句,而不是指示性语句。如果选项需要更多解释,可以在选择框下使用帮助文本。
  • 选择器选项
    • 如果没有默认选项,就使用“Select”做占位文案
    • 选项要按首字母顺序或者其他有逻辑的排列顺序,使用户更好地找到选项
    • 使用语句书写规范(首字母大写,其余小写),避免在句尾使用逗号和分号
    • 清晰表达出选项所表示的选择目的

设计变量

下表是组件内部的 Sass 变量,不能覆写。定制样式请覆写 --semi-* CSS 变量(见 Design Token 页),或写不分层的 CSS 规则。
Sass 变量值用法
$transition_duration-select-bgvar(--semi-transition_duration-none)选择器-背景色-动画持续时间
$transition_function-select-bgvar(--semi-transition_function-easeIn)选择器-背景色-过渡曲线
$transition_delay-select-bgvar(--semi-transition_delay-none)选择器-背景色-延迟时间
$transition_duration-select-bordervar(--semi-transition_duration-none)选择器-边框-动画持续时间
$transition_function-select-bordervar(--semi-transition_function-easeIn)选择器-边框-过渡曲线
$transition_delay-select-bordervar(--semi-transition_delay-none)选择器-边框-延迟时间
$transition_duration-select_option-bgvar(--semi-transition_duration-none)选择器-选项-动画持续时间
$transition_function-select_option-bgvar(--semi-transition_function-easeIn)选择器-选项-过渡曲线
$transition_delay-select_option-bgvar(--semi-transition_delay-none)选择器-选项-延迟时间
$transform_scale-selectvar(--semi-transform_scale-none)选择框-变大
$transform_rotate-select-arrowvar(--semi-transform_rotate-none)选择框-箭头-旋转
$color-select-bg-defaultvar(--semi-color-fill-0)选择器输入框背景色 - 默认态
$color-select-bg-hovervar(--semi-color-fill-1)选择器输入框背景色 - 悬停态
$color-select-bg-activevar(--semi-color-fill-2)选择器输入框背景色 - 按下态
$color-select-bg-focusvar(--semi-color-fill-0)选择器输入框背景色 - 聚焦态
$color-select-border-defaulttransparent选择器输入框描边颜色
$color-select-border-hover$color-select-border-default选择器输入框描边颜色 - 悬浮
$color-select-border-activevar(--semi-color-focus-border)选择器输入框描边颜色 - 按下态
$color-select-border-focus$color-select-border-active选择器输入框描边颜色 - 选中态
$color-select_dropdown_input-border$color-select-border-default下拉搜索框底部描边颜色
$color-select_warning-bg-defaultvar(--semi-color-warning-light-default)警示选择器输入框背景色 - 默认态
$color-select_warning-border-defaultvar(--semi-color-warning-light-default)警示选择器输入框描边颜色 - 默认态
$color-select_warning-bg-hovervar(--semi-color-warning-light-hover)警示选择器输入框背景色 - 悬停态
$color-select_warning-border-hovervar(--semi-color-warning-light-hover)警示选择器输入框描边颜色 - 悬停态
$color-select_warning-bg-focusvar(--semi-color-warning-light-default)警示选择器输入框背景色 - 选中态
$color-select_warning-border-focusvar(--semi-color-warning)警示选择器输入框描边颜色 - 选中态
$color-select_warning-bg-activevar(--semi-color-warning-light-active)警示选择器输入框背景色 - 按下态
$color-select_warning-border-activevar(--semi-color-warning-light-active)警示选择器输入框描边颜色 - 按下态
$color-select_danger-bg-defaultvar(--semi-color-danger-light-default)报错选择器输入框背景色 - 默认态
$color-select_danger-border-defaultvar(--semi-color-danger-light-default)报错选择器输入框描边颜色 - 默认态
$color-select_danger-bg-hovervar(--semi-color-danger-light-hover)报错选择器输入框背景色 - 悬停态
$color-select_danger-border-hovervar(--semi-color-danger-light-hover)报错选择器输入框描边颜色 - 悬停态
$color-select_danger-bg-focusvar(--semi-color-danger-light-default)报错选择器输入框背景色 - 选中态
$color-select_danger-border-focusvar(--semi-color-danger)报错选择器输入框描边颜色 - 选中态
$color-select_danger-bg-activevar(--semi-color-danger-light-active)报错选择器输入框背景色 - 按下态
$color-select_danger-border-activevar(--semi-color-danger-light-active)报错选择器输入框描边颜色 - 按下态
$color-select_default-border-focusvar(--semi-color-focus-border)默认选择器输入框描边颜色 - 选中态
$color-select_main-text-defaultvar(--semi-color-text-0)选择器输入框回填内容文本颜色
$color-select-icon-defaultvar(--semi-color-text-2)选择器输入框图标颜色
$color-select_clearBtn-text-defaultvar(--semi-color-text-2)选择器输入框清空按钮颜色 - 默认态
$color-select_clearBtn-text-hovervar(--semi-color-primary)选择器输入框清空按钮颜色 - 悬停态
$color-select_input_disabled-bgvar(--semi-color-disabled-fill)禁用选择器输入框背景色
$color-select_input_disabled-border-focustransparent禁用选择器输入框描边颜色 - 聚焦态
$color-select_input_disabled-textvar(--semi-color-disabled-text)禁用选择器输入框回填内容文字颜色
$color-select_input_disabled-bg-hovervar(--semi-color-disabled-fill)禁用选择器输入框背景色 - 悬停态
$color-select_input_disabled-bg-focusvar(--semi-color-disabled-fill)禁用选择器输入框背景色 - 聚焦态
$color-select_input_placeholder-textvar(--semi-color-text-2)选择器输入框占位文本文字颜色
$color-select_option_main-textvar(--semi-color-text-0)选择器下拉菜单选项文本颜色
$color-select_option_keyword-textvar(--semi-color-primary)选择器下拉菜单选项匹配搜索结果文本颜色
$color-select_option-icon-defaulttransparent选择器下拉菜单选项图标颜色 - 默认态
$color-select_option-bg-hovervar(--semi-color-fill-0)选择器下拉菜单选项背景颜色 - 悬停态
$color-select_option-bg-activevar(--semi-color-fill-1)选择器下拉菜单选项背景颜色 - 按下态
$color-select_option_disabled-textvar(--semi-color-disabled-text)禁用选择器下拉菜单选项文字颜色
$color-select_option-icon-activevar(--semi-color-text-2)选择器下拉菜单选项图标颜色 - 选中态
$color-select_option-border-defaultvar(--semi-color-border)选择器下拉菜单分组标题分割线颜色
$color-select-option-bg-selectedtransparent选择器下拉菜单选项背景颜色 - 选中态
$color-select_create_tips-textvar(--semi-color-text-2)选择器下拉菜单新建选项提示文本颜色
$color-select_group-textvar(--semi-color-text-2)选择器下拉菜单分组标题文本颜色
$color-select_prefix_suffix_text-defaultvar(--semi-color-text-2)选择器输入框前后缀文本颜色
$height-select_large$height-control-large选择器输入框高度 - 大尺寸
$height-select_small$height-control-small选择器输入框高度 - 小尺寸
$height-select_default$height-control-default选择器输入框高度 - 默认尺寸
$width-select_option_tick$width-icon-small选择器下拉菜单项选中对勾图标大小
$width-select-border1px选择器输入框描边宽度
$width-select_arrow32px选择器输入框下拉箭头宽度
$width-select_arrow_empty12px选择器输入框下拉箭头为空时(有suffix icon)宽度
$width-select_clear-icon32px选择器输入框清空按钮宽度
$width-select_group_top-border$border-thickness-control选择器下拉菜单分组标题描边宽度
$height-select_multiple_input_small20px小尺寸多项选择器输入框Input框高度
$height-select_multiple_input_default24px默认多项选择器输入框Input框高度
$height-select_multiple_input_large24px大尺寸多项选择器输入框Input框高度
$width-select-border-hover$width-select-border选择器输入框描边宽度 - 悬浮
$width-select-border-focus$width-select-border-hover选择器输入框描边宽度 - 按下
$width-select-border-active$width-select-border-focus选择器输入框描边宽度 - 选中
$spacing-select_option_tick-marginRight$spacing-tight选择器下拉菜单选中对勾右侧外边距
$spacing-select_prefix_suffix_text-marginX$spacing-base-tight选择器输入框前后缀文本水平内边距
$spacing-select_prefix_suffix_text-marginY0px选择器输入框前后缀文本垂直内边距
$spacing-select_prefix_suffix_icon-marginX$spacing-tight选择器输入框前后缀图标水平内边距
$spacing-select_prefix_suffix_icon-marginY0px选择器输入框前后缀图标垂直内边距
$spacing-select_create_tips-marginRight$spacing-extra-tight创建新选项右侧外边距
$spacing-select_group-marginTop$spacing-extra-tight选择器下拉菜单分组标题顶部外边距
$spacing-select_group-paddingTop$spacing-base-tight选择器下拉菜单分组标题顶部内边距
$spacing-select_group-paddingBottom$spacing-extra-tight选择器下拉菜单分组标题底部内边距
$spacing-select_group-paddingLeft$spacing-base-tight + $width-select_option_tick + $spacing-select_option_tick-marginRight选择器下拉菜单分组标题左侧内边距
$spacing-select_group-paddingRight$spacing-base选择器下拉菜单分组标题右侧内边距
$spacing-select_loading_wrapper-paddingLeft$spacing-base选择器加载左侧内边距
$spacing-select_loading_wrapper-paddingRight$spacing-base选择器加载右侧内边距
$spacing-select_loading_wrapper-paddingTop$spacing-tight选择器加载顶部内边距
$spacing-select_loading_wrapper-paddingBottom$spacing-tight选择器加载底部内边距
$spacing-select_multiple_content_wrapper_empty-marginLeft$spacing-tight多项选择器空回填内容为空时左侧内边距
$spacing-select_multiple_selection-marginLeft$spacing-extra-tight多项选择器回填内容左侧内边距
$spacing-select_option-paddingLeft$spacing-base-tight选择器下拉菜单项左侧内边距
$spacing-select_option-paddingRight$spacing-base-tight选择器下拉菜单项右侧内边距
$spacing-select_option-paddingTop$spacing-tight选择器下拉菜单项顶部内边距
$spacing-select_option-paddingBottom$spacing-tight选择器下拉菜单项底部内边距
$spacing-select_tag-marginTop$spacing-super-tight - 1px多项选择器标签顶部外边距
$spacing-select_tag-marginRight$spacing-extra-tight多项选择器标签右侧外边距
$spacing-select_tag-marginBottom$spacing-super-tight - 1px多项选择器标签底部外边距
$spacing-select_selection-marginLeft$spacing-base-tight选择器内容区左侧外边距
$spacing-select_option_list-paddingTop$spacing-extra-tight选择器内容区顶部内边距
$spacing-select_option_list-paddingRight0px选择器内容区右侧内边距
$spacing-select_option_list-paddingBottom$spacing-extra-tight选择器内容区底部内边距
$spacing-select_option_list-paddingLeft0px选择器内容区左侧内边距
$spacing-select_dropdown_input_paddingTop8px下拉搜索框顶部内边距
$spacing-select_dropdown_input_paddingBottom8px下拉搜索框底部内边距
$spacing-select_dropdown_input_paddingRight12px下拉搜索框右侧内边距
$spacing-select_dropdown_input_paddingLeft12px下拉搜索框左侧内边距
$radius-selectvar(--semi-border-radius-small)选择器输入框圆角
$radius-select_option0px选择器待选项圆角
$font-select-fontWeight$font-weight-regular选择器文本字重
$font-select_keyword-fontWeight600选择器搜索结果命关键词中文本字重
$font-select_prefix_suffix-fontWeight$font-weight-bold选择器输入框前后缀文本字重
$opacity-select_selection_text_inactive0.4

TypeScript 泛型支持

Select 有两个泛型参数:T 是选项 value 的类型(设置 onChangeWithObject 时是 option 对象的类型),Multiple 是 multiple 属性的类型。单选时 onChange 的入参为 T | undefined,多选时为 T[];multiple 是 boolean 变量时为 T | T[] | undefined。onSelect、onDeselect 的入参是选项的原始 value(string | number),不随 T 变化。两个参数通常由 value 与 multiple 推断;多选时显式写 T 需要同时写 Multiple。

import { Select } from '@fibrous/semi-ui-react';

// 由 value 推断 T 为 string,value 为 string | undefined
<Select
    value={selectedValue}
    onChange={(value) => setSelectedValue(value)}
>
    <Select.Option value="option1">选项 1</Select.Option>
    <Select.Option value="option2">选项 2</Select.Option>
</Select>

// 多选时 value 为 string[]
<Select
    multiple
    value={selectedValues}
    onChange={(value) => setSelectedValues(value)}
>
    <Select.Option value="option1">选项 1</Select.Option>
    <Select.Option value="option2">选项 2</Select.Option>
</Select>

// 多选时显式写泛型参数
<Select<string, true> multiple onChange={(value) => setSelectedValues(value)}>
    <Select.Option value="option1">选项 1</Select.Option>
    <Select.Option value="option2">选项 2</Select.Option>
</Select>

FAQ

  • 可搜索的 Select,使用远程数据动态更新optionList,为什么在异步请求完成之前有时候会出现暂无数据?
    请检查是否开启了 remote,不开启 remote 的情况下,默认会将 input 框输入值与当前的 optionList 进行一次对比筛选,如果无匹配时,就会显示暂无数据。
    可以通过开启 remote 关闭对本地当前数据的匹配筛选。

  • Select 会自动限制下拉菜单的宽度吗?

    • 会给 minWidth,但不会写死 width。如果有需要的话,可以自己通过 dropdownStyle 来添加。
  • 为什么单选选择选项后没有触发 blur 事件?

    • 在 V2.17.0 前,Select 单选选择后,会触发 Select 的 blur 事件。
    • 在 V2.17.0 后,Select 增加了 A11y 支持,不会触发 Select 的 blur 事件。
      • 单选选择中,Select 浮层关闭,依然保持焦点在 trigger(此时可以通过 Enter 回车键再次打开 Select 浮层)
      • 无论单选或多选,按下 Esc,仅 Select 浮层关闭,trigger 保持焦点(此时可以通过 Enter 回车键再次打开 Select 浮层)