@borjag90dev/lit-modal

0.2.0 • Public • Published

<lit-modal>

npm coverage install size npm downloads LICENSE

Project github repo Documentation Link

This webcomponent follows the open-wc recommendation.

A simple modal web component

Installation

npm i @borjag90dev/lit-modal

Usage

<script type="module">
  import '@borjag90dev/lit-modal.js';
</script>

<lit-modal></lit-modal>

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

Built with

Technologies

JavaScript Litelement Open-WC

Platforms

VSCode

Authors

  • Borja Gete

Borja Gete mail Borja Gete Github Borja Gete LinkedIn

Package Sidebar

Install

npm i @borjag90dev/lit-modal

Weekly Downloads

11

Version

0.2.0

License

MIT

Unpacked Size

19.1 kB

Total Files

15

Last publish

Collaborators

  • borjag90dev