ant-design/components/mention/index.zh-CN.md
Bruce Mitchener 36508ffabd Typo fixes.
2016-11-16 20:33:37 +07:00

2.2 KiB

category subtitle type title
Components 提及 Data Entry Mention

提及组件。

何时使用

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

API

<Mention
  onChange={onChange}
  suggestions={['afc163', 'benjycui', 'yiminghe', 'jljsj33', 'dqaria', 'RaoHai']}
/>

Mention API

API 说明 类型
toString 把 EditorState 转成字符串 Function(editorState: EditorState): String
toEditorState 把字符串转成 EditorState Function(string: String): EditorState
getMentions 获取当前 editorState 中提到的人的列表 Function(editorState: EditorState): Array

Mention props

参数 说明 类型 默认值
suggestions 建议内容 Array or Array<Mention.Nav> []
suggestionStyle 弹出下拉框样式 Object {}
onSearchChange 输入框中 @ 变化时回调 function(value:String) []
onChange 输入框内容变化时回调 function(editorState: EditorState) null
onSelect 下拉框选择建议时回调 function(suggestion: String) null
notFoundContent 未找到时的内容 string '无匹配结果,轻敲空格完成输入'
loading 加载中 boolean false
multiLines 多行模式 boolean false
prefix 触发弹出下拉框的字符 string '@'
placeHolder 输入框默认文字 string null
defaultValue 默认值 EditorState, 可以用 Mention.toEditorState(text) 把文字转换成 EditorState null
value EditorState null
getSuggestionContainer 菜单渲染父节点。默认渲染到 body 上,如果你遇到菜单滚动定位问题,试试修改为滚动的区域,并相对其定位 Function() () => document.body

Nav props

参数 说明 类型 默认值
value 建议值,选择建议时,用此值插入到输入框中 string ""
children 建议内容 Object {}