byopwa-storybook v0.0.1

Stencil Component Starter + Storybookjs Starter

This is a starter project for building a standalone Web Component using Stencil and creating a great UI to display these components and their variations.

For more information about each individual package, visit stencil 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.

Storybook

Storybook is a user interface development environment and playground for UI components. The tool enables developers to create components independently and showcase components interactively in an isolated development environment.

Storybook runs outside of the main app so users can develop UI components in isolation without worrying about app specific dependencies and requirements.

Getting Started

To start building, clone this repo to a new directory:

git clone git@github.com:fvaldes33/stencil-storybook-starter.git my-starter-project
cd my-starter-project
git remote rm origin

and run:

npm install
npm run all

Two windows will open, a stencil window and a storybook window.

To only run stencil, run:

npm run start

To only run storybook, run: (keep in mind that to run storybook alone, you would have to built the stencil project first)

npm run storybook

To build the stencil component for production, run:

npm run build

To run the unit tests for the components, run:

npm test

More about Stencil

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

Script tag

• Publish to NPM
• Put a script tag similar to this <script src='https://unpkg.com/my-component@0.0.1/dist/mycomponent.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 src='node_modules/my-component/dist/mycomponent.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