Stencil Storybook Starter

This is a batteries-included starter app for developing stencil components with Storybook.

git clone https://github.com/DesignByOnyx/stencil-storybook-starter.git
cd stencil-storybook-starter
git remote remove origin
npm install
npm run storybook

Features

• automatic generation of stories for all components
• automatic knobs generation for all @Props on your components
  • ability to customize which knobs are used for each prop (though the code does a good job of guessing for strings, numbers, booleans, objects, dates, and colors).
• ability to define multiple states which are rendered on a single page, each with a title, description, and props to use for rendering. A copyable code snippet is also generated for each state (kind of a lightweight chapters implementation)
• ability to define notes for each component (usually you want the generated readme)
• live rebuild/reload of stencil components (it's still a little wonky - sometimes you have to refresh the browser)
• also comes with the viewport add-on

Integration

This app was generated by using npm init stencil and selecting the "component" starter. After the app was generated, the following actions were performed. You should be able to follow these steps to integrate storybook into your existing stencil project:

1. The following folders/files were written for this project and should be copied/merged into your project:

   • .storybook/
   • babel.config.js
   • src/custom.d.ts

2. Update the "compilerOptions" in your tsconfig to include the following:

   "skipLibCheck": true
   

3. Install all of the dependencies

   npm install storybook webpack glob case babel-loader typescript awesome-typescript-loader babel-plugin-dynamic-import-node npm-run-all @babel/core @babel/preset-env @babel/preset-typescript @storybook/html @storybook/addon-info @storybook/addon-knobs @storybook/addon-notes @storybook/addon-viewport @types/jest @types/storybook__html @types/storybook__addon-knobs -D
   

   NOTE: it looks like a lot... it is. All of the above are necessary except npm-run-all (see next step).

   NOTE: you will get a lot of warnings about missing react dependencies and outdated packages. You will have to ignore these or go bug the project maintainers about managing dependencies a little better.

4. Add the following to the "scripts" section of your package.json. If you chose not to install npm-run-all, you will need to update your scripts so that stencil will run watch in "prod" mode while the storybook server is running.

   "watch": "stencil build --docs --watch",
   "storybook.run": "start-storybook --port 9001",
   "storybook": "npm-run-all --parallel watch storybook.run"
   

5. Finally, start the storybook server and check out all your component stories!

   npm run storybook
   

How it works

Well, it's complicated. All you really need to know is that the code in the project should generate a story for every component in your project along with knobs for all of your exposed @Props. If your project structure is different than the one here, you will need to update the code at the top of .storybook/stories/stencil.js to point to the correct locations. For more advanced stenarios, check out the .story.js file inside src/components/simple-config.

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

Script tag

• Publish to NPM
• 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