@storybook/html-vite

8.5.0last stable release 6 days ago
Complexity Score
High
Open Issues
2,046
Dependent Projects
75
Weekly Downloadsglobal
21,702

License

  • MIT
    • Yesattribution
    • Permissivelinking
    • Permissivedistribution
    • Permissivemodification
    • Nopatent grant
    • Yesprivate use
    • Permissivesublicensing
    • Notrademark grant

Downloads

Readme

Build bulletproof UI components faster



Storybook is a frontend workshop for building UI components and pages in isolation. Thousands of teams use it for UI development, testing, and documentation. Find out more at https://storybook.js.org!

View README for:

Table of contents

  • 🚀 Getting Started
  • đź“’ Projects
    • đź›  Supported Frameworks & Examples
    • đź”—Addons
  • 🏅 Badges & Presentation materials
  • đź‘Ą Community
  • đź‘Ź Contributing
    • 👨‍💻 Development scripts
    • đź’¸ Sponsors
    • đź’µ Backers
  • :memo: License

Getting Started

Visit Storybook’s website to learn more about Storybook and to get started.

Documentation

Documentation can be found on Storybook’s docs site.

Examples

View Component Encyclopedia to see how leading teams use Storybook.

Use storybook.new to quickly create an example project in Stackblitz.

Storybook comes with a lot of addons for component design, documentation, testing, interactivity, and so on. Storybook’s API makes it possible to configure and extend in various ways. It has even been extended to support React Native, Android, iOS, and Flutter development for mobile.

Community

For additional help, share your issue in the repo’s GitHub Discussions.

Projects

Supported Frameworks

Renderer Demo React Angular Vue 3 Web components React Native HTML Ember Svelte Preact Qwik SolidJS Android, iOS, Flutter

Addons

Addons a11y Test components for user accessibility in Storybook actions Log actions as users interact with components in the Storybook UI backgrounds Let users choose backgrounds in the Storybook UI cssresources Dynamically add/remove CSS resources to the component iframe design assets View images, videos, and weblinks alongside your story docs Add high quality documentation to your components events Interactively fire events to components that respond to EventEmitter google-analytics Reports google analytics on stories graphql Query a GraphQL server within Storybook stories jest View the results of components’ unit tests in Storybook links Create links between stories measure Visually inspect the layout and box model within the Storybook UI outline Visually debug the CSS layout and alignment within the Storybook UI query params Mock query params storysource View the code of your stories within the Storybook UI viewport Change display sizes and layouts for responsive components using Storybook

See Addon / Framework Support Table

To continue improving your experience, we have to eventually deprecate or remove certain addons in favor of new and better tools.

If you’re using info/notes, we highly recommend you migrate to docs instead, and here is a guide to help you.

If you’re using contexts, we highly recommend you migrate to toolbars and here is a guide to help you.

If you’re using addon-storyshots, we highly recommend you migrate to the Storybook test-runner and here is a guide to help you.

Badges & Presentation materials

We have a badge! Link it to your live Storybook example.

[![Storybook](https://cdn.jsdelivr.net/gh/storybookjs/brand@main/badge/badge-storybook.svg)](link to site)

If you’re looking for material to use in your Storybook presentation, such as logos, video material, and the colors we use, you can find it all on our brand repo.

Community

  • Tweeting via @storybookjs
  • Blogging at storybook.js.org and Medium
  • Chatting on Discord
  • Videos and streams at YouTube

Contributing

Contributions to Storybook are always welcome!

  • đź“Ą Pull requests and 🌟 Stars are always welcome.
  • Read our contributing guide to get started, or find us on Discord, we will take the time to guide you.

Looking for a first issue to tackle?

  • We tag issues with when we think they are well suited for people who are new to the codebase or OSS in general.
  • Talk to us, we’ll find something that suits your skills and learning interest.

Development scripts

Storybook is organized as a monorepo. Useful scripts include:

yarn start

Runs a sandbox template storybook with test stories

yarn task

As above, but gives you options to customize the sandbox (e.g. selecting other frameworks)

yarn lint

boolean check if code conforms to linting rules - uses remark & eslint

  • yarn lint:js - will check js
  • yarn lint:md - will check markdown + code samples
  • yarn lint:js --fix - will automatically fix js

yarn test

boolean check if unit tests all pass - uses jest

  • yarn run test --core --watch - will run core tests in watch-mode

Sponsors

Become a sponsor to have your logo and website URL on our README on Github. [Become a sponsor]

Backers

By making a recurring donation, you can support us and our work. [Become a backer]

License

MIT

-the end-

Dependencies

CVE IssuesActive
0
Scorecards Score
7.20
Test Coverage
No Data
Follows Semver
Yes
Github Stars
85,161
Dependenciestotal
5
DependenciesOutdated
0
DependenciesDeprecated
0
Threat Modelling
No
Repo Audits
No

Learn how to distribute @storybook/html-vite in your own private NPM registry

npm config set registry  https://npm.cloudsmith.com/owner/repo
Processing...
Done
npm install @storybook/html-vite
Processing...
Done

926 Releases

NPM on Cloudsmith

Getting started with NPM on Cloudsmith is fast and easy.