ant-design/components/mentions/index.en-US.md
偏右 882cec62d6
docs: 🌈 Add Components overview page (#24491)
* docs: Add components overview page

* fix detail

* remove ContributorsList form overview page

* fix components url

* improve code style

* remove extra file

* fix detail

* fix lint

* fix lint

* docs: Finish components overview page

* fix lint

* docs: Update cover

* fix lint

* update cover

* update menu

* improve overview page

* refactor code

* fix order

* update title

* add components count

* fix overview page ssr bug

* move less file

* update title margin

Co-authored-by: arvinxx <arvinx@foxmail.com>
2020-05-31 11:48:34 +08:00

1.9 KiB

category type title cover
Components Data Entry Mentions https://gw.alipayobjects.com/zos/alicdn/0pF5j477V/Mentions.svg

Mention component.

When To Use

When need to mention someone or something.

API

<Mentions onChange={onChange}>
  <Mentions.Option value="sample">Sample</Mentions.Option>
</Mentions>

Mention

Property Description Type Default
autoFocus Auto get focus when component mounted boolean false
defaultValue Default value string
filterOption Customize filter option logic false | (input: string, option: OptionProps) => boolean
notFoundContent Set mentions content when not match ReactNode 'Not Found'
placement Set popup placement top | bottom bottom
prefix Set trigger prefix keyword string | string[] '@'
split Set split string before and after selected mention string ' '
validateSearch Customize trigger search logic (text: string, props: MentionsProps) => void
value Set value of mentions string
onChange Trigger when value changed (text: string) => void
onSelect Trigger when user select the option (option: OptionProps, prefix: string) => void
onSearch Trigger when prefix hit (text: string, prefix: string) => void
onFocus Trigger when mentions get focus () => void
onBlur Trigger when mentions lose focus () => void
getPopupContainer Set the mount HTML node for suggestions () => HTMLElement

Mention methods

Name Description
blur() remove focus
focus() get focus

Option

Property Description Type Default
children suggestion content ReactNode
value value of suggestion, the value will insert into input filed while selected string ''