logoAnt Design

⌘ K
  • Design
  • Development
  • Components
  • Blog
  • Resources
5.25.2
  • Components Overview
  • General
    • Button
    • FloatButton
      5.0.0
    • Icon
    • Typography
  • Layout
    • Divider
    • Flex
      5.10.0
    • Grid
    • Layout
    • Space
    • Splitter
      5.21.0
  • Navigation
    • Anchor
    • Breadcrumb
    • Dropdown
    • Menu
    • Pagination
    • Steps
    • Tabs
  • Data Entry
    • AutoComplete
    • Cascader
    • Checkbox
    • ColorPicker
      5.5.0
    • 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
    • Popover
    • QRCode
      5.1.0
    • Segmented
    • Statistic
    • Table
    • Tag
    • Timeline
    • Tooltip
    • Tour
      5.0.0
    • Tree
  • Feedback
    • Alert
    • Drawer
    • Message
    • Modal
    • Notification
    • Popconfirm
    • Progress
    • Result
    • Skeleton
    • Spin
    • Watermark
      5.1.0
  • Other
    • Affix
    • App
      5.1.0
    • ConfigProvider
    • Util
      5.13.0

Rate

Used for rating operation on something.
Importimport { Rate } from "antd";
Sourcecomponents/rate
Docs
Edit this pageChangelog

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
Twitter
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
xtech logoAnt Financial Experience Tech
Theme Editor
Made with ❤ by
Ant Group and Ant Design Community

When To Use

  • Show evaluation.
  • A quick rating operation on something.

Examples

API

Common props ref:Common props

PropertyDescriptiontypeDefaultVersion
allowClearWhether to allow clear when click againbooleantrue
allowHalfWhether to allow semi selectionbooleanfalse
autoFocusIf get focus when component mountedbooleanfalse
characterThe custom character of rateReactNode | (RateProps) => ReactNode<StarFilled />function(): 4.4.0
classNameThe custom class name of ratestring-
countStar countnumber5
defaultValueThe default valuenumber0
disabledIf read only, unable to interactbooleanfalse
keyboardSupport keyboard operationbooleantrue5.18.0
styleThe custom style object of rateCSSProperties-
tooltipsCustomize tooltip by each characterstring[]-
valueThe current valuenumber-
onBlurCallback when component lose focusfunction()-
onChangeCallback when select valuefunction(value: number)-
onFocusCallback when component get focusfunction()-
onHoverChangeCallback when hover itemfunction(value: number)-
onKeyDownCallback when keydown on componentfunction(event)-

Methods

NameDescription
blur()Remove focus
focus()Get focus

Design Token

Component TokenHow to use?
Token NameDescriptionTypeDefault Value
starBgStar background colorstringrgba(0,0,0,0.06)
starColorStar colorstring#fadb14
starHoverScaleScale of star when hoverundefined | readonly string[] | Transform | readonly Transform[] | { _multi_value_?: boolean; _skip_check_?: boolean; value: readonly string[] | Transform | (readonly string[] | Transform | undefined)[] | undefined }scale(1.1)
starSizeStar sizenumber20
Global TokenHow to use?
Basic

The simplest usage.

CodeSandbox Icon
codeblock
codepen icon
External Link Icon
expand codeexpand code
Show copywriting

Add copywriting in rate components.

CodeSandbox Icon
codeblock
codepen icon
External Link Icon
expand codeexpand code
Clear star

Support set allow to clear star when click again.

CodeSandbox Icon
codeblock
codepen icon
External Link Icon
expand codeexpand code
Customize character

Can customize each character using (RateProps) => ReactNode.

CodeSandbox Icon
codeblock
codepen icon
External Link Icon
expand codeexpand code
Half star

Support select half star.

CodeSandbox Icon
codeblock
codepen icon
External Link Icon
expand codeexpand code
Read only

Read only, can't use mouse to interact.

CodeSandbox Icon
codeblock
codepen icon
External Link Icon
expand codeexpand code
Other Character

Replace the default star to other character like alphabet, digit, iconfont or even Chinese word.

CodeSandbox Icon
codeblock
codepen icon
External Link Icon
expand codeexpand code
normal
allowClear: true
allowClear: false
  • 1
    1
  • 2
    2
  • 3
    3
  • 4
    4
  • 5
    5
  • A
    A
  • A
    A
  • A
    A
  • A
    A
  • A
    A
  • 好
    好
  • 好
    好
  • 好
    好
  • 好
    好
  • 好
    好