anoblet / mwc-star-rating

5-star rating element following open-wc recommendations

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

<mwc-star-rating>

This webcomponent follows the open-wc recommendation.

Published on NPM Node.js Package license

Installation

npm i @cwmr/mwc-star-rating

Usage

<link href="https://fonts.googleapis.com/css?family=Material+Icons&display=block" rel="stylesheet">
<script type="module">
  import '@cwmr/mwc-star-rating';
</script>

<mwc-star-rating></mwc-star-rating>

Linting with ESLint, Prettier, and Types

To scan the project for linting errors, run

npm run lint

You can lint with ESLint and Prettier individually as well

npm run lint:eslint
npm run lint:prettier

To automatically fix many linting errors, run

npm run format

You can format using ESLint and Prettier individually as well

npm run format:eslint
npm run format:prettier

Testing with Web Test Runner

To run the suite of Web Test Runner tests, run

npm run test

To run the tests in watch mode (for <abbr title="test driven development">TDD</abbr>, for example), run

npm run test:watch

Demoing with Storybook

To run a local instance of Storybook for your component, run

npm run storybook

To build a production version of Storybook, run

npm run storybook:build

Tooling configs

For most of the tools, the configuration is in the package.json to reduce the amount of files in your project.

If you customize the configuration a lot, you can consider moving them to individual files.

Local Demo with web-dev-server

npm start

To run a local development server that serves the basic demo located in demo/index.html

About

5-star rating element following open-wc recommendations

License:MIT License


Languages

Language:TypeScript 63.5%Language:JavaScript 25.4%Language:Dockerfile 10.0%Language:HTML 1.2%