Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

rc-rate

react-component6.2mMIT2.13.1TypeScript support: included

React Star Rate Component

react, react-component, react-rate, rate

readme

rc-rate

React Rate Component

NPM version npm download build status Codecov bundle size dumi

Screenshots

Changelog

Development

npm install
npm start

Example

install

rc-rate

Usage

import React from 'react';
import ReactDOM from 'react-dom';
import Rate from 'rc-rate';

ReactDOM.render(
  <Rate />,
  document.getElementById('root')
)

with styled-components

import React from 'react';
import ReactDOM from 'react-dom';
import Rate from 'rc-rate';
import styled from 'styled-components';

const StyledRate = styled(Rate)`
  &.rc-rate {
    font-size: ${({ size }) => size}px;
  }
`

ReactDOM.render(
  <StyledRate size="24" />,
  document.getElementById('root')
)

API

props

name type default description
count number 5 Star numbers
value number - Controlled value
defaultValue number 0 Initial value
allowHalf boolean false Support half star
allowClear boolean true Reset when click again
style object {}
onChange function (value) => {} onChange will be triggered when click
onHoverChange function (value) => {} onHoverChange will be triggered when hover on stars
character ReactNode | (props) => ReactNode The each character of rate
disabled boolean false
direction string ltr The direction of rate

Test Case

npm test
npm run chrome-test

Coverage

npm run coverage

open coverage/ dir

License

rc-rate is released under the MIT license.

changelog

Changelog

2.9.1

2020-11-17

  • fix: character type #102

2.9.0

2020-11-02

  • Update devDependencies include np/typescript/rc-tooltip
  • Add peerDependencies #97

2.8.2

2020-06-15

  • fix: improve defaultvalue more than half #86

  • fix: star tabindex when disabled #87

2.8.1

2020-06-12

  • feat: character support props #85

2.8.0

2020-06-10

  • feat: expand character #84

2.7.0

2020-05-29

  • 🆙 upgrade rc-util to 5.x

2.6.0

2020-04-16

  • feat: add direction rtl #80
  • chore: use father #81

2.4.1

  • Better accessibility support.

2.4.0

  • Add allowClear support.

2.3.0

  • Add keyboard support.
  • Add focus() blur() and autoFocus.

2.1.0

  • Fix typo charactor to character.

2.0.0

  • Add character.
  • Add className.
  • Add onHoverChange(value).