react-custom-ratings - npm Package Compare versions

Comparing version 0.1.73 to 0.1.74

package.json

 {
-  "version": "0.1.73",
+  "version": "0.1.74",
   "license": "MIT",
@@ -80,2 +80,2 @@ "main": "dist/index.js",
   }
-}
+}

README.md

@@ -5,2 +5,3 @@ **react-custom-ratings**
 **Installation**
+
 ```
@@ -10,42 +11,42 @@ npm install react-custom-ratings
 
-**Usage** 
-  ```
-  import {Ratings, Rating, ProgressBar} from 'react-custom-ratings' 
-  
-  const Demo=()=>{
-    return(
-      <!--  Use Ratings component to display both ratings and progress bar -->
-     <Ratings data={[{count:10,rating:5},{count:13,rating:4},{count:10,rating:3},{count:8,rating:2},{count:4,rating:1}]}/>
-      <!--    Use Rating component to display ratings   -->
-     <Rating  data={[{count:10,rating:5},{count:13,rating:4},{count:10,rating:3},{count:8,rating:2},{count:4,rating:1}]}/>
-      <!--   Use ProgresBar component to display ProgressBar    -->
-     <ProgressBar  data={[{count:10,rating:5},{count:13,rating:4},{count:10,rating:3},{count:8,rating:2},{count:4,rating:1}]}/>
-    )};
-  
-   ```
-  
+**Usage**
+
+```
+import {Ratings, Rating, ProgressBar} from 'react-custom-ratings'
+
+const Demo=()=>{
+  return(
+    <!--  Use Ratings component to display both ratings and progress bar -->
+   <Ratings data={[{count:10,rating:5},{count:13,rating:4},{count:10,rating:3},{count:8,rating:2},{count:4,rating:1}]}/>
+    <!--    Use Rating component to display ratings   -->
+   <Rating  data={[{count:10,rating:5},{count:13,rating:4},{count:10,rating:3},{count:8,rating:2},{count:4,rating:1}]}/>
+    <!--   Use ProgresBar component to display ProgressBar    -->
+   <ProgressBar  data={[{count:10,rating:5},{count:13,rating:4},{count:10,rating:3},{count:8,rating:2},{count:4,rating:1}]}/>
+  )};
+
+```
+
 **API**
 
 This a list of props that you can pass down to the Ratings component:
-| Property    | Description | Default Value|Type|
+| Property | Description | Default Value|Type|
 | ----------- | ----------- | ------------ |----|
 |data|Data for Ratings|NA|array|
-| options     | **Props applied to the Rating and ProgressBar elements.**|{ratings:{},progressBar:{}}|object
+| options | Props applied to the Rating and ProgressBar elements.|{ratings:{},progressBar:{}}|object|
 
-
 List of props that you can pass down to the Rating Component:
 
-| Property    | Description | Default Value|Type|
-| ----------- | ----------- | ------------ |----|
-|show|If it is true the rating component is visible |true|boolean|
-|filledColor|Filled rating icon color|'#ffa41c'|string|
-|unfilledColor|Empty rating icon color|'#ffa41c'|string|
-|ratingIconClassname|Classname for rating Icon|'star'|string|
-|className|classname for rating header text|'rating'|string|
-|FilledRatingIcon|Custom react element for filled rating icon|<AiFillStar/> from react-icons|React element|
-|UnfilledRatingIcon|Custom react element for unfilled rating icon|<AiOutlineStar /> from react-icons|React element|
-|headerText|headerText is function which takes 'percent' type of number as parameter and returns react element|NA|(percent: number) => React.ReactElement;
+| Property            | Description                                                                                        | Default Value                      | Type                                     |
+| ------------------- | -------------------------------------------------------------------------------------------------- | ---------------------------------- | ---------------------------------------- |
+| show                | If it is true the rating component is visible                                                      | true                               | boolean                                  |
+| filledColor         | Filled rating icon color                                                                           | '#ffa41c'                          | string                                   |
+| unfilledColor       | Empty rating icon color                                                                            | '#ffa41c'                          | string                                   |
+| ratingIconClassname | Classname for rating Icon                                                                          | 'star'                             | string                                   |
+| className           | classname for rating header text                                                                   | 'rating'                           | string                                   |
+| FilledRatingIcon    | Custom react element for filled rating icon                                                        | <AiFillStar/> from react-icons     | React element                            |
+| UnfilledRatingIcon  | Custom react element for unfilled rating icon                                                      | <AiOutlineStar /> from react-icons | React element                            |
+| headerText          | headerText is function which takes 'percent' type of number as parameter and returns react element | NA                                 | (percent: number) => React.ReactElement; |
 
 List of props that you can pass down to the ProgressBar Component:
-| Property    | Description | Default Value|Type|
+| Property | Description | Default Value|Type|
 | ----------- | ----------- | ------------ |----|
@@ -55,12 +56,12 @@ |filledColor|Filled start rating color|'#ffa41c'|string|
 |className|classname for rating header text|'rating'|string|
-|progressBarText|To display custom text on left side of progress bar use progressBarText function.progressBarText takes function with parameter 'data'  which should return react element|(data) => React.ReactElement;|React Element|
+|progressBarText|To display custom text on left side of progress bar use progressBarText function.progressBarText takes function with parameter 'data' which should return react element|(data) => React.ReactElement;|React Element|
 |percentage|To display custom percentage of ratings on rigt side of progress bar use percentage function.perecentage takes fucntion with two parameters 'data and 'percent' which should return react element|(percent: number, data) => React.ReactElement;|React Element|
 |onClick|onClick is event handler function which gets executed when clicked on any of the progress bar,first parameter for onClick function is data of the progress bar clicked on. |(data) => void;|Function
-  
+
 **Help improve the component**  
-   Build on your machine:
-   # Clone the repo 
-     git clone https://github.com/Roxiler/react-ratings.git
+ Build on your machine:
+**Clone the repo**
+git clone https://github.com/Roxiler/react-ratings.git
 
-   # Install dependancies 
-     npm install
+**Install dependancies**  
+ npm install

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

111405

increased by1.09%

Number of lines in readme file

65

increased by1.56%

No dependency changes