@astrouxds/documentation-components
v0.0.16
Published
A web component for displaying a design token preview
Downloads
53
Keywords
Readme
<rux-design-token-preview>
This webcomponent follows the open-wc recommendation.
Installation
npm i rux-design-token-preview
Usage
<script type="module">
import 'rux-design-token-preview/rux-design-token-preview.js';
</script>
<rux-design-token-preview></rux-design-token-preview>
Linting and formatting
To scan the project for linting and formatting errors, run
npm run lint
To automatically fix linting and formatting errors, run
npm run format
Testing with Web Test Runner
To execute a single test run:
npm run test
To run the tests in interactive watch mode run:
npm run test:watch
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