mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-13 07:39:10 +08:00
2f8fa45df3
* docs: update rootClassName description * docs: update rootClassName description * docs: update docs
2.3 KiB
2.3 KiB
| category | group | title | cover | coverDark | demo | ||
|---|---|---|---|---|---|---|---|
| Components | Data Entry | Rate | https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*oyOcTrB12_YAAAAAAAAAAAAADrJ8AQ/original | https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*M7_ER7GJr6wAAAAAAAAAAAAADrJ8AQ/original |
|
Rate component.
When To Use
- Show evaluation.
- A quick rating operation on something.
Examples
Basic
Half star
Show copywriting
Read only
Clear star
Other Character
Customize character
Component Token
API
Common props ref：Common props
| Property | Description | type | Default | Version |
|---|---|---|---|---|
| allowClear | Whether to allow clear when click again | boolean | true | |
| allowHalf | Whether to allow semi selection | boolean | false | |
| autoFocus | If get focus when component mounted | boolean | false | |
| character | The custom character of rate | ReactNode | (RateProps) => ReactNode | <StarFilled /> | function(): 4.4.0 |
| className | The custom class name of rate | string | - | |
| count | Star count | number | 5 | |
| defaultValue | The default value | number | 0 | |
| disabled | If read only, unable to interact | boolean | false | |
| style | The custom style object of rate | CSSProperties | - | |
| tooltips | Customize tooltip by each character | string[] | - | |
| value | The current value | number | - | |
| onBlur | Callback when component lose focus | function() | - | |
| onChange | Callback when select value | function(value: number) | - | |
| onFocus | Callback when component get focus | function() | - | |
| onHoverChange | Callback when hover item | function(value: number) | - | |
| onKeyDown | Callback when keydown on component | function(event) | - |
Methods
| Name | Description |
|---|---|
| blur() | Remove focus |
| focus() | Get focus |