0.1.0 • Published 11 months ago
review-widget v0.1.0
\
This webcomponent follows the open-wc recommendation.
Installation
yarn install
Usage
<script type="module">
import 'review-widget/review-widget.js';
</script>
<review-widget></review-widget>
Linting and formatting
To scan the project for linting and formatting errors, run
yarn run lint
To automatically fix linting and formatting errors, run
yarn run format
Testing with Web Test Runner
To execute a single test run:
yarn run test
To run the tests in interactive watch mode run:
yarn run test:watch
Demoing with Storybook
TODO: Fix this
To run a local instance of Storybook for your component, run
yarn run storybook
To build a production version of Storybook, run
yarn 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
yarn start
To run a local development server that serves the basic demo located in demo/index.html
Development Notes
Enable Shadow dom in Chrome inspect
- Open Dev tool by pressing F12
- Click on the cog icon in the right top
- Enable option "Show Shadow DOM" under Elements category
- Go to Elements panel and you will see the component DOM with all styles
0.1.0
11 months ago