@geneontology/wc-light-modal

Light Modal Web Component

This is a lightweight web component to display modals. It allows notably to include HTML content in the modal card. The modal can be triggered by 3 methods: open(), close() or toggle().

Getting Started

To start building a new web component using Stencil, clone this repo to a new directory:

git clone https://github.com/ionic-team/stencil-component-starter.git my-component
cd my-component
git remote rm origin

and run:

npm install
npm start

To build the component for production, run:

npm run build

To run the unit tests for the components, run:

npm test

Using this component

There are three strategies we recommend for using web components built with Stencil.

The first step for all three of these strategies is to publish to NPM.

Script tag

• Put a script tag similar to this <script src='https://unpkg.com/@geneontology/wc-light-modal@0.0.1/dist/wc-light-modal.esm.js'></script> in the head of your index.html
• Then you can use the element anywhere in your template, JSX, html etc

Node Modules

• Run npm install @geneontology/wc-light-modal --save
• Put a script tag similar to this <script src='node_modules/@geneontology/wc-light-modal/dist/wc-light-modal.esm.js'></script> in the head of your index.html
• Then you can use the element anywhere in your template, JSX, html etc

In a stencil-starter app

• Run npm install @geneontology/wc-light-modal --save
• Add an import to the npm packages import wc-light-modal;
• Then you can use the element anywhere in your template, JSX, html etc