@storybook/html

What is @storybook/html?

@storybook/html is a tool for developing UI components in isolation for HTML-based projects. It allows developers to build, test, and showcase their components in a structured and interactive environment.

What are @storybook/html's main functionalities?

Component Development

This feature allows developers to create and display different states of a component. The code sample demonstrates how to create stories for a Button component with different content.

import { storiesOf } from '@storybook/html';

storiesOf('Button', module)
  .add('with text', () => '<button>Hello Button</button>')
  .add('with emoji', () => '<button>😀 😎 👍 💯</button>');

Interactive Addons

This feature allows the use of addons to make stories interactive. The code sample shows how to use the Knobs addon to dynamically change the text of a Button component.

import { storiesOf } from '@storybook/html';
import { withKnobs, text } from '@storybook/addon-knobs';

storiesOf('Button', module)
  .addDecorator(withKnobs)
  .add('with dynamic text', () => {
    const label = text('Label', 'Hello Button');
    return `<button>${label}</button>`;
  });

Documentation

This feature allows developers to add documentation to their stories. The code sample demonstrates how to use the storybook-readme addon to include markdown documentation for a Button component.

import { storiesOf } from '@storybook/html';
import { withDocs } from 'storybook-readme';
import ButtonReadme from './Button.md';

storiesOf('Button', module)
  .addDecorator(withDocs(ButtonReadme))
  .add('default', () => '<button>Hello Button</button>');

Other packages similar to @storybook/html

@storybook/react

@storybook/react is similar to @storybook/html but is specifically designed for React components. It provides a similar environment for developing, testing, and showcasing React components.

@storybook/vue

@storybook/vue is designed for Vue.js components. It offers the same functionalities as @storybook/html but tailored for the Vue.js framework, allowing developers to work with Vue components in isolation.

@storybook/angular

@storybook/angular is tailored for Angular components. It provides a similar set of features as @storybook/html but is optimized for the Angular framework, enabling developers to build and test Angular components in isolation.

README

Storybook HTML Renderer

Changelog

9.1.0

Storybook 9.1 is packed with new features and improvements to enhance accessibility, streamline testing, and make your development workflow even smoother!

🚀 Improved upgrade command with monorepo support for seamless upgrades 🅰 Angular fixes for Tailwind 4, cache busting, and zoneless compatibility 🧪 sb.mock API and Automocking: one-line module mocking to simplify your testing workflow 🧪 Favicon shows test run status for quick visual feedback ⚛️ Easier configuration for React Native projects 🔥 Auto-abort play functions on HMR to avoid unwanted side effects 🏗️ Improved CSF factories API for type safe story definitions ♿️ A11y improvements across Storybook’s UI — addon panel, toolbar, sidebar, mobile & more 💯 Dozens more fixes and improvements based on community feedback!

<details> <summary>List of all updates</summary>

• A11y: Improved toolbar a11y by fixing semantics - #28672, thanks @mehm8128!
• Addon Vitest: Remove Optimize deps candidates due to Vitest warnings - #31809, thanks @valentinpalkovic!
• Angular: Bundle using TSup - #31690, thanks @ndelangen!
• Angular: Prevent directory import in Angular builders - #32012, thanks @ghengeveld!
• Automigration: Await updateMainConfig in removeEssentials - #32140, thanks @valentinpalkovic!
• Builder-Vite: Fix logic related to setting allowedHosts when IP address used - #31472, thanks @JSMike!
• Controls: Improve the accessibility of the object control - #31581, thanks @Sidnioulz!
• Core: Abort play function on HMR - #31542, thanks @ghengeveld!
• Core: Avoid pausing animations in non-Vitest Playwright environments - #32123, thanks @ghengeveld!
• Core: Cleanup of type following up v9 and small verbatimModuleSyntax type fix - #31823, thanks @alcpereira!
• Core: Fix aria-controls attribute on sidebar nodes to include all children - #31491, thanks @candrepa1!
• Core: Fix horizontal scrollbar covering part of the toolbar - #31704, thanks @Sidnioulz!
• Core: Fix moving log file across drives and projectRoot detection on Windows - #32020, thanks @ghengeveld!
• Core: Prevent interactions panel from flickering and showing incorrect state - #32150, thanks @ghengeveld!
• Core: Serve dynamic favicon based on testing module status - #31763, thanks @ghengeveld!
• Core: Support container queries in addon panels - #23261, thanks @neil-morrison44!
• CSF Factories: Add parameters/globals types, extend API, portable stories - #30601, thanks @kasperpeulen!
• CSF: Improve controls parameters - #31745, thanks @kasperpeulen!
• CSF: Improve docs parameter types - #31736, thanks @kasperpeulen!
• CSF: Only add preview annotations to definePreview in csf-factories automigration - #31727, thanks @kasperpeulen!
• Docs: Update @storybook/icons - #32144, thanks @valentinpalkovic!
• Docs: Update react-element-to-jsx-string - #31170, thanks @7rulnik!
• Init: Exclude mdx stories when docs feature isn't selected during init - #32142, thanks @valentinpalkovic!
• Maintenance: Add flag to toggle default automigrations - #32113, thanks @yannbf!
• React Native Web: Simplify config by using vite-plugin-rnw - #32051, thanks @dannyhw!
• Telemetry: Add automigration errors - #32103, thanks @yannbf!
• Telemetry: Fix project.json for getAbsolutePath - #31510, thanks @ndelangen!
• Test: Add mock capabilities - #31987, thanks @valentinpalkovic!
• Test: Consider exports map - #32157, thanks @valentinpalkovic!
• Test: Fix missing source map for Webpack/Vite mock loaders and plugins - #32111, thanks @valentinpalkovic!
• Test: Invalidate vite cache for manual mocks - #32152, thanks @valentinpalkovic!
• Test: Remove source map generation from webpack automock-loader - #32115, thanks @valentinpalkovic!
• UI: Apply user updates for mobile navigation accessibility - #31401, thanks @yatishgoel!
• UI: Fix interaction step collapse icon - #31853, thanks @AvitalHass!
• UI: Visual focus indicators (VFIs) aren't visible in high contrast mode (rebase) - #31848, thanks @Sidnioulz!

</details>