mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-02 15:59:38 +08:00
fb0b4f0fc9
* docs: add api first appearance * docs: fix auto-complete doc * docs: replace Version Added with Version * docs: date picker common method * docs: date picker common method * docs: tree * docs: remove meaningless 3.0.0
73 lines
3.2 KiB
Markdown
73 lines
3.2 KiB
Markdown
---
|
|
category: Components
|
|
type: 废弃
|
|
subtitle: 提及（废弃）
|
|
title: Mention
|
|
---
|
|
|
|
提及组件。已废弃，请使用 [Mentions](/components/mentions) 代替。
|
|
|
|
## 为何废弃？
|
|
|
|
<div class="ant-alert ant-alert-error ant-alert-no-icon">
|
|
Mention 组件使用了
|
|
<a href="https://www.npmjs.com/package/draft-js" target="_blank" rel="noopener noreferrer">Draft.js</a>
|
|
进行提示定位，占用了约 11.6% 的包大小。因而我们决定使用更轻量级的解决方案以便于在未来降低整个包的大小。
|
|
</div>
|
|
|
|
## API
|
|
|
|
```jsx
|
|
<Mention
|
|
onChange={onChange}
|
|
suggestions={['afc163', 'benjycui', 'yiminghe', 'jljsj33', 'dqaria', 'RaoHai']}
|
|
/>
|
|
```
|
|
|
|
### Mention API
|
|
|
|
| API | 说明 | 类型 | 版本 |
|
|
| --- | --- | --- | --- |
|
|
| getMentions | 获取当前 contentState 中提到的人的列表 | Function(contentState: ContentState): string\[] | |
|
|
| toContentState | 把字符串转成 ContentState | Function(value: string): ContentState | |
|
|
| toString | 把 ContentState 转成字符串 | Function(contentState: ContentState): string | |
|
|
|
|
### Mention
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
| --- | --- | --- | --- | --- |
|
|
| autoFocus | 自动获取焦点 | boolean | false | |
|
|
| defaultValue | 默认值 | ContentState, 可以用 `Mention.toContentState(text)` 把文字转换成 ContentState | null | |
|
|
| defaultSuggestions | 默认建议内容 | Array<string\|Mention.Nav> | \[] | 3.12.0 |
|
|
| disabled | 是否禁用状态. | boolean | false | |
|
|
| getSuggestionContainer | 菜单渲染父节点。默认渲染到 body 上，如果你遇到菜单滚动定位问题，试试修改为滚动的区域，并相对其定位 | function() | () => document.body | |
|
|
| loading | 加载中 | boolean | false | |
|
|
| multiLines | 多行模式 | boolean | false | |
|
|
| notFoundContent | 未找到时的内容 | string | '无匹配结果，轻敲空格完成输入' | |
|
|
| placeholder | 输入框默认文字 | string | null | |
|
|
| placement | 建议框位置，可选 `top` `bottom` | string | 'bottom' | |
|
|
| prefix | 触发弹出下拉框的字符 | string or Array<string> | '@' | |
|
|
| readOnly | 是否只读. | boolean | false | |
|
|
| suggestions | 建议内容 | Array<string\|Mention.Nav> | \[] | |
|
|
| suggestionStyle | 弹出下拉框样式 | object | {} | |
|
|
| value | 值 | ContentState | null | |
|
|
| onBlur | 失去焦点时回调 | function(e) | null | |
|
|
| onChange | 输入框内容变化时回调 | function(contentState: ContentState) | null | |
|
|
| onFocus | 获得焦点时回调 | function(e) | null | |
|
|
| onSearchChange | 输入框中 @ 变化时回调 | function(value:string, trigger: string) | \[] | |
|
|
| onSelect | 下拉框选择建议时回调 | function(suggestion: string, data?: any) | null | |
|
|
|
|
### Mention 方法
|
|
|
|
| 名称 | 描述 | 版本 |
|
|
| ------- | -------- | ---- |
|
|
| blur() | 移除焦点 | |
|
|
| focus() | 获取焦点 | |
|
|
|
|
### Nav
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
| -------- | ---------------------------------------- | ------ | ------ | ---- |
|
|
| children | 建议内容 | object | {} | |
|
|
| value | 建议值，选择建议时，用此值插入到输入框中 | string | "" | |
|