# @alaarab/ogrid-react 中文文档

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

版本：2\.21\.2
npm 元数据更新时间：2026-10-22T19:27:19.385Z
中文译文更新时间：2026-11-06T14:05:03.095Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：1 MB，208 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：2 个
- peer 依赖：react ^17\.0\.0 \|\| ^18\.0\.0 \|\| ^19\.0\.0，react-dom ^17\.0\.0 \|\| ^18\.0\.0 \|\| ^19\.0\.0，@testing-library/react ^16\.3\.3
- 首次发布：2026-02-11T19:57:55.117Z
- 最新版本发布：2026-10-22T19:27:19.020Z
- 近 30 天下载量：3056（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：88（近 12 个月 88 个）

## 中文简介

Ogrid React – 反应钩,无头组件,以及Ogrid数据网格的公用.

## 安装

```sh
npm install @alaarab/ogrid-react
```

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

## README

# @alaarab/ogrid-反应

反应钩和无头组件由OGrid UI两个包共用. 支持反应和反应DOM 17、18和19;取决于 `ogrid-core` 财务报告和审定财务报表 `@tanstack/react-virtual`。 。 。 .

```bash
npm install @alaarab/ogrid-react react react-dom
```

使用 `@alaarab/ogrid-react-radix` 或者说 `@alaarab/ogrid-react-fluent` 为现成的网格。 二者再出此API. 使用此软件包来制作自己的表格 :

```tsx
import { useHeadlessGrid, type IColumnDef } from '@alaarab/ogrid-react';

interface Row { id: string; name: string }
const columns: IColumnDef<Row>[] = [
  { columnId: 'name', name: 'Name', sortable: true },
];

export function CustomTable({ data }: { data: Row[] }) {
  const grid = useHeadlessGrid({ columns, data, getRowId: (row) => row.id });
  return (
    <table>
      <thead>
        <tr>{grid.columns.map((column) => (
          <th key={column.columnId}>
            <button type="button" onClick={() => grid.toggleSort(column.columnId)}>
              {column.name} {grid.sortIndicator(column.columnId)}
            </button>
          </th>
        ))}</tr>
      </thead>
      <tbody>{grid.rows.map((row) => (
        <tr key={grid.getRowId(row)}>{grid.columns.map((column) => (
          <td key={column.columnId}>{String(grid.getCellValue(row, column.columnId) ?? '')}</td>
        ))}</tr>
      ))}</tbody>
    </table>
  );
}
```

`useHeadlessGrid` 管理排序/过滤/剪贴和基本行选择。 编曲 `useInlineEdit`, (中文(简体) ), `useRangeSelection`, (中文(简体) ), `useFillHandle`, (中文(简体) ), `useCellClipboard`, (中文(简体) ), `useUndoRedo` 财务报告和审定财务报表 `useGridFocus` 用于电子表格互动。 你把他们的事情线上, 并制造UI [无头向导](https://alaarab.github.io/ogrid/docs/headless) 财务报告和审定财务报表 [钩入引用](https://alaarab.github.io/ogrid/docs/api/headless-hooks)。 。 。 .

组件层还共享合并,冻结/结构命令,查找/重置,注释,有条件的格式化,验证,公式协助和工具箱之间的拖动行为. 可选形式和行为有懒惰的条目;独立验证表导出于 `@alaarab/ogrid-react/data-validation`。 。 。 .

`@alaarab/ogrid-react/testing` 出口共享试验工厂。 此可选条目需要 `@testing-library/react` 16和回声18+.

麻省理工学院有执照.

## 常见问题

### @alaarab/ogrid-react 是什么？

Ogrid React – 反应钩,无头组件,以及Ogrid数据网格的公用\.

### 如何安装 @alaarab/ogrid-react？

在项目目录运行 npm install @alaarab/ogrid-react，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^17\.0\.0 \|\| ^18\.0\.0 \|\| ^19\.0\.0）、react-dom（^17\.0\.0 \|\| ^18\.0\.0 \|\| ^19\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @alaarab/ogrid-react 支持 TypeScript 吗？

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

### @alaarab/ogrid-react 支持 ESM 还是 CommonJS？

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

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

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

### @alaarab/ogrid-react 可以商用吗？

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

### @alaarab/ogrid-react 的下载量有多少？

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

### @alaarab/ogrid-react 还在维护吗？

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