# @alexgorbatchev/storybook-addon-localstorage 中文文档

规范地址：https://npmcn.com/package/%40alexgorbatchev/storybook-addon-localstorage/

版本：10\.0\.4
npm 元数据更新时间：2026-03-10T23:03:08.215Z
中文译文更新时间：2026-11-07T06:35:14.829Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40alexgorbatchev/storybook-addon-localstorage
原文对照：https://npmcn.com/package/%40alexgorbatchev/storybook-addon-localstorage/?lang=original
项目主页：https://github.com/alexgorbatchev/storybook-addon-localstorage#readme
源码仓库：https://github.com/alexgorbatchev/storybook-addon-localstorage

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：230 kB，36 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2023-11-28T23:55:17.459Z
- 最新版本发布：2026-03-10T22:56:44.118Z
- 近 30 天下载量：2036（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 5 个）

## 中文简介

用于嘲弄和展示的故事书 v8 附加 `localStorage` 数值

## 安装

```sh
npm install @alexgorbatchev/storybook-addon-localstorage
```

也可以使用：`pnpm add @alexgorbatchev/storybook-addon-localstorage`、`yarn add @alexgorbatchev/storybook-addon-localstorage`、`bun add @alexgorbatchev/storybook-addon-localstorage`

## README

# 故事书 localStorage Addon

A 类 [故事书](https://storybook.js.org/) 用于模拟和显示当前值的外加和装饰器 [`window.localStorage`](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) 在故事书面板中

如果你想设置 `parameters` 输入,请参看 [@alexgorbatchev/故事手册参数](https://github.com/alexgorbatchev/storybook-parameters)。 。 。 .

![](https://npmcn.com/package/%40alexgorbatchev/storybook-addon-localstorage/screenshot.png)

## 安装

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

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

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

## 重要

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

## 使用量

在一个简单的部分:

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

你可以把故事写成

```tsx
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' }),
    },
  },
};
```

强键示例 :

```tsx
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`

## 常见问题

### @alexgorbatchev/storybook-addon-localstorage 是什么？

用于嘲弄和展示的故事书 v8 附加 localStorage 数值

### 如何安装 @alexgorbatchev/storybook-addon-localstorage？

在项目目录运行 npm install @alexgorbatchev/storybook-addon-localstorage，或使用 pnpm add / yarn add / bun add。

### @alexgorbatchev/storybook-addon-localstorage 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @alexgorbatchev/storybook-addon-localstorage 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @alexgorbatchev/storybook-addon-localstorage 可以商用吗？

@alexgorbatchev/storybook-addon-localstorage 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @alexgorbatchev/storybook-addon-localstorage 的下载量有多少？

根据 npm 官方下载统计，@alexgorbatchev/storybook-addon-localstorage 在 2026/10/06 – 2026/11/04 这 30 天内被下载 2,036 次，日均约 68 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @alexgorbatchev/storybook-addon-localstorage 还在维护吗？

最新版本 10\.0\.4 发布于 2026/03/11（7 个月前）；至今共发布 12 个版本，其中过去 12 个月发布了 5 个；首次发布于 2023/11/29。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。