0.1.7 • Published 4 years ago

rw-rate v0.1.7

Weekly downloads
3
License
MIT
Repository
github
Last release
4 years ago

rc-rate

React Rate Component

NPM version build status Test coverage gemnasium deps npm download

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';
import 'rc-rate/assets/index.css';

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

nametypedefaultdescription
countnumber5Star numbers
valuenumber-Controlled value
defaultValuenumber0Initial value
allowHalfbooleanfalseSupport half star
allowClearbooleantrueReset when click again
styleobject{}
onChangefunction(value) => {}onChange will be triggered when click
onHoverChangefunction(value) => {}onHoverChange will be triggered when hover on stars
characterReactNode | (props) => ReactNodeThe each character of rate
disabledbooleanfalse
directionstringltrThe 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.