JGuang

提及

Mentions · Arco Design

交互预览
npm install @arco-design/web-react@2.66.18

提及 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弹出框是否与输入框对齐booleantrue-
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
clearIconallowClear 时配置清除按钮的图标。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 组件的 PropsPartial<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--