Skip to content

vinayakkulkarni/v-rating

Repository files navigation

V-Rating ⚡ Build Status FOSSA Status

github release npm version npm downloads

  • Simple ui rating component for Vue made with Semantic-UI.

  • This is on GitHub so let me know if I've b0rked it somewhere, give me a star ⭐ if you like it 🍻

  • Demo here -> 💯 Codesandbox Link

Requirements

✅ Install 👌

npm install v-rating
// or
yarn add v-rating

CDN: UNPKG | jsDelivr (available as window.VRating)

✅ Usage 🎓

Register the component globally:

Vue.component('Rating', require('v-rating'));

Or use locally

import Rating from 'v-rating';

✅ Example 1 🍀

<rating v-model="yourLocalVariable" class="huge heart"></rating>
Vue.component('example-component', {
	data() {
		return {
			yourLocalVariable: 0,
		};
	}
});

✅ 📖 Props

Name Type Required? Default Description
type String No star The type of rating component will it be? SUI has stars &heart.
clearable Boolean No true Whether the rating is clearable or not. Read the SUI Docs on this
max String No 5 A number representing the maximum ratings that can be made available.
initial String No 0 A number representing the default rating to apply.

NPM :octocat:

NPM

License

FOSSA Status