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.

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

Delite integrations

StencilJS sass

• npm install @stencil/sass --save-dev

StencilJS clsx

• $ npm install --save clsx

Storybook automated stories integration

install storybook.js and modify as detailed here https://medium.com/swlh/automated-stories-with-storybook-and-stenciljs-8a8dc611fcdf

• make sure to install the web-component version of storybook (the article uses the html version)
• change all references that import storybook to: import { storiesOf } from '@storybook/web-components';
• after all modifications are complete, go to node_modules/.cache/storybook/dev-server and delete all files
• npm run storybook

Storybook theming integration

• follow the instructions here https://storybook.js.org/docs/react/configure/theming
• if you have the automated stories installed make sure the package.json looks like this:

"storybook.run": "start-storybook -p 6006 -s dist --no-manager-cache", "storybook": "npm-run-all --parallel build storybook.run",

• the --no-manager-cache is important to display changes made to the theme immediately
• once you're finished configuring the theme, remove the flag --no-manager-cache from the storybook script, otherwise loading times can be severely impacted.