bpk-component-rating

Backpack rating component.

Installation

npm install bpk-component-rating --save-dev

Usage

import React from 'react';
import BpkRating, { RATING_SIZES, RATING_SCALES } from 'bpk-component-rating';

export default () => (
  <BpkRating
    ariaLabel="4.8 Excellent 2,420 reviews"
    value={4.8}
    title="Excellent"
    subtitle="2,420 reviews"
  />

  // Large size rating
  <BpkRating
    ariaLabel="4.4 Very good 120 reviews"
    title="Very good"
    subtitle="120 reviews"
    size={RATING_SIZES.large}
    value={4.4}
  />

  // Title only rating
  <BpkRating
    ariaLabel="2.3 Bad"
    title="Bad"
    value={2.3}
  />

  // Show scale rating
  <BpkRating
    ariaLabel="3.8 Good 530 reviews"
    title="Good"
    subtitle="530 reviews"
    value={3.8}
  />

  // Hide scale rating
  <BpkRating
    ariaLabel="3.8 Good 530 reviews"
    title="Good"
    subtitle="530 reviews"
    value={3.8}
    showScale={false}
  />

  // 0-10 scale
  <BpkRating
    ariaLabel="9.9 Awesome 6,549 reviews"
    title="Awesome"
    subtitle="6,549 reviews"
    value={9.9}
    ratingScale={RATING_SCALES.zeroToTen}
  />
);

Props

Property	PropType	Required	Default Value
ariaLabel	string	true	-
title	oneOfType(string, node)	true	-
value	oneOfType(string, number)	true	-
className	string	false	null
ratingScale	oneOf(RATING_SCALES)	false	RATING_SCALES.zeroToFive
size	oneOf(RATING_SIZES)	false	RATING_SIZES.base
subtitle	string	false	null
showScale	boolean	false	true