Components

Star Rating(React)

Display a star rating out of 5.0.

Version:9.3.0 View sourceChangelogReport issue
Install:yarn add @thumbtack/thumbprint-react
Import:import { StarRating } from '@thumbtack/thumbprint-react';

Basic examples

Sizes

StarRating with inline text

13 reviews

Event listeners

Props

StarRating

  • rating
    required

    Number from 0-5 at increments of 0.5. Numbers between these steps will be rounded.

    Type
    number
  • hoverRating

    Number from 0-5 at increments of 1. hoverRating trumps rating with respect to star highlighting.

    Type
    number
    Default
    0
  • size

    The size of the component when rendered

    Type
    oneOf([
      'small',
      'medium',
      'large',
    ])
    Default
    'small'
  • onStarClick

    Function that is called when a user clicks on a star. The function is supplied a single parameter: the index of the clicked star.

    Type
    func
    Default
    noop
  • onStarHover

    Function that is called when a user hovers over a star. The function is supplied a single parameter: the index of the hovered star.

    Type
    func
    Default
    noop
  • onMouseLeave

    Function that is called when a user mouses away from the StarRating component

    Type
    func
    Default
    noop