# @electric-sql/react 中文文档

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

版本：1\.0\.57
npm 元数据更新时间：2026-09-09T11:29:42.457Z
中文译文更新时间：2026-11-13T11:00:28.706Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：73.2 kB，15 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：react \>=18\.3\.1 \<20\.0\.0
- 首次发布：2024-07-17T16:02:22.134Z
- 最新版本发布：2026-09-09T11:29:42.150Z
- 近 30 天下载量：143808（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：102（近 12 个月 39 个）

## 中文简介

电源SQL反应钩

## 安装

```sh
npm install @electric-sql/react
```

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

## README

# 电气SQL 反应集成

Electric是现代应用程序的Postgres同步.

Electric为Postgres提供HTTP接口,使大量客户端能够查询并获得"形状"即数据库子集中数据的实时更新. 电能将Postgres变成实时数据库.

这个软件包会显示一个 `useShape` 将形状数据拖入您反应组件的钩子 .

`Shapes` 财务报告和审定财务报表 `ShapeStreams` 实例在全球范围被缓存,因此在多个组件中重新使用形状是便宜的.

## 安装

`npm i @electric-sql/react`

## 如何使用

添加 `useShape` 改为组件

```tsx
import { useShape } from '@electric-sql/react'

export default function MyComponent() {
  const { isLoading, data } = useShape({
    url: 'http://my-api.com/shape',
    params: {
      table: `foo`,
    },
  })

  if (isLoading) {
    return <div>loading</div>
  }

  return (
    <div>
      {data.map((foo) => (
        <div>{foo.title}</div>
      ))}
    </div>
  )
}
```

## 常见问题

### @electric-sql/react 是什么？

电源SQL反应钩

### 如何安装 @electric-sql/react？

在项目目录运行 npm install @electric-sql/react，或使用 pnpm add / yarn add / bun add。

### @electric-sql/react 支持 TypeScript 吗？

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

### @electric-sql/react 支持 ESM 还是 CommonJS？

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

### @electric-sql/react 可以商用吗？

@electric-sql/react 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @electric-sql/react 的下载量有多少？

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

### @electric-sql/react 还在维护吗？

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