Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://dreyescat.github.io/react-rating/
A rating react component with custom symbols.
https://dreyescat.github.io/react-rating/
rating-component react
Last synced: about 2 months ago
JSON representation
A rating react component with custom symbols.
- Host: GitHub
- URL: https://dreyescat.github.io/react-rating/
- Owner: dreyescat
- License: mit
- Created: 2015-07-19T22:19:58.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T21:45:06.000Z (over 1 year ago)
- Last Synced: 2024-05-17T23:02:24.320Z (4 months ago)
- Topics: rating-component, react
- Language: JavaScript
- Homepage: http://dreyescat.github.io/react-rating/
- Size: 5.99 MB
- Stars: 502
- Watchers: 12
- Forks: 91
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://badge.fury.io/js/react-rating)
# React Rating
React Rating is a [react](https://github.com/facebook/react) rating component which supports custom symbols both with [inline styles](https://facebook.github.io/react/tips/inline-styles.html) and glyphicons found in popular CSS Toolkits like [Fontawesome](http://fortawesome.github.io/Font-Awesome/icons/) or [Bootstrap](http://getbootstrap.com/components/).
This React component was inspired by the jQuery plugin [bootstrap-rating](https://github.com/dreyescat/bootstrap-rating).
## Demo
See [react-rating](http://dreyescat.github.io/react-rating/) in action.
## Installation
You can install `react-rating` component using the *npm* package manager:
```bash
npm install --save react-rating
```
### Dependencies
The `react-rating` component [peer depends](https://docs.npmjs.com/files/package.json#peerdependencies) on the [React](http://facebook.github.io/react/) library.
You can install React using *npm* too:
```bash
npm install --save react
```
## Upgrade Warning
If you are using a version of React Rating < v1.0 be aware that **there are API changes between anything < v1.0 and v1.0 .** See the **Properties** and **Deprecated Properties and Callbacks** sections below for a documentation of the current API and how it compares to the old.
## Usage
1. Require the Rating Component
```javascript
var Rating = require('react-rating');
```
2. Start using it
With raw javascript:
```javascript
React.createElement(Rating)
```
Or with JSX:
```jsx
```
## Properties
Property | Type | Default | Description
--- | --- | --- | ---
`start` | *number* | 0 | Range starting value (exclusive).
`stop` | *number* | 5 | Range stop value (inclusive).
`step` | *number* | 1 | Describes how many values each Symbol represents. For example, for a `start` value of 0, a `stop` value of 10 and a `step` of 2, we will end up with 5 Symbols, with each Symbol representing value increments of 2.
`fractions` | *number* | 1 | Number of equal subdivisions that can be selected as a rating in each Symbol. For example, for a `fractions` value of 2, you will be able to select a rating with a precision of down to half a Symbol. Must be >= 1
`initialRating` | *number* | 0 | The value that will be used as an initial rating. This is the old `initialRate`.
`placeholderRating` | *number* | 0 | If you do not define an `initialRating` value, you can use a placeholder rating. Visually, this will have the same result as if you had defined an `initialRating` value. If `initialRating` is set `placeholderRating` is not taken into account. This is the old `placeholderRate`
`readonly` | *bool* | false | Whether the rating can be modified or not.
`quiet` | *bool* | false | Whether to animate rate hovering or not.
`direction` | *ltr* or *rtl* | ltr | The direction of the rating element contents
`emptySymbol` | *element* or *object* or *string* or *array* | Style.empty | React element, inline style object, or classes applied to the rating symbols when empty. Can also be an array of such symbols that will be applied in a circular manner (round-robin). This is the old `empty`.
`fullSymbol` | *element* or *object* or *string* or *array* | Style.full | React element, inline style object, or classes applied to the rating symbols when full. Can also be an array of such symbols that will be applied in a circular manner (round-robin). This is the old `full`.
`placeholderSymbol` | *element* or *object* or *string* or *array* | Style.placeholder | React element, inline style object, or classes applied to the placeholder rating symbols. Can also be an array of such symbols that will be applied in a circular manner (round-robin). This is the old `placeholder`.
## Callbacks
Callback | Type | Description
--- | --- | ---
`onChange` | function (value) {} | Gets called with the `value` when a different value than the currently set is selected.
`onClick` | function (value) {} | Gets called with the `value` when a symbol is clicked. The value is equal to the value that corresponds to that part of the symbol.
`onHover` | function (value) {} | Gets called with the `value` when you hover over a symbol. The value is equal to the value that corresponds to that part of the symbol. Gets called in `quiet` mode too. When hover ends, gets called with no `value` (i.e. `undefined` as the value).
## Deprecated Properties and Callbacks
This is a list of deprecated properties and callbacks from versions older than v1.0
* `onRate`
* `initialRate`
* `placeholderRate`
* `empty`
* `full`
* `placeholder`
## License
[MIT License](https://github.com/dreyescat/react-rating/blob/master/LICENSE.md)