Skip to content

Commit

Permalink
Merge pull request #24296 from ATREAY/storybook
Browse files Browse the repository at this point in the history
added info about emit() function
  • Loading branch information
jonniebigodes authored Oct 6, 2023
2 parents 80951d3 + 1d52a86 commit 1593ff3
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/essentials/highlight.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,12 @@ Out of the box, Storybook automatically removes highlighted elements when transi

<!-- prettier-ignore-end -->

<div class="aside">

ℹ️ The `emit` function derived from the `useChannel` API hook creates a communication channel in Storybook's UI to listen for events and update the UI accordingly. The Highlight addon uses this channel to listen to custom events and update the highlighted elements (if any) accordingly.

</div>

## Customize style

By default, the addon applies a standard style to the highlighted elements you've enabled for the story. However, you can enable your custom style by extending the payload object and providing a `color` and/or `style` properties. For example:
Expand All @@ -70,4 +76,4 @@ By default, the addon applies a standard style to the highlighted elements you'v
]}
/>

<!-- prettier-ignore-end -->
<!-- prettier-ignore-end -->

0 comments on commit 1593ff3

Please sign in to comment.