@storybook/core-events
Advanced tools
Package description
@storybook/core-events is a package that provides a set of core events for Storybook, a tool for developing UI components in isolation. These events facilitate communication between different parts of Storybook, such as the manager and the preview, enabling features like story selection, control updates, and more.
Story Selection
This feature allows you to programmatically select a story in Storybook. The code sample demonstrates how to emit a story selection event using the SELECT_STORY event type.
const { SELECT_STORY } = require('@storybook/core-events');
// Example of emitting a story selection event
const channel = addons.getChannel();
channel.emit(SELECT_STORY, { kind: 'Button', story: 'Primary' });Control Updates
This feature allows you to update the controls (args) of a story. The code sample shows how to emit an event to update the arguments of a specific story using the UPDATE_STORY_ARGS event type.
const { UPDATE_STORY_ARGS } = require('@storybook/core-events');
// Example of emitting a control update event
const channel = addons.getChannel();
channel.emit(UPDATE_STORY_ARGS, { storyId: 'button--primary', updatedArgs: { label: 'Click Me' } });Story Rendering
This feature allows you to listen for when a story has been rendered. The code sample demonstrates how to listen for the STORY_RENDERED event and log a message when a story is rendered.
const { STORY_RENDERED } = require('@storybook/core-events');
// Example of listening for a story rendered event
const channel = addons.getChannel();
channel.on(STORY_RENDERED, (storyId) => {
console.log(`Story ${storyId} has been rendered`);
});EventEmitter3 is a high-performance event emitter for Node.js and the browser. It provides a similar event-driven architecture but is more general-purpose compared to @storybook/core-events, which is specifically designed for Storybook.
Mitt is a tiny functional event emitter. It offers a similar event-driven approach but is lightweight and framework-agnostic, making it suitable for a wide range of applications beyond Storybook.
Node Event Emitter is a simple and lightweight event emitter for Node.js. It provides basic event handling capabilities similar to @storybook/core-events but lacks the specialized events tailored for Storybook's ecosystem.
Changelog
8.2.0
Hold onto your hats! Storybook 8.2 has dropped, packed with a treasure trove of new features and bug fixes:
beforeAllplay functiontocbot - #28318, thanks @shilman!--no-dev option to init - #26918, thanks @fastfrwrd!--dev and --no-dev options to storybook init CLI - #26918, thanks @fastfrwrd!@storybook/addon-svelte-csf when initializing new projects - #27070, thanks @benmccann!beforeAll hook - #28255, thanks @ghengeveld!pkg-dir to fd-package-json - #28270, thanks @43081j!loading -> rendering -> playing - #28431, thanks @kasperpeulen!.stories.mdx handling - #25973, thanks @JReinhold!CJS for core/components - #28440, thanks @ndelangen!preview.js globals to initialGlobals - #27517, thanks @shilman!markdown-to-jsx to v7.4.5 - #26694, thanks @xyy94813!webpack-virtual-modules to 0.6.0 - #27102, thanks @fyodorovandrei!read-pkg-up to fd-package-json - #28272, thanks @43081j!doctrine with jsdoc-type-pratt-parser - #26305, thanks @43081j!Stories block, error when referenced in MDX - #28434, thanks @kasperpeulen!Typeset Doc block fontSizes type - #26475, thanks @noranda!env.bugfixes in SWC so destructuring is never transpiled - #28363, thanks @kasperpeulen!mount in react, svelte, and vue renderers - #28385, thanks @kasperpeulen!CompatibleString - #27180, thanks @sni-J!FAQs
Event names used in storybook core
The npm package @storybook/core-events receives a total of 10,886,788 weekly downloads. As such, @storybook/core-events popularity was classified as popular.
We found that @storybook/core-events demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 11 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Employee Spotlight
Philipp Burckhardt recounts his journey from childhood computer fascinations, to building an e-learning platform at Carnegie Mellon University, and on to his current role at Socket.
Security News
Git dependencies in open source packages can introduce significant risks, including lack of version control, stability issues, dependency drift, and difficulty in auditing, making them potential targets for supply chain attacks.
Security News
Node.js has added experimental support for TypeScript, a move that highlights the growing importance of TypeScript in modern development.