https://github.com/ofhouse/storybook-stencil-example

Example project which uses Stencil components in Storybook.
https://github.com/ofhouse/storybook-stencil-example

example-project javascript stencil storybook

Last synced: 4 months ago
JSON representation

Example project which uses Stencil components in Storybook.

• Host: GitHub
• URL: https://github.com/ofhouse/storybook-stencil-example
• Owner: ofhouse
• License: mit
• Created: 2020-02-12T18:41:32.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2021-08-12T00:19:33.000Z (over 3 years ago)
• Last Synced: 2024-12-10T14:28:46.062Z (4 months ago)
• Topics: example-project, javascript, stencil, storybook
• Language: TypeScript
• Homepage: https://ofhouse.github.io/storybook-stencil-example
• Size: 3.93 MB
• Stars: 12
• Watchers: 3
• Forks: 6
• Open Issues: 11
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Built With Stencil](https://img.shields.io/badge/-Built%20With%20Stencil-16161d.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDE5LjIuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MTIgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGRkZGRjt9Cjwvc3R5bGU%2BCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MjQuNywzNzMuOWMwLDM3LjYtNTUuMSw2OC42LTkyLjcsNjguNkgxODAuNGMtMzcuOSwwLTkyLjctMzAuNy05Mi43LTY4LjZ2LTMuNmgzMzYuOVYzNzMuOXoiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQyNC43LDI5Mi4xSDE4MC40Yy0zNy42LDAtOTIuNy0zMS05Mi43LTY4LjZ2LTMuNkgzMzJjMzcuNiwwLDkyLjcsMzEsOTIuNyw2OC42VjI5Mi4xeiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDI0LjcsMTQxLjdIODcuN3YtMy42YzAtMzcuNiw1NC44LTY4LjYsOTIuNy02OC42SDMzMmMzNy45LDAsOTIuNywzMC43LDkyLjcsNjguNlYxNDEuN3oiLz4KPC9zdmc%2BCg%3D%3D&colorA=16161d&style=flat-square)

# Storybook Stencil Example

This is a starter project for building a Web Component library with [Stencil](https://stenciljs.com/) and [Storybook](https://storybook.js.org/).

## Getting Started

To start clone this repo into a new directory and run the following commands:

```sh

npm install

npm start

```

For a step-by-step tutorial how to recreate this from scratch you can follow this series of blog posts:

| [
Part 1: Build a Web Component library with Stencil and Storybook](https://dev.to/ofhouse/build-a-web-component-library-with-stencil-and-storybook-c27) |

| :---: |

| [
Part 2: Enhance your Stencil Web Components in Storybook with Knobs, Actions and JSX](https://dev.to/ofhouse/enhance-your-stencil-web-components-in-storybook-with-knobs-actions-and-jsx-54m4) |

| :---: |

## Features

- [Storybook for HTML](https://storybook.js.org/docs/guides/guide-html/)

- [Storybook Addon Notes](https://www.npmjs.com/package/@storybook/addon-notes)

- [Storybook Addon Knobs](https://www.npmjs.com/package/@storybook/addon-knobs)

- [Storybook Addon Actions](https://www.npmjs.com/package/@storybook/addon-actions)

## Author

| [
Felix Haus](https://github.com/ofhouse)
[Website](https://felix.house/) • [Twitter](https://twitter.com/ofhouse)|

| :---: |

## License

MIT - see [LICENSE](./LICENSE) for details.