0.24.0 • Published 5 years ago

@minna-ui/toast v0.24.0

Weekly downloads
1
License
Apache-2.0
Repository
github
Last release
5 years ago

NPM version NPM bundle size (minified + gzip) Licence

@minna-ui/toasts

A simple "toast" notification web component. It can be used standalone, in Svelte projects, or any JavaScript project.


NOTE: This package is unfinished.


TODO: Write note about @minna-ui/css interplay/dependency.

TODO: Example image.

TODO: Add link to demo and documentation page.

Usage

Standalone

The easiest way to use the component is to add the CDN hosted version directly in your HTML.

TIP: If you're already using a JavaScript bundler you should follow the the "Other JavaScript projects" instructions.

  1. Add the CSS and JS to your document, inside the <head></head>:

     <link href="https://cdn.jsdelivr.net/npm/@minna-ui/toasts/dist/index.css" rel="stylesheet"/>
    
     <script src="https://cdn.jsdelivr.net/npm/@minna-ui/toasts"></script>

    Or use a specific version:

     <link href="https://cdn.jsdelivr.net/npm/@minna-ui/toasts@0.0.0/dist/index.css" rel="stylesheet"/>
    
     <script src="https://cdn.jsdelivr.net/npm/@minna-ui@0.0.0/toasts"></script>
  2. Add an element where you want the component to show in your document <body></body>:

    <div id="minna-toasts"></div>
  3. Initialise the component:

    <script>
      new MinnaToasts({
        data: {},
        target: document.querySelector('#minna-toasts'),
      });
    </script>

Svelte projects

Because this is actually a Svelte component, using it in your Svelte projects is simple and allows for the most flexibility and best possible performance.

  1. Install the package:

    yarn add @minna-ui/toasts
  2. Add to your Svelte component:

    MySvelteComponent.svelte:

    <MinnaToasts />
    
    <script>
      import MinnaToasts from '@minna-ui/toasts';
    
      export default {
        components: {
          MinnaToasts,
        },
      };
    </script>

Other JavaScript projects

This component can also be used alongside any JavaScript project, regardless of your framework of choice, by using ES6 modules import.

  1. Install the package:

    yarn add @minna-ui/toasts
  2. Add to your files:

    my-example.html:

    <div id="minna-toasts"></div>

    my-example.js:

    import MinnaToasts from '@minna-ui/toasts';
    
    new MinnaToasts({
      data: {},
      target: document.querySelector('#minna-toasts'),
    });

Licence

@minna-ui/toasts is part of Minna UI, an Apache-2.0 licensed open source project. See LICENCE.


© 2019 We Are Genki

0.24.0

5 years ago

0.23.0

5 years ago

0.22.2

5 years ago

0.22.1

5 years ago

0.22.1-beta.2

5 years ago

0.22.1-beta.1

5 years ago

0.22.1-beta.0

5 years ago

0.22.0-beta.0

5 years ago

0.22.0-next.23

5 years ago

0.22.0-next.20

5 years ago

0.22.0-next.12

5 years ago

0.22.0-next.332

5 years ago

0.22.0-next.331

5 years ago

0.22.0-next.325

5 years ago

0.22.0-next.307

5 years ago

0.22.0-next.298

5 years ago

0.22.0-next.288

5 years ago

0.22.0-next.274

5 years ago

0.22.0-next.266

5 years ago

0.22.0-next.265

5 years ago

0.22.0-next.262

5 years ago

0.22.0-next.260

5 years ago

0.22.0-next.235

5 years ago

0.22.0-next.228

5 years ago

0.22.0-next.193

5 years ago

0.22.0-next.190

5 years ago

0.22.0-next.77

5 years ago

0.21.0

5 years ago

0.20.0

5 years ago

0.19.0

5 years ago

0.18.0

5 years ago

0.17.0

6 years ago