# @generic-ui/ngx-grid 中文文档

规范地址：https://npmcn.com/package/%40generic-ui/ngx-grid/

版本：0\.21\.0
npm 元数据更新时间：2023-11-12T13:29:59.715Z
中文译文更新时间：2026-11-16T03:21:03.706Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：7.5 MB，1732 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：@angular/common ^17\.0\.0，@angular/core ^17\.0\.0，@angular/forms ^17\.0\.0，@angular/platform-browser ^17\.0\.0，@generic-ui/fabric 0\.21\.0，@generic-ui/hermes 0\.21\.0，rxjs ~7\.8\.0
- 首次发布：2019-06-22T07:07:36.962Z
- 最新版本发布：2023-11-12T13:29:59.542Z
- 近 30 天下载量：2557（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：66（近 12 个月 0 个）

## 中文简介

一般 UI - 角网格库

## 安装

```sh
npm install @generic-ui/ngx-grid
```

也可以使用：`pnpm add @generic-ui/ngx-grid`、`yarn add @generic-ui/ngx-grid`、`bun add @generic-ui/ngx-grid`

## README

# [通用UI - 角网格](https://generic-ui.com/)

## 网格组件

**通用 UI 网格** 这是最好的免费之一 [角网格库](https://generic-ui.com/)。 。 。 . 它提供了许多内置的功能,这些功能在盒子里起作用: 编辑,排序,页码化,主题,摘要,列配置,以及更多. 性能是主要的焦点点,网格能够提出高达一万行的庞大数据集. 它与最好的结合 [javascript 框架有角](https://angular.io/)。 。 。 . 所有这一切使这个图书馆 是一个很大的自由使用 **角数据 图表 插件**。 。 。 .

![demo](https://generic-ui.com/assets/example/grid.png)

## 快速示例

通用 UI 很容易使用, 您只需要指定列和源 。 下面是简单的使用我们的网格 有三个柱子和三个项目.

![demo](https://generic-ui.com/assets/images/grid-basic.png)

创建gui-grid将在这些简单的步骤中完成:

### 设置模板

在网格组件中指定列和源 包含 GuiGrid 模块 设置模板 在您 html 模板中添加下面的代码 。 注意到 `<gui-grid>` 有两个输入 `[columns]` 财务报告和审定财务报表 `[source]`。这些将帮助您指定网格的形状和您想要绑定的数据.

**app. community.html : (中文(简体) )**

```
<gui-grid [columns]="columns"
      [source]="source">
</gui-grid>
```

### 指定列和源

现在在内部写一个变量 `app.component.ts` 以列命名,我们会用它创建列标题。 在这个例子中,我们使用两个属性:

-   页眉代表显示页眉名称,
-   字段绑定源数据.

您可以在一个列中找到更多列选项

**应用程序组件( t) :**

```
columns: Array<GuiColumn> = [{
    header: 'Name',
    field: 'name'
}, {
    header: 'Type',
    field: 'type'
}, {
    header: 'Price',
    field: 'price'
}];
```

我们指定了列,现在我们需要把它与源. 创建名为源的新变量 `app.component.ts` 并复制下面的代码. 内部来源为三个项目,每个项目有三个值: `name`, (中文(简体) ), `type`, (中文(简体) ), `price`。这些值是我们列字段的名称.

**应用程序组件.ts**

```
source: Array<any> = [{
    name: 'T-shirt',
    type: 'clothes',
    price: '15$'
}, {
    name: 'Shoes',
    type: 'footwear',
    price: '100$'
}, {
    name: 'Ball cap',
    type: 'headgear',
    price: '50$'
}];
```

### 包含 GuiGrid 模块

唯一剩下的就是包括 `GridModule` 内 `app.module.ts` 而我们结束了.

**应用模块.ts**

```
import { GuiGridModule } from '@generic-ui/ngx-grid';

@NgModule({
    imports: [
        GuiGridModule
    ]
})
export class BasicModule {
}
```

## 安装

首先需要安装 _@generic-ui/ngx-grid (英语)_ 包含所有对等依赖的软件包.

Npm 安装 :

```Bash
npm install @generic-ui/ngx-grid element-resize-detector@1.1.14
```

Yarn 安装 :

```Bash
yarn add @generic-ui/ngx-grid element-resize-detector@1.1.14
```

确保您使用 **角质** 在6.0.0以上的版本中,至少6.1.10和Rxjs.

## 网格 API

您可以在此查找配置 gui- grid 的输入和输出列表 .

为了构建网格,需要指定和定义数据源。 来源和分栏需要共同努力,因此分栏必须与数据源相接。 基础部分得到了一个简单的指南如何做到这一点.

一般用户界面完全可编辑 。 请具体说明:

-   宽而高,
-   不同主题,如: Fabric, Materic, Light, Dark,
-   头放在网格上和/或下方,
-   禁用或启用垂直和水平线,
-   行颜色,
-   装入指标.

通用 UI 还提供了输出选项, 当 :

-   页面更改,
-   页面大小变化,
-   选择了网格行.

## 联系人

请随意与我们联系任何问题或议题,因为FAQ将在近期发布. 我们会很感激你告诉我们你如何使用 此角网格库 。 如果你发现任何错误,让我们知道它通过 [报告问题](https://github.com/generic-ui/generic-ui/issues)。 。 。 .

## 许可证 :

代码根据 [麻省理工学院执照](https://github.com/generic-ui/generic-ui/blob/master/grid/LICENSE)。 。 。 .

## 常见问题

### @generic-ui/ngx-grid 是什么？

一般 UI - 角网格库

### 如何安装 @generic-ui/ngx-grid？

在项目目录运行 npm install @generic-ui/ngx-grid，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@angular/common（^17\.0\.0）、@angular/core（^17\.0\.0）、@angular/forms（^17\.0\.0）、@angular/platform-browser（^17\.0\.0）、@generic-ui/fabric（0\.21\.0）、@generic-ui/hermes（0\.21\.0）、rxjs（~7\.8\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @generic-ui/ngx-grid 支持 TypeScript 吗？

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

### @generic-ui/ngx-grid 支持 ESM 还是 CommonJS？

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

### @generic-ui/ngx-grid 可以商用吗？

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

### @generic-ui/ngx-grid 的下载量有多少？

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

### @generic-ui/ngx-grid 还在维护吗？

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

