# @bitsocial/bitsocial-react-hooks 中文文档

规范地址：https://npmcn.com/package/%40bitsocial/bitsocial-react-hooks/

版本：0\.1\.64
npm 元数据更新时间：2026-10-31T14:30:35.863Z
中文译文更新时间：2026-10-31T16:28:21.288Z
软件包许可：GPL-3\.0-or-later

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

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

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

- 包体积（解压后）：2.8 MB，314 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.19\.0
- 运行依赖：14 个
- peer 依赖：react \>=16\.8
- 首次发布：2026-04-20T07:07:03.407Z
- 最新版本发布：2026-10-31T14:30:35.535Z
- 已发布版本数：65（近 12 个月 65 个）

## 中文简介

React钩子和Zustand存储了Bitsocial协议——社区、评论、提要、作者、账户和发布

## 安装

```sh
npm install @bitsocial/bitsocial-react-hooks
```

也可以使用：`pnpm add @bitsocial/bitsocial-react-hooks`、`yarn add @bitsocial/bitsocial-react-hooks`、`bun add @bitsocial/bitsocial-react-hooks`

## README

![Bitsocial React Hooks — Build decentralized, serverless social apps with React using a familiar hooks API.](https://npmcn.com/package/%40bitsocial/bitsocial-react-hooks/docs/assets/readme/social-preview.png)

# Bitsocial React Hooks

**在互联网上建立自己的地盘。**

React hooks的社区、提要、对话、配置文件、帐户和发布 [Bitsocial协议](https://bitsocial.net/)。自带接口; 钩子通过Zustand存储将其连接到共享协议状态。

[**文档**](https://hooks.bitsocial.net/) · [**去游乐场试试**](https://hooks.bitsocial.net/#playground) · [API和配方](https://npmcn.com/package/%40bitsocial/bitsocial-react-hooks/docs/reference.md) · [npm](https://www.npmjs.com/package/@bitsocial/bitsocial-react-hooks)

[![The Bitsocial React Hooks playground: editable React code beside a social feed with author portraits, post images, and reply counts.](https://npmcn.com/package/%40bitsocial/bitsocial-react-hooks/docs/assets/readme/playground.jpg)](https://hooks.bitsocial.net/#playground)

_编辑组件并查看结果。游乐场使用模拟内容，不发布任何内容。_

支持 **反应16.8 +**。所使用的 [陈5](https://github.com/bitsocialnet/5chan).

## 开始构建

将这个包添加到现有的React应用中：

```bash
yarn add @bitsocial/bitsocial-react-hooks
```

在浏览器中使用一个现有的社区名来呈现这个组件：

```jsx
import { useCommunity } from "@bitsocial/bitsocial-react-hooks";

export default function CommunityCard({ name }) {
  const community = useCommunity({ community: { name } });

  if (!community.hasCachedData) {
    return (
      <p role="status">
        {community.error?.message || "Loading community…"}
      </p>
    );
  }

  return (
    <article>
      <h1>{community.title || name}</h1>
      <p>{community.description}</p>
    </article>
  );
}
```

该包将自动初始化本地帐户。你也可以通过以下方式来定义一个社区 `{ publicKey }`，或两者皆过 `{ name, publicKey }`。钩子共享缓存数据和订阅；使用 `syncState` 当需要显示后台刷新进度时。

## 浏览文档

阅读以下指南： [hooks.bitsocial.net](https://hooks.bitsocial.net/)，或在此浏览其来源：

-   [快速入门](https://npmcn.com/package/%40bitsocial/bitsocial-react-hooks/website/content/quickstart.md) -建立你的第一个feed。
-   [核心概念](https://npmcn.com/package/%40bitsocial/bitsocial-react-hooks/website/content/concepts.md) -社区、帐户、状态和发布。
-   [完整的API和配方](https://npmcn.com/package/%40bitsocial/bitsocial-react-hooks/docs/reference.md) -完整的钩子参考和实际的例子。
-   [模拟的内容](https://npmcn.com/package/%40bitsocial/bitsocial-react-hooks/docs/mock-content.md) -开发一个UI与样本数据。
-   [人工智能环境](https://npmcn.com/package/%40bitsocial/bitsocial-react-hooks/website/content/ai.md)， [llms.txt](https://npmcn.com/package/%40bitsocial/bitsocial-react-hooks/llms.txt), [llms-full.txt](https://npmcn.com/package/%40bitsocial/bitsocial-react-hooks/llms-full.txt) -编码助理的文档。

### 在本地运行网站

该网站位于 [`website/`](https://npmcn.com/package/%40bitsocial/bitsocial-react-hooks/website/README.md)。在浏览器中打开playground和docs：

```bash
cd website
corepack yarn install --immutable
corepack yarn start
```

## 贡献

使用Node 22.19或更新版本以及存储库固定的Yarn 4版本：

```bash
nvm install
nvm use
corepack yarn install
corepack yarn build
```

读 [测试和开发](https://npmcn.com/package/%40bitsocial/bitsocial-react-hooks/docs/testing.md)， [贡献者的指导](https://npmcn.com/package/%40bitsocial/bitsocial-react-hooks/AGENTS.md), [验证](https://npmcn.com/package/%40bitsocial/bitsocial-react-hooks/docs/agent-playbooks/verification.md) 集中检查。保持API示例与公共导出和类型保持一致；文档更改后，运行 `corepack yarn llms:generate`.

## 许可证

[gpl - 3.0 -或-](https://npmcn.com/package/%40bitsocial/bitsocial-react-hooks/LICENSE).

## 常见问题

### @bitsocial/bitsocial-react-hooks 是什么？

React钩子和Zustand存储了Bitsocial协议——社区、评论、提要、作者、账户和发布

### 如何安装 @bitsocial/bitsocial-react-hooks？

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

### @bitsocial/bitsocial-react-hooks 支持 TypeScript 吗？

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

### @bitsocial/bitsocial-react-hooks 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @bitsocial/bitsocial-react-hooks 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.19\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @bitsocial/bitsocial-react-hooks 可以商用吗？

@bitsocial/bitsocial-react-hooks 使用 GPL-3\.0-or-later 许可。强 Copyleft：分发包含该代码的软件时，整个作品需以 GPL-3\.0 兼容许可开源，并附带专利与反锁定条款。仅内部使用不触发此义务。以上为概括，不构成法律意见，请以许可原文为准。

### @bitsocial/bitsocial-react-hooks 还在维护吗？

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