Rate

Rate component.

When To Use#

Show evaluation.
A quick rating operation on something.

Examples

The simplest usage.

import { Rate } from 'antd';

ReactDOM.render(<Rate />, mountNode);

3 stars

Show copywriting

Add copywriting in rate components.

import { Rate } from 'antd';

class Rater extends React.Component {
  state = {
    value: 3,
    count: null,
  }
  handleChange = (value) => {
    this.setState({ value });
  }
  render() {
    const { value } = this.state;
    return (
      <span>
        <Rate onChange={this.handleChange} value={value} />
        {value && <span className="ant-rate-text">{value} stars</span>}
      </span>
    );
  }
}

ReactDOM.render(<Rater />, mountNode);

好
好
好
好
好
好
好
好
好
好

Other Character

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

import { Rate, Icon } from 'antd';

ReactDOM.render(
  <div>
    <Rate character={<Icon type="heart" />} allowHalf />
    <br />
    <Rate character="A" allowHalf style={{ fontSize: 36 }} />
    <br />
    <Rate character="好" allowHalf />
  </div>
, mountNode);

Half star

Support select half star.

import { Rate } from 'antd';

ReactDOM.render(<Rate allowHalf defaultValue={2.5} />, mountNode);

Read only

Read only, can't use mouse to interact.

import { Rate } from 'antd';

ReactDOM.render(<Rate disabled defaultValue={2} />, mountNode);

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	-

Components

Rate

When To Use#

Examples

API#