gl-ds-stencil v0.0.2

Stencil Design System Components

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

git clone https://github.com/inna-i/ds-stencil.git my-ds
cd my-ds
git remote rm origin

and run:

yarn
yarn story

To build the component for production, run:

yarn build

To run the unit tests for the components, run:

yarn test

Need help? Check out our docs here.

Naming Components

When creating new component tags, we recommend not using stencil in the component name (ex: <stencil-datepicker>). This is because the generated component has little to nothing to do with Stencil; it's just a web component!

Instead, use a prefix that fits your company or any name for a group of related components. For example, all of the Ionic generated web components use the prefix ion.

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