Stencil Component Starter

This is a starter project for building a standalone Web Component using Stencil.

Stencil is also great for building entire apps. For that, use the stencil-app-starter instead.

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.

GitHub Actions

A handful of GitHub Actions workflows are defined. These are described below:

• pr.yml - build dependencies and run unit tests for each pull request
• publish.yml - on release publish package to npm registry
• sonarcloud.yml - on pull request and merge to main, runs static code analysis.

Deployment steps

The current branching strategy is:

• main = production
• develop = dev

When working on a new version of widget you need to branch off of the develop branch:

git checkout -mb "new_feature_branch"

When you want to create a new version of the npm package run:

npm version patch

Push new changes to feature branch and create a pull request to the 'develop' branch to trigger the build and test workflow. Pull requests will have unit tests that need to pass to merge to the develop branch, after merging to develop you can create a release for develop.

Publish to develop

To publish a new pre-prod version you must create a release in github in the 'develop' branch and specify a tag matching the tag of the version of the 'package.json', this will trigger a workflow and publish the package to the npm registry.

Publish to production

After merging to develop and testing the pre-production package you can raise a pull request from 'develop' to 'main' branch, this will require an approval from a developer and after merging to main you must create another release from the main branch to trigger the workflow to publish the new package version

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

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/[email protected]/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