ant-design/components/rate/index.en-US.md
2017-03-06 14:23:38 +08:00

28 lines
896 B
Markdown

---
category: Components
type: Data Entry
title: Rate
---
Rate component.
## When To Use
- Show evaluation.
- A quick rating operation on something.
## API
| Property | Description | type | Default |
|------------|----------------|-------------------|-------------|
| count | star count | number | 5 |
| value | current value | number | - |
| defaultValue | default value | number | 0 |
| onChange | callback when select value | Function(value: number) | - |
| onHoverChange | callback when hover item | Function(value: number) | - |
| allowHalf | whether to allow semi selection | boolean | false |
| disabled | read only, unable to interact | boolean | false |
| character | custom character of rate | ReactNode | `<Icon type="star" />` |
| className | custom class name of rate | string | - |
| style | custom style object of rate | object | - |