mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-04 17:09:46 +08:00
1.5 KiB
1.5 KiB
| category | type | title | cover |
|---|---|---|---|
| Components | Data Entry | Rate | https://gw.alipayobjects.com/zos/alicdn/R5uiIWmxe/Rate.svg |
Rate component.
When To Use
- Show evaluation.
- A quick rating operation on something.
API
| Property | Description | type | Default | Version |
|---|---|---|---|---|
| allowClear | whether to allow clear when click again | boolean | true | |
| allowHalf | whether to allow semi selection | boolean | false | |
| autoFocus | get focus when component mounted | boolean | false | |
| character | custom character of rate | ReactNode | (RateProps) => ReactNode | <StarFilled /> |
Function(): 4.4.0 |
| className | custom class name of rate | string | ||
| count | star count | number | 5 | |
| defaultValue | default value | number | 0 | |
| disabled | read only, unable to interact | boolean | false | |
| style | custom style object of rate | CSSProperties | ||
| tooltips | Customize tooltip by each character | string[] | ||
| value | 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 |