[ { "path": ".eslintrc", "content": "{\n \"parser\": \"babel-eslint\",\n \"ecmaFeatures\": {\n \"arrowFunctions\": true,\n \"templateStrings\": true,\n \"classes\": true,\n \"modules\": true,\n \"restParams\": true,\n \"jsx\": true\n },\n\n \"env\": {\n \"browser\": true,\n \"node\": true,\n \"es6\": true\n },\n\n \"globals\": {\n \"BROWSER\": true\n },\n\n \"rules\": {\n \"quotes\": 0,\n \"no-trailing-spaces\": 0,\n \"no-unused-vars\": 0,\n \"no-alert\": 0,\n \"strict\": 0\n }\n}" }, { "path": ".gitignore", "content": "node_modules\nbootstrap-star-rating\n./src/components/Review.jsx\nother\n.travis.yml\ncoverage\ndist\ntest\nkarma.conf.js\nwebpack.config.js" }, { "path": ".jshintrc", "content": "{\n \"curly\": true,\n \"eqeqeq\": true,\n \"immed\": true,\n \"latedef\": true,\n \"newcap\": false,\n \"noarg\": true,\n \"sub\": true,\n \"undef\": true,\n \"unused\": true,\n \"boss\": true,\n \"eqnull\": true,\n \"expr\": true,\n \"node\": true,\n \"browser\": true,\n \"devel\": true,\n \"esnext\": true\n}" }, { "path": ".npmignore", "content": "node_modules\nbootstrap-star-rating\nother\ntest\nkarma.conf.js\nwebpack.config.js" }, { "path": "LICENSE", "content": "The MIT License (MIT)\n\nCopyright (c) 2015 Cameron J Roe\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE." }, { "path": "README.md", "content": "# react-star-rating ![](https://david-dm.org/cameronjroe/react-star-rating.svg)\n\n[![NPM](https://nodei.co/npm/react-star-rating.png?compact=true)](https://nodei.co/npm/react-star-rating/)\n\n\n![](src/assets/star-rating.png)\n\n> A simple star rating component built with React.\n\n## Install\n\n```sh\n$ npm install react-star-rating --save\n```\n\nInclude the css:\n\n```html\n\n```\n\n## Usage\n\n### ES6\n```js\nimport React from 'react';\nimport StarRating from 'react-star-rating';\n\nclass FormComponent extends React.Component {\n render() {\n return (\n
\n \n \n \n );\n }\n}\n\nReact.render(, document.getElementById('star-rating'));\n```\n\n### ES5\n```js\nvar React = require('react');\nvar StarRating = require('react-star-rating');\n\nvar FormComponent = React.createClass({\n render: function () {\n return (\n
\n \n \n \n );\n }\n});\n\nReact.render(, document.getElementById('star-rating'));\n```\n\n## Options\n - **name**={string} - name for form input (required)\n - **caption**={string} - caption for rating (optional)\n - **totalStars**={number} - rating amount (required, default: 5)\n - **rating**={number} - a set rating between the rating amount (optional)\n - **disabled**={boolean} - whether to disable the rating from being selected (optional)\n - **editing**={boolean} - whether the rating is explicitly in editing mode (optional)\n - **size**={number} - size of stars (optional)\n - **onRatingClick**={function} - a handler function that gets called onClick of the rating (optional) - gets passed (event, {position, rating, caption, name})\n\n## Todo\n\n- [x] Fix ES6 bug with bundling\n- [x] Add svg stars\n- [x] Double-check touch support works\n- [ ] Re-implement star hovering (kinda janky right now)\n\n\n## License\n\n[MIT](https://github.com/cameronjroe/react-star-rating/blob/master/LICENSE)\n" }, { "path": "changelog.md", "content": "\n## v1.4.0 - 10.10.15\n - Changed ratingAmount to totalStars\n - Added SVG stars\n - Updated to React 0.14.x\n - Temporarily removed step support while react updates mask attribute" }, { "path": "index.html", "content": "\n\n\n \n \n React Star Rating\n \n \n \n \n \n\n\n \"Fork\n \n
\n \n \n\n" }, { "path": "package.json", "content": "{\n \"name\": \"react-star-rating\",\n \"version\": \"1.4.2\",\n \"description\": \"A simple star rating component built with React.\",\n \"main\": \"./dist/react-star-rating.min.js\",\n \"scripts\": {\n \"start\": \"npm run dev\",\n \"dev\": \"webpack serve\",\n \"build\": \"webpack\",\n \"test\": \"karma start ./test/karma.conf.js\",\n \"prepublish\": \"\"\n },\n \"repository\": \"cameronroe/react-star-rating\",\n \"license\": \"MIT\",\n \"dependencies\": {\n \"classnames\": \"^2.3.2\",\n \"react\": \"^18.2.0\",\n \"react-dom\": \"^18.2.0\"\n },\n \"devDependencies\": {\n \"@babel/core\": \"^7.19.6\",\n \"@babel/preset-env\": \"^7.19.4\",\n \"@babel/preset-react\": \"^7.18.6\",\n \"autoprefixer\": \"^10.4.13\",\n \"babel-eslint\": \"^10.1.0\",\n \"babel-loader\": \"^9.0.0\",\n \"chai\": \"^4.3.6\",\n \"cross-env\": \"^7.0.3\",\n \"css-loader\": \"^6.7.1\",\n \"eslint\": \"^8.26.0\",\n \"eslint-webpack-plugin\": \"^3.2.0\",\n \"html-webpack-plugin\": \"^5.5.0\",\n \"isparta\": \"^3.0.4\",\n \"istanbul-instrumenter-loader\": \"^2.0.0\",\n \"jshint-stylish\": \"^2.2.1\",\n \"karma\": \"^6.4.1\",\n \"karma-chai\": \"^0.1.0\",\n \"karma-chrome-launcher\": \"^3.1.1\",\n \"karma-coverage\": \"^2.2.0\",\n \"karma-mocha\": \"^2.0.1\",\n \"karma-phantomjs-launcher\": \"^1.0.4\",\n \"karma-sinon\": \"^1.0.5\",\n \"karma-sourcemap-loader\": \"^0.3.8\",\n \"karma-webpack\": \"^5.0.0\",\n \"mocha\": \"^10.1.0\",\n \"node-bourbon\": \"^4.2.8\",\n \"node-sass\": \"^7.0.3\",\n \"postcss\": \"^8.4.18\",\n \"postcss-loader\": \"^7.0.1\",\n \"react-addons-test-utils\": \"^15.6.2\",\n \"sass\": \"^1.55.0\",\n \"sass-loader\": \"^13.1.0\",\n \"sinon\": \"^14.0.1\",\n \"style-loader\": \"^3.3.1\",\n \"through2\": \"^4.0.2\",\n \"vinyl-source-stream\": \"^2.0.0\",\n \"webpack\": \"^5.74.0\",\n \"webpack-cli\": \"^4.10.0\",\n \"webpack-dev-server\": \"^4.11.1\",\n \"webpack-shell-plugin-next\": \"^2.2.2\"\n }\n}\n" }, { "path": "postcss.config.js", "content": "module.exports = {\n plugins: [\n require('autoprefixer')\n ]\n}\n" }, { "path": "src/StarRating.js", "content": "import React, { Component } from 'react';\nimport ReactDOM from 'react-dom';\nimport cx from 'classnames';\nimport { utils } from './utils';\nimport './sass/react-star-rating.scss';\n\nfunction isFloat(n) {\n return n === Number(n) && n % 1 !== 0;\n}\n\n// TODO\n// - Add support for svg symbol\n// - Add svg masking when react supports it\n// - Update onClick to onSelect which supports mobile, desktop\n// - Add onChange to trigger function when rating changes\n\n/**\n * @fileoverview react-star-rating\n * \n */\nclass StarRating extends Component {\n\n // static propTypes = {\n // name: React.PropTypes.string.isRequired,\n // caption: React.PropTypes.string,\n // totalStars: React.PropTypes.number.isRequired,\n // rating: React.PropTypes.number,\n // onRatingClick: React.PropTypes.func,\n // disabled: React.PropTypes.bool,\n // editing: React.PropTypes.bool,\n // size: React.PropTypes.number\n // }\n\n static defaultProps = {\n step: 1,\n totalStars: 5,\n onRatingClick() {},\n disabled: false,\n size: 50,\n rating: 0\n }\n\n constructor(props) {\n super(props);\n\n this.state = {\n currentRatingVal: props.rating,\n currentRatingPos: this.getStarRatingPosition(props.rating),\n editing: props.editing || true,\n rating: props.rating,\n pos: this.getStarRatingPosition(props.rating),\n glyph: this.getStars(),\n size: props.size\n };\n }\n\n componentWillMount() {\n this.min = 0;\n this.max = this.props.totalStars || 5;\n\n if (this.props.rating) {\n this.state.editing = this.props.editing || false;\n }\n }\n\n componentDidMount() {\n this.root = ReactDOM.findDOMNode(this.refs.root);\n this.ratingContainer = ReactDOM.findDOMNode(this.refs.ratingContainer);\n }\n\n componentWillUnmount() {\n delete this.root;\n delete this.ratingContainer;\n }\n\n /**\n * Gets the stars based on totalStars\n * @return {string} stars\n */\n getStars() {\n var stars = '';\n var numRating = this.props.totalStars;\n for(var i = 0; i < numRating; i++) {\n stars += '\\u2605';\n }\n return stars;\n }\n\n getWidthFromValue(val) {\n var min = this.min,\n max = this.max;\n if (val <= min || min === max) {\n return 0;\n }\n if (val >= max) {\n return 100;\n }\n return (val - min) * 100 / (max - min);\n }\n\n calculate(pos) {\n var val = utils.getValueFromPosition(pos, this.props.step, this.ratingContainer, this.min, this.max),\n width = this.getWidthFromValue(val);\n\n width += '%';\n return {width, val};\n }\n\n getStarRatingPosition(val) {\n return this.getWidthFromValue(val) + '%';\n }\n\n getRatingEvent(e) {\n let root = this.root;\n let pos = utils.getPosition(e, root);\n return this.calculate(pos);\n }\n\n /**\n * Get Star SVG\n */\n getSvg(rating) {\n let stars = [];\n for (let i = 0; i < this.props.totalStars; i++) {\n let attrs = {};\n attrs['transform'] = `translate(${i*50}, 0)`;\n attrs['fill'] = (i+this.props.step <= rating) ? '#FFA91B' : '#C6C6C6';\n stars.push(\n \n );\n }\n\n let styles = {\n width: `${stars.length * this.props.size}px`,\n height: `${this.props.size}px`\n };\n\n return (\n \n {/*\n React Doesn't support `mask` attributes yet\n \n \n \n \n */}\n \n {stars.map((item) => {\n return item;\n })}\n \n \n );\n }\n\n /**\n * Update the active rating selection\n * @param {number} width width based on mouse position\n * @param {number} val current rating amount\n */\n updateRating(width, val) {\n this.setState({\n pos: width,\n rating: val\n });\n }\n\n /**\n * Update rating state if props have changed\n */\n shouldComponentUpdate(nextProps, nextState) {\n if (nextProps !== this.props) {\n this.updateRating(\n this.getStarRatingPosition(nextProps.rating),\n nextProps.rating\n );\n return true;\n } else {\n return nextState.currentRatingVal !== this.state.currentRatingVal || nextState.rating !== this.state.rating;\n }\n }\n\n /**\n * Set position to original state\n */\n handleMouseLeave() {\n this.setState({\n pos: this.state.currentRatingPos,\n rating: this.state.currentRatingVal\n });\n }\n\n /**\n * Update position to current event state\n * @param {object} event\n */\n handleMouseMove(e) {\n // get hover position\n let ratingEvent = this.getRatingEvent(e);\n this.updateRating(\n ratingEvent.width,\n ratingEvent.val\n );\n }\n\n /**\n * Update rating state, Trigger function handler\n * @param {object} event\n */\n handleClick(e) {\n if (this.props.disabled) {\n e.stopPropagation();\n e.preventDefault();\n return false;\n }\n\n var payload = {\n currentRatingPos: this.state.pos,\n currentRatingVal: this.state.rating,\n caption: this.props.caption,\n name: this.props.name\n };\n\n this.setState(payload);\n\n this.props.onRatingClick(e, {\n rating: this.state.rating,\n position: this.state.pos,\n caption: this.props.caption,\n name: this.props.name\n });\n }\n\n getClasses() {\n return cx({\n 'rsr-root': true,\n 'rsr--disabled': this.props.disabled,\n 'rsr--editing': this.state.editing\n });\n }\n\n getCaption() {\n if (this.props.caption) {\n return ({this.props.caption});\n } else {\n return null;\n }\n }\n\n setAttrs(isState) {\n let attrs = {};\n if (isState) {\n attrs['onMouseMove'] = this.handleMouseMove.bind(this);\n attrs['onMouseLeave'] = this.handleMouseLeave.bind(this);\n attrs['onClick'] = this.handleClick.bind(this);\n }\n return attrs;\n }\n\n render() {\n\n let classes = this.getClasses();\n let caption = this.getCaption();\n let attrs = this.setAttrs(this.state.editing);\n\n return (\n \n {caption}\n
\n
\n {this.getSvg(this.state.rating)}\n \n
\n
\n \n );\n }\n}\n\nexport default StarRating;\n" }, { "path": "src/docs.html", "content": "\n\n\n \n \n <%= htmlWebpackPlugin.options.title %>\n \n \n \n\n\n \"Fork\n\n
\n\n\n\n" }, { "path": "src/docs.js", "content": "import React, { Component } from 'react';\nimport { createRoot } from 'react-dom/client';\nimport StarRating from './StarRating';\nimport pkg from '../package';\nimport './sass/demo.scss';\n\nconst inject = document.querySelector('.inject');\nconst root = createRoot(inject);\n\nclass Docs extends Component {\n\n handleRatingClick(e, data) {\n console.log(data);\n alert('You left a ' + data.rating + ' star rating for ' + data.name);\n }\n\n render() {\n var currentVersion = pkg.version;\n\n return (\n
\n
\n

\n {'react-star-rating'}\n easy star ratings with Test\n

\n \n

v{currentVersion}

\n View on Github\n
\n
\n

Installation

\n
\n \n {'$ npm install react-star-rating --save'}\n \n

Include the css:

\n \n {''}\n \n

Usage

\n
\n
\n \n \n \n

ES6

\n \n

{'import React from \\'react\\''}

\n

{'import StarRating from \\'react-star-rating\\''}

\n

{' '}

\n

{'class FormComponent extends React.Component {'}

\n

{' render() { '}

\n

{' return ('}

\n

{'

'}

\n

{' '}

\n

{' '}

\n

{'

'}

\n

{' );'}

\n

{' }'}

\n

{'}'}

\n

{' '}

\n

{'React.render(, document.getElementById(\\'star-rating\\'));'}

\n \n

ES5

\n \n

{'var React = require(\\'react\\');'}

\n

{'var StarRating = require(\\'react-star-rating\\');'}

\n

{' '}

\n

{'var FormComponent = React.createClass({'}

\n

{' render: function () { '}

\n

{' return ('}

\n

{'

'}

\n

{' '}

\n

{' '}

\n

{'

'}

\n

{' );'}

\n

{' }'}

\n

{'});'}

\n

{' '}

\n

{'React.render(, document.getElementById(\\'star-rating\\'));'}

\n \n

Options

\n
\n
    \n
  • name{'={string} - name for form input (required)'}
    • \n
  • caption{'={string} - caption for rating (optional)'}
    • \n
  • totalStars{'={number} - rating amount (required, default: 5)'}
    • \n
  • rating{'={number} - a set rating between the rating amount (optional)'}
    • \n
  • disabled{'={boolean} - whether to disable the rating from being selected (optional)'}
    • \n
  • editing{'={boolean} - whether the rating is explicitly in editing mode (optional)'}
    • \n
  • size{'={number} - size of stars (optional)'}
    • \n
  • onRatingClick{'={function} - a handler function that gets called onClick of the rating (optional) - gets passed (event, {position, rating, caption, name})'}
    • \n
\n

Examples

\n
\n \n

\n \n

{'// handler in react class'}

\n

{'handleRatingClick: function (e, data) {'}

\n

{' alert(\\'You left a \\' + data.rating + \\' star rating for \\' + data.caption);'}

\n

{'}'}

\n

{' '}

\n

{''}

\n \n

\n
{'If you\\'re using ES6, make sure to bind the handler: '}{'this.handleRatingClick.bind(this, pass, args, here)'}
\n \n \n {''}\n \n {/*\n \n {''}\n */}\n \n \n {''}\n \n \n \n {''}\n \n \n \n {''}\n \n \n \n {''}\n \n \n \n {''}\n \n
\n \n
\n );\n }\n\n}\n\nroot.render();\n" }, { "path": "src/sass/demo.scss", "content": "@import \"bourbon\";\n\nhtml, body {\n font-size: 16px;\n margin: 0;\n padding-bottom: 2em;\n font-family: 'Times';\n}\n\nh1, h2, h3, h4, h5, h6 {\n font-family: 'Philosopher', sans-serif;\n}\n\ncode {\n color: #444;\n padding: 2em;\n line-height: 1.5;\n margin-top: 2em;\n margin-bottom: 2.5em;\n min-width: 100%;\n display: inline-block;\n box-shadow: inset 0px 0px 7px rgba(210, 210, 210, 0.54);\n background-color: rgba(210, 210, 210, 0.24);\n white-space: pre-wrap;\n}\n\niframe {\n border: 0;\n display: inline-block;\n vertical-align: middle;\n}\n\nul li {\n margin: 0.5em 0;\n font-size: 1.2em;\n}\n\nfooter {\n text-align: center;\n}\n\n.btn {\n border-radius: 2px;\n}\n\n.btn-primary {\n background-color: #F5A71B;\n color: #fff;\n border: 0;\n text-transform: uppercase;\n font-size: 12px;\n font-weight: bold;\n margin: 0 1.5em;\n letter-spacing: 1px;\n &:active, &:hover, &:focus {\n outline: 0;\n color: #fff;\n background-color: darken(#F5A71B, 10%);\n }\n}\n\n.demo-form {\n fieldset {\n display: inline-block;\n }\n}\n\n.footer-creds {\n display: inline-block;\n letter-spacing: 1px;\n opacity: 0.8;\n}\n\n.intro {\n color: #fff;\n background: linear-gradient(#444, #333) left repeat;\n padding: 8em 0;\n box-shadow: inset 0px 0px 7px #000;\n text-align: center;\n .react-star-rating {\n text-align: center;\n }\n}\n\n.main-title {\n font-size: 4em;\n letter-spacing: 1px;\n text-align: center;\n > small {\n display: block;\n font-size: 0.5em;\n }\n}\n\n.ratings-wrap {\n max-width: 980px;\n margin: 0 auto;\n padding: 4em;\n border-radius: 5px;\n}\n" }, { "path": "src/sass/react-star-rating.scss", "content": "@import \"bourbon\";\n\n.rsr-root {\n vertical-align: middle;\n display: inline-block;\n}\n\n.rsr--editing {\n &:hover {\n cursor: pointer;\n }\n}\n\n.rsr {\n position: relative;\n vertical-align: middle;\n display: inline-block;\n color: #e3e3e3;\n overflow: hidden;\n}\n\n.rsr__stars {\n position: absolute;\n left: 0;\n top: 0;\n white-space: nowrap;\n overflow: hidden;\n color: #F5A71B;\n transition: all 0.01s;\n}\n\n.rsr__caption {\n font-size: 1.25em;\n vertical-align: middle;\n margin-right: 0.5em;\n}\n\n.rsr--disabled {\n .rsr-container:hover {\n cursor: not-allowed;\n }\n}\n" }, { "path": "src/utils.js", "content": "\nfunction getDecimalPlaces(num) {\n var match = ('' + num).match(/(?:\\.(\\d+))?(?:[eE]([+-]?\\d+))?$/);\n return !match ? 0 : Math.max(0, (match[1] ? match[1].length : 0) - (match[2] ? +match[2] : 0));\n}\n\nfunction applyPrecision(val, precision) {\n return parseFloat(val.toFixed(precision));\n}\n\nexport const utils = {\n /**\n * Gets the mouse position\n * @param {event} e\n * @return {number} delta\n */\n getPosition(e, root) {\n return e.clientX - root.getBoundingClientRect().left;\n },\n\n treatName(title) {\n if (typeof title === 'string') {\n return title.toLowerCase().split(' ').join('_');\n }\n },\n\n getValueFromPosition(pos, step, container, min, max) {\n var precision = getDecimalPlaces(step);\n var maxWidth = container.offsetWidth;\n var diff = max - min;\n var factor = (diff * pos) / (maxWidth * step);\n factor = Math.ceil(factor);\n var val = applyPrecision(parseFloat(min + factor * step), precision);\n val = Math.max(Math.min(val, max), min);\n return val;\n }\n\n}\n" } ]