Web Components Library

A collection of generic web components built with StencilJS. This is a dev ecosystem for building a library of standalone Web Components using Stencil.

Stencil is also great for building entire apps. For that, use the stencil-app-starter instead. (Note: Link to be updated with our custom boilerplate soon)

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

This package can be used in 2 ways as package dependency or as Fork/Clone.

As Package Dependency

If you wish to consume components exported by this library as is and don't see much scope for customization, following is how this package can be used:

yarn add @xt-pagesource/web-component-lib

or

npm install @xt-pagesource/web-component-lib

As Fork/Clone for Custom Development

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

git clone https://github.com/pagesource/web-component-lib.git my-component-lib
cd my-component-lib
git remote rm origin

and run:

yarn install 
yarn start

To build the component for production, run:

yarn run build

To run the unit tests for the components, run:

yarn test

Need help? Check out our docs here.

Using a web component

Script tag

• Publish to NPM
• Put a script tag similar to this <script src='https://unpkg.com/@xt-pagesource/[email protected]/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 yarn add @xt-pagesource/web-component-lib -s
• Put a script tag similar to this <script src='node_modules/@xt-pagesource/web-component-lib/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 boilerplate app

• Run yarn add @xt-pagesource/web-component-lib -s
• Add an import to the npm packages import @xt-pagesource/web-component-lib/my-component;
• Then you can use the element anywhere in your template, JSX, html etc

List of Generic Component

Exported Components

1. Link

Best Practices

How to Ramp-up