@storybook/addon-highlight

Storybook Addon Highlight

Storybook addon allows for highlighting specific DOM nodes within your story.

Use it to call attention to particular parts of the story. Or use it to enhance other addons that you might be building. For example, Accessibility addon uses it to highlight DOM nodes that are failing accessibility checks.

Usage

This addon requires Storybook 6.5 or later. Highlight is part of essentials and so is installed in all new Storybooks by default. If you need to add it to your Storybook, you can run:

npm i -D @storybook/addon-highlight

Add "@storybook/addon-highlight" to the addons array in your .storybook/main.js:

module.exports = {
  addons: ['@storybook/addon-highlight'],
};

Apply or clear highlights

Highlight DOM nodes by emitting the HIGHLIGHT event from within a story or an addon. The event payload must contain a list of selectors you want to highlight.

import React, { useEffect } from 'react';
import { useChannel } from '@storybook/addons';
import { HIGHLIGHT, RESET_HIGHLIGHT } from '@storybook/addon-highlight';
import { MyComponent } form './MyComponent';

export default { component: MyComponent };

export const MyStory = () => {
  const emit = useChannel({});

  useEffect(() => {
    emit(HIGHLIGHT, {
      elements: ['.title', '.subtitle'],
    });
  }, []);

  return <MyComponent />;
};

Highlights are automatically cleared when the story changes. You can also manually clear them by emitting the RESET_HIGHLIGHT event.

emit(RESET_HIGHLIGHT);

Customize style

emit(HIGHLIGHT, {
  elements: ['.title', '.subtitle'],
  color: 'red',
  style: 'solid', // 'dotted' | 'dashed' | 'solid' | 'double'
});

Changelog

7.0.0-alpha.39 (October 19, 2022)

Breaking Changes

• Addons: Remove deprecations #19524

Features

• Core: Throw an error if renderer is used as framework #19452
• CLI: Add pnpm support #19425
• CLI: support .json in eslint-plugin migration #19511

Bug Fixes

• Vite/React: Align with webpack react docgen #19399
• Core: Direct logs to stdout #19434
• Telemetry: Send start/build events even when there is no generator #19507
• Core: Fix inconsistent telemetry debug #19509

Maintenance

• Addon-docs: Define children for DocsContainer #19437
• Convert issue templates to forms #19370
• Change once.warn to deprecate when that is the actual intent #19521
• Cleanup framework angular dependencies #19389
• Frameworks: Don't re-export renderer types from frameworks #19510
• Core: Remove storyStore.getSelection #19491
• CLI: rename "latest" to "v13" app name in angular v13 repro template #19498

Build

• Improve misc build parts #19520
• Build: Bundle addons/storysource with ts-up #19482
• Build: Bundle lib/docs-tools & lib/instrumenter with ts-up #19206
• Actions: update actions/setup-node to v3 #19444
• Actions: update actions/checkout to v3 #19441
• Build: Bundle lib/codemod with ts-up #19398
• Build: Bundle addons/highlight with ts-up #19483
• Enable preact templates and remove preact-kitchen-sink #19454

Dependency Upgrades

• Addon-docs: Make babel-loader an optional peer dependency #19385
• Add missing addons/docs dependency for fs-extra #19493