Ant Design Blazor
Mentions
Mention component.
When To Use
When need to mention someone or something.
Examples
Basic usage.
Controlled mode, for example, to work with Form.
Configurate disabled and readOnly.
Customize the rendering of the textarea. Most common usecase will be to use the TextArea component.
When the list of matched content is returned asyncronously.
Customize Trigger Token by prefix props. Default to @, Array<string> also supported.
Change the suggestions placement.
Mentions API#
| Property | Description | Type | Default Value |
|---|---|---|---|
| ChildContent | Parameter | RenderFragment | -- |
| Disable | Parameter | Boolean | -- |
| Rows | Parameter | UInt32 | -- |
| Focused | Parameter | Boolean | -- |
| Readonly | Parameter | Boolean | -- |
| Loading | Parameter | Boolean | -- |
| Attributes | Parameter | Dictionary<String, Object> | -- |
| Placeholder | Parameter | String | -- |
| Value | Parameter | String | -- |
| ValueChanged | Parameter | EventCallback<String> | -- |
| LoadOptions | ParameterDynamically load mention options for display when the user types a value after the prefix symbol | Func<String, CancellationToken, Task<IEnumerable<MentionsDynamicOption>>> | -- |
| TextareaTemplate | Parameter | RenderFragment<MentionsTextareaTemplateOptions> | -- |
| Prefix | ParameterGets or sets the prefix used to identify special commands or keywords, split by ',' (e.g. "@,#"). | String | -- |
| OnSearch | ParameterTriggered when searching with prefix | EventCallback<ValueTuple<String, String>> | -- |
| Id | ParameterID for the component's HTML | String | Uniquely Generated ID |
| Class | ParameterSpecifies one or more class names for an DOM element. | String | -- |
| Style | ParameterSpecifies an inline style for a DOM element. | String | -- |
| RefBack | ParameterA ForwardRef instance. You can get a reference to the internal DOM by using AntDesign.ForwardRef.Current. |
ForwardRef | -- |
| Method Signature | Return Type | Description |
|---|---|---|
| GetMentionNames() | List<ValueTuple<String, String>> | |
| PrevOption() | void | |
| NextOption() | void | |
| EnterOption() | Task |
MentionsOption API#
| Property | Description | Type | Default Value |
|---|---|---|---|
| Value | ParameterThe value of option. | String | -- |
| ChildContent | ParameterThe content of option. | RenderFragment | -- |
| Hidden | Boolean | -- | |
| Id | ParameterID for the component's HTML | String | Uniquely Generated ID |
| Class | ParameterSpecifies one or more class names for an DOM element. | String | -- |
| Style | ParameterSpecifies an inline style for a DOM element. | String | -- |
| RefBack | ParameterA ForwardRef instance. You can get a reference to the internal DOM by using AntDesign.ForwardRef.Current. |
ForwardRef | -- |