Git Product home page Git Product logo

beauty-stars's Introduction

Welcome to beauty-stars ๐Ÿ‘‹

Coverage Status npm version License: MIT Twitter: leocardoso94_

A simple and beauty star rating for React projects

Install

npm install --save beauty-stars
// or
yarn add beauty-stars

Usage

import React, { Component } from "react";

import BeautyStars from "beauty-stars";

export default class App extends Component {
  state = { value: 0 };
  render() {
    return (
      <BeautyStars
        value={this.state.value}
        onChange={value => this.setState({ value })}
      />
    );
  }
}

API

This a list of props that you can pass down to the component:

Property Description Default value type
maxStars How many total stars you want 5 number
value Set rating value 0 number
editable Enable edit true boolean
inactiveColor Color of inactive star (this supports any CSS valid value) #121621 string
activeColor Color of selected or active star #FFED76 string
size Size of stars (in px) 36px string
onChange(newValue) Will be invoked any time the rating is changed undefined function
hideInactive Will hide inactive stars false boolean
gap Sets the gaps (gutters) between stars 16px string

Author

๐Ÿ‘ค Leocardoso94

Show your support

Give a โญ๏ธ if this project helped you!

beauty-stars's People

Contributors

dependabot-preview[bot] avatar leocardoso94 avatar mergify[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.