提及 Mentions
用于在输入中提及某人或某事,常用于发布、聊天或评论功能。
安装
npm install @arco-design/web-react@2.66.18
在入口引入 @arco-design/web-react/dist/css/arco.css,用 ConfigProvider 设置语言。React 19 项目还需在入口最先引入 @arco-design/web-react/es/_util/react-19-adapter,否则 Message、Modal 等命令式 API 无法渲染。
示例
- 基础用法:用于在输入中提及某人或某事,常用于发布、聊天或评论功能。
- 自定义触发字符:指定
prefix来自定义触发字符。默认为@,可以自定义为任意字符。 - 受控模式:
Mentions在Form中的使用。 - 无效或只读:通过
disabled设置是否禁用,通过readOnly属性设置是否只读。
示例来自 Arco Design 官方仓库(MIT),固定在 npm 2.66.18 对应的提交;部分示例使用在线图片或上传地址,预览中网络请求被禁用。
API
Mentions
| 参数名 | 描述 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| alignTextarea | 弹出框是否与输入框对齐 | boolean | true | - |
| allowClear | 允许清空输入框 | boolean | - | 2.2.0 |
| disabled | 是否禁用 | boolean | - | - |
| error | 是否是错误状态。(废弃,下个大版本移除,使用 status='error' 替代) | boolean | - | - |
| defaultValue | 输入框默认值 | string | - | - |
| placeholder | 输入框提示文字 | string | - | - |
| split | 选中项前后分隔符 | string | - | - |
| value | 输入框的值 | string | - | - |
| position | 下拉框的弹出位置 | 'top' | 'tl' | 'tr' | 'bottom' | 'bl' | 'br' | bl | - |
| status | 状态 | 'error' | 'warning' | - | 2.45.0 |
| clearIcon | allowClear 时配置清除按钮的图标。 | ReactNode | - | 2.50.0 |
| notFoundContent | 下拉列表没有数据时显示的内容 | ReactNode | - | - |
| autoSize | 是否自动调整输入框的高度 | boolean | { minRows?: number; maxRows?: number } | - | - |
| className | 节点类名 | string | string[] | - | - |
| options | 下拉框可选项 | (| string| number| { label: ReactNode | string; value: string | number; disabled?: boolean })[] | - | - |
| prefix | 触发关键字 | string | string[] | @ | - |
| style | 节点样式 | CSSProperties | - | - |
| triggerProps | 可以接受所有 Trigger 组件的 Props | Partial<TriggerProps> | - | - |
| wrapperStyle | 开启字数统计之后,会在 textarea 标签外包一层 div,wrapperStyle 用来配置这个 div 的样式。 | CSSProperties | - | - |
| filterOption | 是否根据输入的值筛选数据,可传入函数自定义过滤逻辑。 | false | ((inputValue: string, option) => boolean) | - | - |
| getPopupContainer | 弹出框挂载的父节点 | (node: HTMLElement) => HTMLElement | - | - |
| onBlur | 失焦时的回调 | (e) => void | - | - |
| onChange | 输入改变时的回调 | (value: string) => void | - | - |
| onClear | 点击清除按钮的回调 | () => void | - | 2.2.0 |
| onFocus | 聚焦时的回调 | (e) => void | - | - |
| onPressEnter | 按下回车键的回调 | (e) => void | - | - |
| onSearch | 搜索时的回调 | (text: string, prefix: string) => void | - | - |