npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@justeat/f-rating

v0.18.0

Published

Fozzie Rating - Global Rating component

Downloads

26

Readme

f-rating


npm version CircleCI Coverage Status Known Vulnerabilities


Usage

Installation

Install the module using npm or Yarn:

yarn add @justeat/f-rating
npm install @justeat/f-rating

Vue Applications

You can import it in your Vue SFC like this (please note that styles have to be imported separately):

import VRating from '@justeat/f-rating';
import '@justeat/f-rating/dist/f-rating.css';

export default {
    components: {
        VRating
    }
}

If you are using Webpack, you can import the component dynamically to separate the v-rating bundle from the main bundle.client.js:

import '@justeat/f-rating/dist/f-rating.css';

export default {
    components: {
        // …
        VRating: () => import(/* webpackChunkName: "v-rating" */ '@justeat/f-rating')
    }
}

Configuration

Props

There may be props that allow you to customise its functionality.

The props that can be defined are as follows (if any):

| Prop | Type | Required | Default | Description | Options | |:----------------------------|:---------:|:--------:|:---------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------| | starRating | Number | Yes | - | Sets the displayed rating (filled stars). i.e. for 2 out of x, 2 would be the starRating | - | maxStarRating | Number | No | 5 | Sets the maximum number of stars that the rating is set against. i.e. for x out of 5, 5 would be the maxStarRating You can use any number of stars, so if you currently need 6 all you have to do is pass in 6. | - | starRatingSize | String | No | 'small' | Sets the component size. By default the component will use small. Note: If you find that the size you currently use doesn't fall into one for the four size options here then please move up to the next available size. e.g if you use 22px as your rating size then you should move to 24px (medium) | xsmall = 16px small = 20px medium = 24px large = 32px | ratingDisplayType | String | No | 'short' | Sets the descriptive text which will be displayed next to the component. | short medium long | reviewCount | Number | No | null | Sets the total number of reviews to display. Example: View 499 reviews where 499 is the total. | - | isUserRating | Boolean | No | false | Sets the rating as (You) to indicate the rating viewed was left by the user. | - | shouldAlignRatingTextLeft | Boolean | No | false | When true is passed in, the rating display text will be set to the left hand side of the SVG stars. | - | ratingFontSize | String | No | 'default' | Sets the rating display font size, allowing a default size and a large size. | - | locale | String | No | '' | NOTE: If a locale isn't set then the consuming application is responsible for providing the component with the correct translations. | -

Events

The events that can be subscribed to are as follows (if any):

| Event | Description | | ----- | ----------- |

Development

Start by cloning the repository and installing the required dependencies:

$ git clone [email protected]:justeat/fozzie-components.git
$ cd fozzie-components
$ yarn

Change directory to the f-rating package:

$ cd packages/components/molecules/f-rating

Testing

To test all components, run from root directory. To test only f-rating, run from the ./fozzie-components/packages/components/molecules/f-rating directory.

Unit and Integration tests

yarn test

Component and Accessibility Tests

# Note: Ensure Storybook is running when running the following commands
cd ./fozzie-components

yarn storybook:build
yarn storybook:serve-static

yarn test-component:chrome

### Accessibility tests
```bash
yarn test-a11y:chrome

Documentation to be completed once module is in stable state.