commonforms-stencil-library v0.0.18

Common Forms Stencil Component Library

This is a library of web components for using Common Forms components.

Getting Started

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

git clone https://git-codecommit.us-east-1.amazonaws.com/v1/repos/commonforms-stencil-library
cd commonforms-stencil-library
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 library

There are three strategies we recommend for using web components within the Common Forms Framework.

Script tag

• Put a script tag similar to this <script type='module' src='https://unpkg.com/my-component@0.0.1/dist/my-component.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 my-component --save
• Put a script tag similar to this <script type='module' src='node_modules/my-component/dist/my-component.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 my-component --save
• Add an import to the npm packages import my-component;
• Then you can use the element anywhere in your template, JSX, html etc