Socket
Socket
Sign inDemoInstall

@storybook/api

Package Overview
Dependencies
66
Maintainers
8
Versions
1277
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@storybook/api

Storybook Manager API (facade)


Version published
Maintainers
8
Weekly downloads
4,462,826
increased by6.92%

Weekly downloads

Package description

What is @storybook/api?

The @storybook/api package is a part of Storybook, which is an open-source tool for developing UI components in isolation for React, Vue, Angular, and more. It provides a set of APIs that allow developers to interact with Storybook's internal state and methods, enabling them to create custom addons and tools that can enhance the Storybook experience.

What are @storybook/api's main functionalities?

useStorybookApi

This hook allows you to access the Storybook API within your components or addons to interact with Storybook's state and functions, such as selecting a specific story.

import { useStorybookApi } from '@storybook/api';
const api = useStorybookApi();
api.selectStory('component-id');

useAddonState

This hook is used to persist state across the Storybook UI. It's useful for addons that need to maintain state.

import { useAddonState } from '@storybook/api';
const [state, setState] = useAddonState('your-addon-id', initialState);

useParameter

This hook allows you to retrieve the value of a parameter passed to a story, which can be used to customize the behavior of an addon.

import { useParameter } from '@storybook/api';
const parameter = useParameter('parameterName', defaultValue);

Other packages similar to @storybook/api

Changelog

Source

7.6.17

  • Addon-docs: Fix Table of Contents heading leak - #23677, thanks @vmizg!
  • Core: Update ip version to fix CVE-2023-42282 - #26086, thanks @drik98!

Readme

Source

The contents of this package have moved to @storybook/manager-api. Please update your import.

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

Keywords

FAQs

Last updated on 20 Feb 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