@minna-ui/dialog
TypeScript icon, indicating that this package has built-in type declarations

0.22.0-next.20 • Public • Published

NPM version NPM bundle size (minified + gzip) Licence

@minna-ui/dialog

TODO: Write me.

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/dialog/dist/index.css" rel="stylesheet"/>
    
     <script src="https://cdn.jsdelivr.net/npm/@minna-ui/dialog"></script>

    Or use a specific version:

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

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

    <script>
      new MinnaDialog({
        target: document.querySelector('#minna-dialog'),
        data: {},
      });
    </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/dialog
  2. Add to your Svelte component:

    MySvelteComponent.svelte:

    <MinnaDialog />
    
    <script>
      import MinnaDialog from '@minna-ui/dialog';
    
      export default {
        components: {
          MinnaDialog,
        },
      };
    </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/dialog
  2. Add to your files:

    my-example.html:

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

    my-example.js:

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

Licence

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


© 2019 We Are Genki

Package Sidebar

Install

npm i @minna-ui/dialog

Weekly Downloads

1

Version

0.22.0-next.20

License

Apache-2.0

Unpacked Size

162 kB

Total Files

15

Last publish

Collaborators

  • maxmilton