@alexgorbatchev/storybook-parameters v1.0.0

Strongly Typed Parameters for Storybook

This module only exports strongly TypeScript typings to assist with making Storybook's Parameters strongly typed.

Install

yarn add -D @alexgorbatchev/storybook-parameters

Example

import { ComponentMeta, ComponentStoryObj } from '@alexgorbatchev/storybook-parameters';

interface StoryParameters {
  cookies: string;
}

const Header = () => <div>Header</div>;

type Story = ComponentStoryObj<typeof Header, StoryParameters>;

const meta: ComponentMeta<typeof Header, StoryParameters> = {
  title: 'Header',
  component: Header,
};

export default meta;

export const JohnLoggedIn: Story = {
  // Will show missing `cookies` property error
  parameters: {},
};

export const JaneLoggedIn: Story = {
  parameters: {
    // strongly typed `cookies` property
    cookies: '123',
  },
};

Development scripts

• yarn start runs babel in watch mode and starts Storybook
• yarn build build and package your addon code