vue-heart-rating v1.0.1

Heart Rating Component for Vue 3.x

A simple, highly customizable heart rating component for Vue 3.x.

This component is based on vue-star-rating, but it has been modified to use hearts instead of stars.

Features:

• SVG hearts - scale without loss of quality.
• Customisable rating increments.
• Customisable colors.
• Customisable number of hearts.
• Create read-only hearts.

Usage

Install Via NPM

Install via npm:

Vue 3.x Install

npm install vue-heart-rating

Once installed import in to your component:

import HeartRating from 'vue-heart-rating'

Then register vue-heart-rating using the components option:

components: {
  HeartRating
}

You can then use the following markup in your project:

<heart-rating />

Getting Started

To get started with vue-heart-rating you will want to sync the rating values between the component and parent, you can then take a look at the props and custom events section of the docs to customise your heart-rating component.

Syncing Rating Values with V-Model

vue-heart-rating supports v-model, which is the simplest way to keep your ratings in sync:

Vue 3.x

v-model works on the rating prop, so if you're using Vue 3 you will need to do:

<heart-rating v-model:rating="rating"></heart-rating>

Docs

Props

The following props can be passed to the component:

General Props

These props provide general functionailty to the heart rating component

Style Props

These props are used to style the heart rating component

Important: Vue requires you to pass numbers and boolean values using v-bind, any props that require a number or bool should use v-bind: or the colon (:) shorthand.

Props Example

<heart-rating v-bind:increment="0.5"
             v-bind:max-rating="3"
             inactive-color="#000"
             active-color="#f00"
             v-bind:heart-size="90">
</heart-rating>

Passing an Array of Colors

The active-color and active-border-color props also accept an array of colors. The colors in the array will be applied to the hearts in order, so index 0 will be the color of the first heart, index 1 will be the second and so on. Any array you pass will be padded if the number of elements in the array is less than the number of hearts. This means that the following code will color the first heart red and ALL remaining hearts black.

<heart-rating :active-color="['red','black']">
</heart-rating>

Custom Events

vue-heart-rating fires the following custom events, simply use v-on: or the @ shortand to capture the event.

Vue 3.x Events

Some changes have been made to event names in Vue 3

Vue 3.x Example

<heart-rating @update:rating ="setRating"></heart-rating>

Then in your view model:

const app = Vue.createApp({
  methods: {
    setRating(rating){
      this.rating= rating;
    }
  },
  data: {
    rating: 0
  }
})
app.component('heart-rating', VueHeartRating.default)
app.mount('#app')

Screen Reader Support

vue-heart-rating has built in support for screen readers. By default this message will read "Rated {{rating}} out of {{maxRating}} hearts", you can change this by using the screen-reader scoped slot:

<heart-rating>
    <template v-slot:screen-reader="slotProps">
        This product has been rated {{slotProps.rating}} out of {{slotProps.hearts}} hearts
    </template>
</heart-rating>

IE9 Support

vue-heart-rating supports IE 9+; make sure you place the following in the head of your webpage to ensure that IE is in standards mode:

<meta http-equiv="X-UA-Compatible" content="IE=Edge">