logoAnt Design

⌘ K
  • Design
  • Development
  • Components
  • Blog
  • Resources
YouMindTRACTIANLobeHub
6.4.3
  • Components Overview
  • Changelog
    v6.4.3
  • General
    • Button
    • FloatButton
    • Icon
    • Typography
  • Layout
    • Divider
    • Flex
    • Grid
    • Layout
    • Masonry
      6.0.0
    • Space
    • Splitter
  • Navigation
    • Anchor
    • Breadcrumb
    • Dropdown
    • Menu
    • Pagination
    • Steps
    • Tabs
  • Data Entry
    • AutoComplete
    • Cascader
    • Checkbox
    • ColorPicker
    • DatePicker
    • Form
    • Input
    • InputNumber
    • Mentions
    • Radio
    • Rate
    • Select
    • Slider
    • Switch
    • TimePicker
    • Transfer
    • TreeSelect
    • Upload
  • Data Display
    • Avatar
    • Badge
    • Calendar
    • Card
    • Carousel
    • Collapse
    • Descriptions
    • Empty
    • Image
    • List
      DEPRECATED
    • Popover
    • QRCode
    • Segmented
    • Statistic
    • Table
    • Tag
    • Timeline
    • Tooltip
    • Tour
    • Tree
  • Feedback
    • Alert
    • Drawer
    • Message
    • Modal
    • Notification
    • Popconfirm
    • Progress
    • Result
    • Skeleton
    • Spin
    • Watermark
  • Other
    • Affix
    • App
    • BorderBeam
      6.4.0
    • ConfigProvider
    • Util
When To Use
Examples
Basic
Size
Variants
Asynchronous loading
With Form
Customize Trigger Token
disabled or readOnly
Placement
With clear icon
autoSize
Status
Custom semantic dom styling
API
Mention
Mention methods
Option
Semantic DOM
Design Token

Mentions

Used to mention someone or something in an input.
Importimport { Mentions } from 'antd';
GitHub
components/mentionsIssueOpen issues
Docs
Edit this pageLLMs.md
contributors
    InputNumberRadio

    Resources

    Ant Design X
    Ant Design Charts
    Ant Design Pro
    Pro Components
    Ant Design Mobile
    Ant Design Mini
    Ant Design Web3
    Ant Design Landing-Landing Templates
    Scaffolds-Scaffold Market
    Umi-React Application Framework
    dumi-Component doc generator
    qiankun-Micro-Frontends Framework
    Ant Motion-Motion Solution
    China Mirror 🇨🇳

    Community

    Awesome Ant Design
    Medium
    X
    yuque logoAnt Design in YuQue
    Ant Design in Zhihu
    Experience Cloud Blog
    seeconf logoSEE Conf-Experience Tech Conference

    Help

    GitHub
    Change Log
    FAQ
    Bug Report
    Issues
    Discussions
    StackOverflow
    SegmentFault

    Ant XTech logoMore Products

    yuque logoYuQue-Document Collaboration Platform
    AntV logoAntV-Data Visualization
    Egg logoEgg-Enterprise Node.js Framework
    Kitchen logoKitchen-Sketch Toolkit
    Galacean logoGalacean-Interactive Graphics Solution
    WeaveFox logoWeaveFox-AI Development with WeaveFox 🦊
    xtech logoAnt Financial Experience Tech
    Theme Editor
    Made with ❤ by
    Ant Group and Ant Design Community
    loading

    When To Use

    When you need to mention someone or something.

    Examples

    API

    Common props ref:Common props

    Mention

    PropertyDescriptionTypeDefaultVersion
    allowClearIf allow to remove mentions content with clear iconboolean | { clearIcon?: ReactNode, disabled?: boolean }false5.13.0, disabled: 6.4.0
    autoSizeTextarea height autosize feature, can be set to true | false or an object { minRows: 2, maxRows: 6 }boolean | objectfalse
    classNamesCustomize class for each semantic structure inside the component. Supports object or function.Record<SemanticDOM, string> | (info: { props })=> Record<SemanticDOM, string>-
    defaultValueDefault valuestring-
    filterOptionCustomize filter option logicfalse | (input: string, option: OptionProps) => boolean-
    getPopupContainerSet the mount HTML node for suggestions() => HTMLElement-
    notFoundContentSet mentions content when not matchReactNodeNot Found
    placementSet popup placementtop | bottombottom
    prefixSet trigger prefix keywordstring | string[]@
    splitSet split string before and after selected mentionstring
    sizeThe size of the input boxlarge | medium | small-
    statusSet validation status'error' | 'warning' | 'success' | 'validating'-4.19.0
    validateSearchCustomize trigger search logic(text: string, props: MentionsProps) => void-
    valueSet value of mentionsstring-
    variantVariants of Inputoutlined | borderless | filled | underlinedoutlined5.13.0 | underlined: 5.24.0
    onBlurTrigger when mentions lose focus() => void-
    onChangeTrigger when value changed(text: string) => void-
    onClearCallback when click the clear button() => void-5.20.0
    onFocusTrigger when mentions get focus() => void-
    onResizeThe callback function that is triggered when textarea resizefunction({ width, height })-
    onSearchTrigger when prefix hit(text: string, prefix: string) => void-
    onSelectTrigger when user select the option(option: OptionProps, prefix: string) => void-
    onPopupScrollTrigger when mentions scroll(e: Event) => void-5.23.0
    optionsOption ConfigurationOptions[]5.1.0
    stylesCustomize inline style for each semantic structure inside the component. Supports object or function.Record<SemanticDOM, CSSProperties> | (info: { props })=> Record<SemanticDOM, CSSProperties>-

    Mention methods

    NameDescription
    blur()Remove focus
    focus()Get focus

    Option

    PropertyDescriptionTypeDefault
    labelTitle of the optionReact.ReactNode-
    keyThe key value of the optionstring-
    disabledOptionalboolean-
    classNameclassNamestring-
    styleThe style of the optionReact.CSSProperties-

    Semantic DOM

    Design Token

    Component TokenHow to use?
    Token NameDescriptionTypeDefault Value
    activeBgBackground color when the input box is activatedstring#ffffff
    activeBorderColorActive border colorstring#1677ff
    activeShadowBox-shadow when activestring0 0 0 2px rgba(5,145,255,0.1)
    addonBgBackground color of addonstringrgba(0,0,0,0.02)
    controlItemWidthHeight of menu itemstring | number100
    dropdownHeightHeight of popupstring | number250
    errorActiveShadowBox-shadow when active in error statusstring0 0 0 2px rgba(255,38,5,0.06)
    hoverBgBackground color when the input box hoversstring#ffffff
    hoverBorderColorHover border colorstring#4096ff
    inputFontSizeFont sizenumber14
    inputFontSizeLGFont size of largenumber16
    inputFontSizeSMFont size of smallnumber14
    paddingBlockVertical padding of inputnumber4
    paddingBlockLGVertical padding of large inputnumber7
    paddingBlockSMVertical padding of small inputnumber0
    paddingInlineHorizontal padding of inputnumber11
    paddingInlineLGHorizontal padding of large inputnumber11
    paddingInlineSMHorizontal padding of small inputnumber7
    warningActiveShadowBox-shadow when active in warning statusstring0 0 0 2px rgba(255,215,5,0.1)
    zIndexPopupz-index of popupnumber1050
    Global TokenHow to use?
    Token NameDescriptionTypeDefault Value
    colorBgContainerContainer background color, e.g: default button, input box, etc. Be sure not to confuse this with `colorBgElevated`.string#ffffff
    colorBgContainerDisabledControl the background color of container in disabled state.stringrgba(0,0,0,0.04)
    colorBgElevatedContainer background color of the popup layer, in dark mode the color value of this token will be a little brighter than `colorBgContainer`. E.g: modal, pop-up, menu, etc.string#ffffff
    colorBorderDefault border color, used to separate different elements, such as: form separator, card separator, etc.string#d9d9d9
    colorBorderDisabledControl the border color of the element in the disabled state.string#d9d9d9
    colorErrorUsed to represent the visual elements of the operation failure, such as the error Button, error Result component, etc.string#ff4d4f
    colorErrorAffixControl the color of form control prefix/suffix in error state.string#ff4d4f
    colorErrorBgThe background color of the error state.string#fff2f0
    colorErrorBgHoverThe hover state background color of the error state.string#fff1f0
    colorErrorBorderHoverThe hover state border color of the error state.string#ffa39e
    colorErrorTextThe default state of the text in the error color.string#ff4d4f
    colorFillSecondaryThe second level of fill color can outline the shape of the element more clearly, such as Rate, Skeleton, etc. It can also be used as the Hover state of the third level of fill color, such as Table, etc.stringrgba(0,0,0,0.06)
    colorFillTertiaryThe third level of fill color is used to outline the shape of the element, such as Slider, Segmented, etc. If there is no emphasis requirement, it is recommended to use the third level of fill color as the default fill color.stringrgba(0,0,0,0.04)
    colorIconWeak action. Such as `allowClear` or Alert close buttonstringrgba(0,0,0,0.45)
    colorTextDefault text color which comply with W3C standards, and this color is also the darkest neutral color.stringrgba(0,0,0,0.88)
    colorTextDisabledControl the color of text in disabled state.stringrgba(0,0,0,0.25)
    colorTextPlaceholderControl the color of placeholder text.stringrgba(0,0,0,0.25)
    colorTextQuaternaryThe fourth level of text color is the lightest text color, such as form input prompt text, disabled color text, etc.stringrgba(0,0,0,0.25)
    colorWarningUsed to represent the warning map token, such as Notification, Alert, etc. Alert or Control component(like Input) will use these map tokens.string#faad14
    colorWarningAffixControl the color of form control prefix/suffix in warning state.string#faad14
    colorWarningBgThe background color of the warning state.string#fffbe6
    colorWarningBgHoverThe hover state background color of the warning state.string#fff1b8
    colorWarningBorderHoverThe hover state border color of the warning state.string#ffd666
    colorWarningTextThe default state of the text in the warning color.string#faad14
    borderRadiusBorder radius of base componentsnumber6
    borderRadiusLGLG size border radius, used in some large border radius components, such as Card, Modal and other components.number8
    borderRadiusSMSM size border radius, used in small size components, such as Button, Input, Select and other input components in small sizenumber4
    boxShadowSecondaryControl the secondary box shadow style of an element.string 0 6px 16px 0 rgba(0,0,0,0.08), 0 3px 6px -4px rgba(0,0,0,0.12), 0 9px 28px 8px rgba(0,0,0,0.05)
    controlHeightThe height of the basic controls such as buttons and input boxes in Ant Designnumber32
    controlHeightLGLG component heightnumber40
    controlHeightSMSM component heightnumber24
    controlItemBgHoverControl the background color of control component item when hovering.stringrgba(0,0,0,0.04)
    controlPaddingHorizontalControl the horizontal padding of an element.number12
    fontFamilyThe font family of Ant Design prioritizes the default interface font of the system, and provides a set of alternative font libraries that are suitable for screen display to maintain the readability and readability of the font under different platforms and browsers, reflecting the friendly, stable and professional characteristics.string-apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Arial, 'Noto Sans', sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol', 'Noto Color Emoji'
    fontSizeThe most widely used font size in the design system, from which the text gradient will be derived.number14
    fontSizeIconControl the font size of operation icon in Select, Cascader, etc. Normally same as fontSizeSM.number12
    fontWeightStrongControl the font weight of heading components (such as h1, h2, h3) or selected item.number600
    lineHeightLine height of text.number1.5714285714285714
    lineHeightLGLine height of large text.number1.5
    lineTypeBorder style of base componentsstringsolid
    lineWidthBorder width of base componentsnumber1
    marginXSControl the margin of an element, with a small size.number8
    motionDurationMidMotion speed, medium speed. Used for medium element animation interaction.string0.2s
    motionDurationSlowMotion speed, slow speed. Used for large element animation interaction.string0.3s
    paddingXXSControl the extra extra small padding of the element.number4
    Basic

    Basic usage.

    CodeSandbox Icon
    Hitu Icon
    codepen icon
    External Link Icon
    Expand Icon
    Variants

    Variants of Mentions, there are four variants: outlined filled borderless and underlined.

    CodeSandbox Icon
    Hitu Icon
    codepen icon
    External Link Icon
    Expand Icon
    With Form

    Controlled mode, for example, to work with Form.

    CodeSandbox Icon
    Hitu Icon
    codepen icon
    External Link Icon
    Expand Icon
    disabled or readOnly

    Configure disabled and readOnly.

    CodeSandbox Icon
    Hitu Icon
    codepen icon
    External Link Icon
    Expand Icon
    With clear icon

    Customize clear button.

    CodeSandbox Icon
    Hitu Icon
    codepen icon
    External Link Icon
    Expand Icon
    Status

    Add status to Mentions with status, which could be error or warning.

    CodeSandbox Icon
    Hitu Icon
    codepen icon
    External Link Icon
    Expand Icon
    Size

    Configure size via size property.

    CodeSandbox Icon
    Hitu Icon
    codepen icon
    External Link Icon
    Expand Icon
    6.0.0
    Asynchronous loading

    async.

    CodeSandbox Icon
    Hitu Icon
    codepen icon
    External Link Icon
    Expand Icon
    Customize Trigger Token

    Customize Trigger Token by prefix props. Default to @, Array<string> also supported.

    CodeSandbox Icon
    Hitu Icon
    codepen icon
    External Link Icon
    Expand Icon
    Placement

    Change the suggestions placement.

    CodeSandbox Icon
    Hitu Icon
    codepen icon
    External Link Icon
    Expand Icon
    autoSize

    Height autoSize.

    CodeSandbox Icon
    Hitu Icon
    codepen icon
    External Link Icon
    Expand Icon
    Custom semantic dom styling

    You can customize the semantic dom style of Mentions by passing objects/functions through classNames and styles. For example, set the textarea to be resizable.

    CodeSandbox Icon
    Hitu Icon
    codepen icon
    External Link Icon
    Expand Icon
    6.0.0




    Hi, @
    • root
      6.0.0
      Root element, set inline flex layout, relative positioning, padding and border styles
    • textarea
      6.0.0
      Textarea element, set font, line height, text input and background styles
    • suffix
      6.0.0
      Suffix element with layout and styling for suffix content like clear button, etc.
    • popup
      6.0.0
      Popup element, set absolute positioning, z-index, background color, border radius, shadow and dropdown options styles