Socket
Socket
Sign inDemoInstall

@storybook/addons

Package Overview
Dependencies
69
Maintainers
8
Versions
1491
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@storybook/addons

Storybook addons store


Version published
Maintainers
8
Weekly downloads
5,170,866
decreased by-2.44%
Bundle size
83.4 kB
Minified + gzipped

Weekly downloads

Package description

What is @storybook/addons?

The @storybook/addons package is a core module for Storybook that provides the infrastructure to build and use addons, which are essentially plugins that can be used to extend Storybook's UI and behavior. Addons can be used to add new features, integrate with other tools, customize the panel within Storybook, and enhance the development workflow.

What are @storybook/addons's main functionalities?

Addon Registration

This feature allows developers to register new addons with Storybook. The code sample demonstrates how to import the addons API and use it to register a custom addon.

import { addons } from '@storybook/addons';
import MyAddon from './my-addon';

addons.register('my-addon', MyAddon);

Addon Panel Creation

This feature allows developers to create new panels in the Storybook UI. The code sample shows how to add a new panel using the addons API.

import { addons, types } from '@storybook/addons';
import MyPanel from './my-panel';

addons.add('my-panel', {
  type: types.PANEL,
  title: 'My Panel',
  render: ({ active, key }) => (
    <MyPanel active={active} key={key} />
  )
});

Addon Tool Registration

This feature enables the addition of tools to the Storybook toolbar. The code sample illustrates how to register a new tool that will be displayed when the view mode is set to 'story'.

import { addons, types } from '@storybook/addons';
import MyTool from './my-tool';

addons.add('my-tool', {
  type: types.TOOL,
  title: 'My Tool',
  match: ({ viewMode }) => viewMode === 'story',
  render: MyTool
});

Other packages similar to @storybook/addons

Changelog

Source

7.6.12

  • CLI: Fix upgrade detecting the wrong version of existing Storybooks - #25752, thanks @JReinhold!

Readme

Source

The contents of this package have moved to @storybook/preview-api and @storybook/manager-api. Please update your import depending on where are using this API.

This package will no longer be released as part of the 8.0 release of storybook.

Keywords

FAQs

Last updated on 31 Jan 2024

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc