@kmansfield27/ds-demo v0.0.1

Design System Proof of Concept

This is a proof of concept project for building a design system with Stencil (v3) and Storybook.

Stencil

Stencil is a compiler for building fast web apps using Web Components.

Stencil combines the best concepts of the most popular frontend frameworks into a compile-time rather than run-time tool. Stencil takes TypeScript, JSX, a tiny virtual DOM layer, efficient one-way data binding, an asynchronous rendering pipeline (similar to React Fiber), and lazy-loading out of the box, and generates 100% standards-based Web Components that run in any browser supporting the Custom Elements v1 spec.

Stencil components are just Web Components, so they work in any major framework or with no framework at all.

Prerequisites

This project requires a recent LTS version of NodeJS and npm. Make sure you've installed and/or updated Node before continuing.

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

Need help? Check out our docs here.

Naming Components

Web components must always have a hypen in them. Because of this, it is common to adopt a prefix in the name. This demo uses ds- (design system), but that will most likely change as we move forward.

Creating a new component

Using npm:

npm run generate 

Using stencil directly:

stencil generate 

# or

stencil g

Using components

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/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

Storybook

Storybook is built into the project to provide an isolated setting to run, document, and test our components.

To run Storybook:

npm run storybook

If you have added or changed components, you will need to build the project before running Storybook.

npm run build