Socket
Socket
Sign inDemoInstall

@storybook/types

Package Overview
Dependencies
6
Maintainers
29
Versions
640
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@storybook/types


Version published
Maintainers
29
Created

Package description

What is @storybook/types?

The @storybook/types package provides TypeScript definitions and utility types for Storybook, a popular tool for developing UI components in isolation. It facilitates type checking and development within the Storybook ecosystem, ensuring that components and their stories adhere to expected types.

What are @storybook/types's main functionalities?

Storybook Component Types

Defines types for Storybook stories, ensuring that the stories and their configurations adhere to the correct structure and types.

import { Story, Meta } from '@storybook/types';

export default {
  title: 'Button',
  component: Button
} as Meta;

export const Primary: Story = (args) => <Button {...args} />;
Primary.args = {
  primary: true,
  label: 'Click Me'
};

Addon Development

Provides types for developing Storybook addons, helping developers to integrate additional functionality into Storybook with type safety.

import { Addon } from '@storybook/types';

const myAddon: Addon = {
  title: 'My Custom Addon',
  type: 'panel',
  render: ({ active, key }) => (active ? <div id={key}>Addon Content</div> : null)
};

Other packages similar to @storybook/types

Changelog

Source

7.0.0-beta.20 (January 6, 2023)

Bug Fixes
  • Telemetry: Move 'dev'/'build' events to the end of the process #20380
  • Blocks: Export Unstyled block in index.ts #20489
  • Vite: Fix missing await in builder #20409
Maintenance
  • Build: use tsup for csf-plugin #20150
  • Migration: Update autodocs migration to deal with docs.docsPage #20379
Build
  • Blocks: Use example Button for stories #20483
  • Build: cleanup prep script where possible #20151
  • cleanup CI config #20510
  • Build: Fix CI parallelism #20476
  • Web-components: Restore missing script stories #20477

Readme

Source

Storybook Types

Storybook types exports only typescript types for storybook usage.

It exports typescript enums, which do have a runtime implementation. But it should not export any implementation such as classes, method, function or constants.

It also has no dependencies, all the types it exports are bundled in.

Keywords

FAQs

Last updated on 06 Jan 2023

Did you know?

Socket

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

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc