A rating component built with Stencil
MIT License
This is a basic rating web-component. It allows for a max rating to be set as well as user input (if required). If the user does select a rating then an event is fired, which can be handled in pure JS or by a framework of your choice. The component is fully customisable using a SVG polygon and can accept half-step ratings.
<script src='https://unpkg.com/[email protected]/dist/am-rating.js'></script>
on your pagenpm install am-rating --save
<script src='node_modules/am-rating/dist/am-rating.js'></script>
on your page##How to use
To include the component on your page use the <am-rating/>
tag. To set values for the display, you can add the following properties.
Properties for <am-rating>
**If you set interactive to true, the user will be able to tap on the element and assign a new rating. This will fire an event with the new rating.
***The item shape is an SVG polygon contained within a "0 0 100 100" viewbox. Use the svg-view-box property to change this.
Events fired by <am-rating>
Example:
<am-rating
reference="rating-widget-1"
rating="1.5"
min-rating="0"
max-rating="10"
color-on="green"
color-off="blue"
color-outline="#666"
direction="ltr"
allow-half-ratings="true"
interactive="true"
/>
<script>
window.addEventListener('ratingUpdated', (event) => {
const reference = event.detail.reference;
const rating = event.detail.rating;
});
</script>
##Contribute If you want to contribute then create a fork, make your changes and create a pull request.
Quick Start
To watch for file changes during develop, run:
npm run dev
To build the component for production, run:
npm run build
To run the unit tests for the components, run:
npm test
Need any more help? Check out the Stencil docs here.