ant-design/components/mentions/index.zh-CN.md
Eden Wang 28aaeafbbc
feat(mentions): supports 'allowClear' option (#46396)
* feat(mentions): supports 'allowClear' option

* feat(mentions): add allowClear testcase

* feat(mentions): update package and styles

* feat(mentions): update lint and styles

* fix: fixed lint error

* test: add case for custom clearIcon

* feat: add useAllowClear hook

* feat: rename useAllowClear to getAllowClear

* feat: rename useAllowClear to getAllowClear

* feat(mentions): add demo for allowClear

* feat(mentions): update demo desc

* feat(mentions): update demo desc

* feat(mentions): style align middle

* feat: add multi line mentions demo and update icon position

* feat: fixing visual regression report

---------

Co-authored-by: afc163 <afc163@gmail.com>
2023-12-25 10:37:26 +08:00

4.3 KiB
Raw Blame History

category subtitle group title cover coverDark demo
Components 提及 数据录入 Mentions https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*e4bXT7Uhi9YAAAAAAAAAAAAADrJ8AQ/original https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*pxR2S53P_xoAAAAAAAAAAAAADrJ8AQ/original
cols
2

提及组件。

何时使用

用于在输入中提及某人或某事,常用于发布、聊天或评论功能。

5.1.0 用法升级

// >=5.1.0 可用,推荐的写法 ✅
const options = [{ value: 'sample', label: 'sample' }];
return <Mentions options={options} />;

// <5.1.0 可用,>=5.1.0 时不推荐 🙅🏻‍♀️
return (
  <Mentions onChange={onChange}>
    <Mentions.Option value="sample">Sample</Mentions.Option>
  </Mentions>
);

代码演示

基本使用 形态变体 异步加载 配合 Form 使用 自定义触发字符 无效或只读 向上展开 带移除图标 自动大小 自定义状态 _InternalPanelDoNotUseOrYouWillBeFired 组件 Token

API

通用属性参考:通用属性

Mentions

参数 说明 类型 默认值 版本
allowClear 支持清除 boolean | { clearIcon?: ReactNode } false 5.13.0
autoFocus 自动获得焦点 boolean false
autoSize 自适应内容高度,可设置为 true | false 或对象:{ minRows: 2, maxRows: 6 } boolean | object false
defaultValue 默认值 string -
filterOption 自定义过滤逻辑 false | (input: string, option: OptionProps) => boolean -
getPopupContainer 指定建议框挂载的 HTML 节点 () => HTMLElement -
notFoundContent 当下拉列表为空时显示的内容 ReactNode Not Found
placement 弹出层展示位置 top | bottom bottom
prefix 设置触发关键字 string | string[] @
split 设置选中项前后分隔符 string
status 设置校验状态 'error' | 'warning' - 4.19.0
validateSearch 自定义触发验证逻辑 (text: string, props: MentionsProps) => void -
value 设置值 string -
variant 形态变体 outlined | borderless | filled outlined 5.13.0
onBlur 失去焦点时触发 () => void -
onChange 值改变时触发 (text: string) => void -
onFocus 获得焦点时触发 () => void -
onResize resize 回调 function({ width, height }) -
onSearch 搜索时触发 (text: string, prefix: string) => void -
onSelect 选择选项时触发 (option: OptionProps, prefix: string) => void -
options 选项配置 Options [] 5.1.0

Mentions 方法

名称 描述
blur() 移除焦点
focus() 获取焦点

Option

参数 说明 类型 默认值
value 选择时填充的值 string -
label 选项的标题 React.ReactNode -
key 选项的 key 值 string -
disabled 是否可选 boolean -
className css 类名 string -
style 选项样式 React.CSSProperties -

主题变量Design Token