@jinntec/jinn-toast

<jinn-toast>

Plain vanilla web-component wrapping toastify-js

This webcomponent follows the open-wc recommendation.

Installation

npm i @jinntec/jinn-toast

Usage

<script type="module">
  import 'jinn-toast/jinn-toast.js';
</script>

<jinn-toast text="first toast with defaults"></jinn-toast>
<jinn-toast text="second toast top left" position="left"></jinn-toast>
<jinn-toast text="third toast bottom left" position="left" gravity="bottom"></jinn-toast>
<jinn-toast text="fourth toast bottom left" position="right" gravity="bottom"></jinn-toast>
<jinn-toast text="warning" duration="5000" data-class="warning" position="right" gravity="bottom"></jinn-toast>
<jinn-toast text="error" duration="-1" data-class="error" close="true" position="left" gravity="bottom"></jinn-toast>

To display the toast by API:

document.getElementById('my-toast').showToast('hello');

Or by dispatching an 'jinn-toast' event to the respective toast element:

toast.dispatchEvent(
      new CustomEvent('jinn-toast', {
        composed: true,
        bubbles: true,
        detail: {
          text:'hello'
        },
      }),
    );

Most of orginal options are just copied from toastify-js. See their docs for further options.

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

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