故事书 localStorage Addon

A 类 故事书 用于模拟和显示当前值的外加和装饰器 window.localStorage 在故事书面板中

如果你想设置 parameters 输入,请参看 @alexgorbatchev/故事手册参数。 。 。 .

安装

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

将添加注册到 .storybook/main.ts

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

重要

• 若为 parameters.localStorage 已经设定, localStorage.clear() 将被调用之前 充电值.
• 传入的数值 parameters.localStorage 必须是字符串 因为 localStorage 只用绳子 你用得着 JSON.stringify 或由加通提供辅助功能 调用 localStorageForStorybook。 。 。 .
• 最后,重要的是要注意的是, 附加作品通过投票和散发 嘲笑价值 内 localStorage 每100ms (英语).

使用量

在一个简单的部分:

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>
  );
};

你可以把故事写成

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 serializer, 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 开始故事书
• npm test 运行测试
• npm run test:watch 在监视模式下运行测试
• tsup 构建 ./dist