Socket
Socket
Sign inDemoInstall

@storybook/api

Package Overview
Dependencies
53
Maintainers
5
Versions
1277
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @storybook/api

Core Storybook API & Context


Version published
Weekly downloads
4.5M
increased by1.32%
Maintainers
5
Created
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.0.0-alpha.33 (September 13, 2022)

Features
  • Core: Add a new throwPlayFunctionExceptions parameter #19143
Bug Fixes
  • Fix issue in instrumenter with waitFor #19145
  • Core: Fix static dirs targeting same destination #19064
  • React: Fix issue with react 18 implementation #19125
  • CLI: Fix spawning child processes on windows #19019
  • Vite: Ensure we set DOCS_OPTIONS in the vite builder #19127
Maintenance
  • Build: Bundle @storybook/cli with tsup #19138
  • Examples: Remove cra-ts-essentials #19170
  • Added some basic interactions stories #19153
  • Presets: Replace config with previewAnnotations, remove previewEntries #19152
  • Addon-links: Move stories into addon #19124
  • Addon-a11y: Move stories into addon #19114
  • Toolbars: Generic example stories #19166
  • TypeScript: Revert a few @ts-expect-errors #19168
  • Addon-docs: Generic stories for DocsPage #19162
  • Controls: Generic stories for sorting #19161
  • Build: Generic stories for addon-controls #19149
  • remove node12 from the matrix #19147
  • Build libs/router with ts-up #19140
  • Build: Bundle addon-interactions with tsup #19139
  • Generic stories for remaining core features #19118
  • Add parameter, loader and decorator stories to lib/store #19105
  • Convert @ts-ignore to @ts-expect-error #19122
Dependency Upgrades
  • Upgrade emotion deps again #19054

Keywords

FAQs

Last updated on 13 Sep 2022

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