Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@minna-ui/switch

0.36.0 • Public • Published

NPM version NPM bundle size (minified + gzip) Licence

@minna-ui/switch

A simple togglable switch web component similar in function to a browser native <input type="checkbox"/> but better looking and more understandable by users. It can be used standalone, in Svelte projects, or any JavaScript project.

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

    Or use a specific version:

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

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

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

    MySvelteComponent.svelte:

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

    my-example.html:

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

    my-example.js:

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

Licence

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


© 2020 We Are Genki

Install

npm i @minna-ui/switch

DownloadsWeekly Downloads

52

Version

0.36.0

License

Apache-2.0

Unpacked Size

195 kB

Total Files

16

Last publish

Collaborators

  • avatar