@internetarchive/icon-bookmark

Multi-state SVG bookmark icon component

Usage no npm install needed!

<script type="module">
  import internetarchiveIconBookmark from 'https://cdn.skypack.dev/@internetarchive/icon-bookmark';
</script>

README

<icon-bookmark>

This webcomponent follows the open-wc recommendation.

Installation

npm i icon-bookmark

Usage

<script type="module">
  import 'icon-bookmark/icon-bookmark.js';
</script>

<icon-bookmark></icon-bookmark>

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 Karma

To run the suite of karma tests, run

npm run test

To run the tests in watch mode (for TDD, for example), 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 es-dev-server

npm start

To run a local development server that serves the basic demo located in demo/index.html