@pressbooks/reorderable-multiselect
v0.0.3
Published
Webcomponent pressbooks-reorderable-multiselect following open-wc recommendations
Downloads
24
Keywords
Readme
<pressbooks-reorderable-multiselect>
A web component which allows users to select multiple items from a list and customize the order in which they appear, built with Lit. This web component follows the open-wc recommendations.
It is largely based on the ARIA Listbox pattern.
Installation
npm i @pressbooks/reorderable-multiselect
Usage
TODO.
Styling
Because this web component uses the Shadow Dom, styling is limited to modification via CSS custom properties. However, there are plenty to choose from.
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 minimize 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
Publishing to NPM
As this is a scoped package it must be published by someone within the Pressbooks NPM organization and must use the --access public
flag:
npm publish --access public