Storybook localStorage 插件

一个用于在 Storybook 面板中模拟和显示 window.localStorage 当前值的 Storybook v8 插件和装饰器

如果你想将 parameters 设置为强类型，请参阅 @alexgorbatchev/storybook-parameters。

安装

npm i --save-dev @alexgorbatchev/storybook-addon-localstorage

在 .storybook/main.js 中注册插件

export default {
  stories: ['../stories/**/*.stories.tsx'],
  addons: ['@alexgorbatchev/storybook-addon-localstorage'],
};

重要

• 如果设置了 parameters.localStorage，在填充值之前将调用 localStorage.clear()。
• 传递给 parameters.localStorage 的值必须是字符串，因为 localStorage 只支持字符串。你可以使用 JSON.stringify，或者使用插件提供的名为 localStorageForStorybook 的辅助函数。
• 最后，值得注意的是，该插件通过每 100 毫秒轮询和对比 localStorage 中的模拟值来工作。

用法

假设有一个简单的组件

export const Header = () => {
  const [user, setUser, { removeItem }] = useLocalStorage<{ name: string }>('user');

  return (
    <div>
      {user ? (
        <div>
          <div>{`Logged in as ${user.name}`}</div>
          <Button size="small" label="Log out" onClick={() => removeItem()} />
        </div>
      ) : (
        <div>
          <div>No one is signed in</div>
          <Button size="small" label="Log in" onClick={() => setUser({ name: 'John' })} />
        </div>
      )}
    </div>
  );
};

你可以编写一个故事（story）如下

import { localStorageForStorybook } from '@alexgorbatchev/storybook-addon-localstorage';
import { Meta, StoryObj } from '@storybook/react';

import { Header } from './Header';

const meta: Meta<typeof Header> = {
  title: 'Example/Header',
  component: Header,
};

export default meta;

type Story = StoryObj<typeof Header>;

export const JohnLoggedIn: Story = {
  parameters: {
    // this helper automatically stringifies the values using `JSON.stringify`
    localStorage: localStorageForStorybook({
      value: 123,
      user: { name: 'John' },
    }),
  },
};

export const JaneLoggedIn: Story = {
  parameters: {
    // if you have own serialzer, you can use it as well
    localStorage: {
      value: '123',
      user: JSON.stringify({ name: 'Jane' }),
    },
  },
};

强类型示例

import { Meta, StoryObj } from '@alexgorbatchev/storybook-parameters';
import { LocalStorageParameters } from '@alexgorbatchev/storybook-addon-localstorage';

interface StoryParameters extends LocalStorageParameters {}

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

export default meta;

type Story = StoryObj<typeof Header, StoryParameters>;

export const JohnLoggedIn: Story = {
  parameters: {
    // `localStorage` will show up in `Parameters`
    localStorage: {
      key: 'value',
    },
  },
};

开发脚本

• npm run storybook 启动 Storybook
• tsup 构建 ./dist