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

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

版本：10\.0\.1
npm 元数据更新时间：2026-03-10T22:51:24.932Z
中文译文更新时间：2026-11-06T22:46:48.570Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：251 kB，36 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：jotai ^2\.0\.0，react ^18\.0\.0 \|\| ^19\.0\.0，react-dom ^18\.0\.0 \|\| ^19\.0\.0
- 首次发布：2023-11-21T21:14:11.516Z
- 最新版本发布：2026-03-10T22:51:24.809Z
- 近 30 天下载量：2215（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：21（近 12 个月 2 个）

## 中文简介

故事书的附加内容允许您使用并模拟依赖乔泰的回放组件.

## 安装

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

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

## README

# 故事书 Jotai Addon

A 类 [故事书](https://storybook.js.org/) v10 添加和装饰器用于 [乔泰](https://jotai.org/) 在故事书面板上嘲笑和显示当前值.

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

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

## 安装

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

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

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

## 重要

请记住,加通包了一切 `Provider` 从 `jotai` 软件包。 这很重要 你的故事内容不包括 `Provider`否则,加登将无法看到和设置 原子值.

## 使用量

在一个简单的部分:

```tsx
import { useAtom, atom } from 'jotai';

const userAtom = atom(null);

export const Header = () => {
  const [user] = useAtom(userAtom);

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

你可以把故事写成

```tsx
import { atomsForStorybook } from '@alexgorbatchev/storybook-addon-jotai';
import { Meta, StoryObj } from '@storybook/react';

import { User, userAtom } from './User';

type Story = StoryObj<typeof Header>;

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

export default meta;

export const JohnLoggedIn: Story = {
  parameters: {
    jotai: atomsForStorybook({
      atoms: {
        user: userAtom,
      },
      values: {
        user: {
          name: 'John Doe',
        },
      },
    }),
  },
};

// `jotai`, `atoms`, and `values` each can be a function for deferred evaluation.
export const JaneLoggedIn: Story = {
  parameters: {
    jotai: () => atomsForStorybook({
      atoms: () => ({
        user: userAtom,
      }),
      values: () => ({
        user: {
          name: 'Jane Doe',
        },
      }),
    }),
  };
};

export const LoggedOut: Story = {};
```

强键示例 :

```tsx
import { Meta, StoryObj } from '@alexgorbatchev/storybook-parameters';
import { JotaiParameters } from '@alexgorbatchev/storybook-addon-jotai';

import { User, userAtom } from './User';

interface StoryParameters extends JotaiParameters {}

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

export default meta;

type Story = StoryObj<typeof Header, StoryParameters>;

export const JohnLoggedIn: Story = {
  parameters: {
    // `jotai` is strongly typed
    jotai: atomsForStorybook({
      atoms: {
        user: userAtom,
      },
      values: {
        user: {
          name: 'Jane Doe',
        },
      },
    }),
  },
};
```

## 开发脚本

-   `npm run storybook` 开始故事书
-   `npm run build` 正在建设 `./dist`
-   `npm test` 运行测试

## 常见问题

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

故事书的附加内容允许您使用并模拟依赖乔泰的回放组件\.

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

在项目目录运行 npm install @alexgorbatchev/storybook-addon-jotai，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：jotai（^2\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

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

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

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

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

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

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

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

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

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

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