ant-design/components/mention/index.zh-CN.md

57 lines
2.3 KiB
Markdown
Raw Normal View History

2016-07-04 10:31:27 +08:00
---
category: Components
2016-09-21 11:28:38 +08:00
subtitle: 提及
type: Data Entry
2016-09-21 11:28:38 +08:00
title: Mention
2016-07-04 10:31:27 +08:00
---
2016-07-21 15:23:04 +08:00
提及组件。
2016-07-04 10:31:27 +08:00
## 何时使用
2016-07-21 15:41:40 +08:00
用于在输入中提及某人或某事,常用于发布、聊天或评论功能。
## API
2016-07-04 10:31:27 +08:00
2016-07-21 15:23:04 +08:00
```jsx
<Mention
onChange={onChange}
suggestions={['afc163', 'benjycui', 'yiminghe', 'jljsj33', 'dqaria', 'RaoHai']}
/>
2016-07-04 10:31:27 +08:00
```
### Mention API
2016-07-21 15:23:04 +08:00
| API | 说明 | 类型 |
|----------|---------------|----------|
| toString | 把 EditorState 转成字符串 | Function(editorState: EditorState): string |
| toEditorState | 把字符串转成 EditorState | Function(value: string): EditorState |
| getMentions | 获取当前 editorState 中提到的人的列表 | Function(editorState: EditorState): string[] |
2016-07-04 10:31:27 +08:00
### Mention props
| 参数 | 说明 | 类型 | 默认值 |
|----------|---------------|----------|--------------|
| suggestions | 建议内容 | Array<string\|Mention.Nav> | [] |
| suggestionStyle | 弹出下拉框样式 | object | {} |
| onSearchChange | 输入框中 @ 变化时回调 | function(value:string, trigger: string) | [] |
2016-07-19 13:39:05 +08:00
| onChange | 输入框内容变化时回调 | function(editorState: EditorState) | null |
| onSelect | 下拉框选择建议时回调 | function(suggestion: string, data?: any) | null |
2016-07-04 10:31:27 +08:00
| notFoundContent| 未找到时的内容 | string | '无匹配结果,轻敲空格完成输入' |
| loading | 加载中 | boolean | false |
| multiLines | 多行模式 | boolean | false |
| prefix | 触发弹出下拉框的字符 | string or Array<string> | '@' |
2017-01-22 19:49:08 +08:00
| placeholder | 输入框默认文字 | string | null |
2016-07-19 13:39:05 +08:00
| defaultValue | 默认值 | EditorState, 可以用 Mention.toEditorState(text) 把文字转换成 EditorState | null |
| value | 值 | EditorState | null |
| getSuggestionContainer | 菜单渲染父节点。默认渲染到 body 上,如果你遇到菜单滚动定位问题,试试修改为滚动的区域,并相对其定位| Function() | () => document.body |
| onFocus | 获得焦点时回调 | function() | null |
| onBlur | 失去焦点时回调 | function() | nul |
2016-07-04 10:31:27 +08:00
### Nav props
| 参数 | 说明 | 类型 | 默认值 |
|----------|---------------|----------|--------------|
| value | 建议值,选择建议时,用此值插入到输入框中 | string | "" |
| children | 建议内容 | object | {} |