pvr-components v0.0.2

PVR Components

This is the PVR component library. It uses web components to create reusable components for any project. This is a POC and is not ready for production.

It uses StencilJS to create the web components and Storybook to create the documentation.

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.

Getting Started

Develop new components with Stencil and show them in Storybook

Run Stencil & Storybook in dev mode:

npm run dev

Build new components in Stencil

Run Stencil in dev mode:

npm run stencil.start

Add new components to Storybook

To run Storybook, run:

npm run storybook

Build components for production

To build the component for production, run:

npm run build

To run the unit tests for the components, run:

npm stencil.test

Need help? Check out our docs here.

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