@univerjs/design v0.5.0-beta.1 • Docs
Interface: MentionProps
Props definition for a mention subelement.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
appendSpaceOnAdd? | boolean | Append a space when a suggestion has been added | node_modules/.pnpm/@types+react-mentions@4.4.0/node_modules/@types/react-mentions/index.d.ts:147 |
className? | string | - | node_modules/.pnpm/@types+react-mentions@4.4.0/node_modules/@types/react-mentions/index.d.ts:121 |
data | null | SuggestionDataItem[] | DataFunc | An array of the mentionable data entries (objects with id & display keys, or a filtering function that returns an array based on a query parameter Default null | node_modules/.pnpm/@types+react-mentions@4.4.0/node_modules/@types/react-mentions/index.d.ts:143 |
displayTransform? | DisplayTransformFunc | Accepts a function for customizing the string that is displayed for a mention | node_modules/.pnpm/@types+react-mentions@4.4.0/node_modules/@types/react-mentions/index.d.ts:130 |
isLoading? | boolean | - | node_modules/.pnpm/@types+react-mentions@4.4.0/node_modules/@types/react-mentions/index.d.ts:137 |
markup? | string | A template string for the markup to use for mentions Default '@[__display__](__id__)' | node_modules/.pnpm/@types+react-mentions@4.4.0/node_modules/@types/react-mentions/index.d.ts:127 |
onAdd? | OnAddHandlerFunc | Callback invoked when a suggestion has been added | node_modules/.pnpm/@types+react-mentions@4.4.0/node_modules/@types/react-mentions/index.d.ts:117 |
regex? | RegExp | Allows providing a custom regular expression for parsing your markup and extracting the placeholder interpolations | node_modules/.pnpm/@types+react-mentions@4.4.0/node_modules/@types/react-mentions/index.d.ts:152 |
renderSuggestion? | SuggestionFunc | Allows customizing how mention suggestions are rendered | node_modules/.pnpm/@types+react-mentions@4.4.0/node_modules/@types/react-mentions/index.d.ts:120 |
style? | any | - | node_modules/.pnpm/@types+react-mentions@4.4.0/node_modules/@types/react-mentions/index.d.ts:144 |
trigger | string | RegExp | Defines the char sequence upon which to trigger querying the data source Default '@' | node_modules/.pnpm/@types+react-mentions@4.4.0/node_modules/@types/react-mentions/index.d.ts:136 |