@brightspace-ui-labs/toaster

A component for managing and displaying toast events

Usage no npm install needed!

<script type="module">
  import brightspaceUiLabsToaster from 'https://cdn.skypack.dev/@brightspace-ui-labs/toaster';
</script>

README

@brightspace-ui-labs/toaster

Note: this is a "labs" component. While functional, these tasks are prerequisites to promotion to BrightspaceUI "official" status:

This webcomponent follows the open-wc recommendation.

Installation

npm i @brightspace-ui-labs/toaster

Usage

<script type="module">
  import { ToastEvent } from '@brightspace-ui-labs/toaster';

  function sendToastEvent() {
    ToastEvent.dispatch(this, 'message', 'description');
  }

  render(html`
    <d2l-labs-toaster>
      <button @click=${sendToastEvent}></button>
    </d2l-labs-toaster>  
  `)
</script>


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