@adriengibrat/ui-components

Clean & accessible webcomponents

Usage no npm install needed!

<script type="module">
  import adriengibratUiComponents from 'https://cdn.skypack.dev/@adriengibrat/ui-components';
</script>

README

<ui-components>

This webcomponents follows the open-wc recommendation.

Installation

npm i ui-components

Usage

Import individual component

<script type="module" src="./lib/browser/ui-button.js"></script>
<ui-button>button</ui-button>

Import all components

<script type="module" src="./lib/browser/index.js"></script>
<ui-button>button</ui-button>
<ui-avatar>email@example.com</ui-avatar>
...

Linting with ESLint, Prettier, and Types

To automatically fix the project linting errors, run

npm run lint

Testing

To run the suite of tests, run

npm test

To run the tests in watch mode (for TDD, for example), run

npm run test:watch

Demoing with Storybook

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

npm start

To build a docs version of Storybook, run

npm run docs