2.9.2 • Published 2 years ago

dw-neit-rc-rate v2.9.2

Weekly downloads
-
License
MIT
Repository
-
Last release
2 years ago

dw-neit-rc-rate

React Rate Component

NPM version dumi build status Test coverage gemnasium deps npm download

Screenshots

Changelog

Development

npm install
npm start

Example

install

dw-neit-rc-rate

Usage

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

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

with styled-components

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

const StyledRate = styled(Rate)`
  &.dw-neit-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

dw-neit-rc-rate is released under the MIT license.