mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-13 15:49:10 +08:00
20561d6f9d
* docs: init ref * docs all support * docs: fix link show
4.2 KiB
4.2 KiB
category | group | title | description | cover | coverDark | demo | ||
---|---|---|---|---|---|---|---|---|
Components | Data Entry | Mentions | Used to mention someone or something in an input. | https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*e4bXT7Uhi9YAAAAAAAAAAAAADrJ8AQ/original | https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*pxR2S53P_xoAAAAAAAAAAAAADrJ8AQ/original |
|
When To Use
When you need to mention someone or something.
Usage upgrade after 5.1.0
:::info
After version 5.1.0, we provide a simpler usage <Mentions options={[...]} />
with better performance and potential of writing simpler code style in your applications.
Meanwhile, we deprecated the old usage in browser console, we will remove it in antd 6.0.
:::
// works when >=5.1.0, recommended ✅
const options = [{ value: 'sample', label: 'sample' }];
return <Mentions options={options} />;
// works when <5.1.0, deprecated when >=5.1.0 🙅🏻♀️
return (
<Mentions onChange={onChange}>
<Mentions.Option value="sample">Sample</Mentions.Option>
</Mentions>
);
Examples
Basic
Variants
Asynchronous loading
With Form
Customize Trigger Token
disabled or readOnly
Placement
With clear icon
autoSize
Status
_InternalPanelDoNotUseOrYouWillBeFired
Component Token
API
Common props ref:Common props
Mention
Property | Description | Type | Default | Version |
---|---|---|---|---|
allowClear | Show clear button | boolean | { clearIcon?: ReactNode } | false | 5.13.0 |
autoFocus | Auto get focus when component mounted | boolean | false | |
autoSize | Textarea height autosize feature, can be set to true | false or an object { minRows: 2, maxRows: 6 } | boolean | object | false | |
defaultValue | Default value | string | - | |
filterOption | Customize filter option logic | false | (input: string, option: OptionProps) => boolean | - | |
getPopupContainer | Set the mount HTML node for suggestions | () => HTMLElement | - | |
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 | |
|
status | Set validation status | 'error' | 'warning' | 'success' | 'validating' | - | 4.19.0 |
validateSearch | Customize trigger search logic | (text: string, props: MentionsProps) => void | - | |
value | Set value of mentions | string | - | |
variant | Variants of Input | outlined | borderless | filled |
outlined |
5.13.0 |
onBlur | Trigger when mentions lose focus | () => void | - | |
onChange | Trigger when value changed | (text: string) => void | - | |
onFocus | Trigger when mentions get focus | () => void | - | |
onResize | The callback function that is triggered when textarea resize | function({ width, height }) | - | |
onSearch | Trigger when prefix hit | (text: string, prefix: string) => void | - | |
onSelect | Trigger when user select the option | (option: OptionProps, prefix: string) => void | - | |
options | Option Configuration | Options | [] | 5.1.0 |
Mention methods
Name | Description |
---|---|
blur() | Remove focus |
focus() | Get focus |
Option
Property | Description | Type | Default |
---|---|---|---|
label | Title of the option | React.ReactNode | - |
key | The key value of the option | string | - |
disabled | Optional | boolean | - |
className | className | string | - |
style | The style of the option | React.CSSProperties | - |