stencilbook-ding starter

Takes Stencil and Storybook and mashes them together.

---

This setup uses Stencil, @storybook/web-components and @storybook/addon-essentials (e.g. Controls, Actions). Stories written via CSF (we don't use MDX so haven't tested that at all).

Stencil generates a web-component JSON file containing component definitions (via the docs-vscode command). This JSON gets registered with @storybook/web-components, which populates the component args.

Added some extra integration between Storybook and Stencil devservers, so that both of the error overlays can display within the browser:

(check ./storybook/preview-body.html and ./src/index.html for the deets).

Note that instead of script tags to the pre-built Stencil components inside Storybooks preview-head.html like a lot of starter repos seem to do, I've directly imported from the built package into preview.js. The benefit of this is when a change is made to a Stencil component, the Storybook webpack dev server can know, and can trigger a reload of the preview iframe. With just a script tag, you're stuck manually reloading.

I also did some webpack hackery to automatically inject module.hot.decline() into each story - this causes webpack to NOT "hot in" changes, and instead does a full reload of the Storybook preview iframe. This is required since the web-component will already be registered with the DOM so HMR doesn't work. (NOTE: an interesting approach to getting HMR working via proxies on customElements.define can be seen here: vegarringdal/custom-elements-hmr-polyfill would love to see this integrated)

• npm start (Storybook + Stencil devserver - storybook will wait for Stencil to be ready before starting)
• npm run build (Stencil + Storybook production builds)

...see package.json for the other standard ones

---

---

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