@brightspace-ui-labs/toaster v2.1.2

@brightspace-ui-labs/toaster

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

• Design organization buy-in
• design.d2l entry
• Architectural sign-off
• Continuous integration
• Cross-browser testing
• Unit tests (if applicable)
• Accessibility tests
• Visual diff tests
• Localization with Serge (if applicable)
• Demo page
• README documentation

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:headless

To run the tests in watch mode (for <abbr title="test driven development">TDD</abbr>, for example), run

npm run test:headless: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

Versioning and Releasing

This repo is configured to use semantic-release. Commits prefixed with fix: and feat: will trigger patch and minor releases when merged to main.

To learn how to create major releases and release from maintenance branches, refer to the semantic-release GitHub Action documentation.