MCPcopy Index your code
hub / github.com/NG-ZORRO/ng-zorro-antd

github.com/NG-ZORRO/ng-zorro-antd @21.3.2 sqlite

repository ↗ · DeepWiki ↗ · release 21.3.2 ↗
7,742 symbols 17,342 edges 1,925 files 168 documented · 2% 2 cross-repo links
README

logo

NG-ZORRO

ng-zorro-antd 是 Ant Design 的 Angular 实现,主要用于研发企业级中后台产品。全部代码开源并遵循 MIT 协议,任何企业、组织及个人均可免费使用。

Azure branch CodeFactor Codecov GitHub Release Date NPM package NPM downloads GitHub license Discord VSCode Extension Code style: prettier X

logo

English | 简体中文

✨ 特性

  • 提炼自企业级中后台产品的交互语言和视觉风格。
  • 开箱即用的高质量 Angular 组件,与 Angular 保持同步升级。
  • 使用 TypeScript 构建,提供完整的类型定义文件。
  • 支持 Zoneless 和 OnPush 模式,性能卓越。
  • 数十个国际化语言支持。
  • 深入每个细节的主题定制能力。

☀️ 授权协议

GitHub license FOSSA Status

🖥 支持环境

| Edge

Edge | Firefox

Firefox | Chrome

Chrome | Safari

Safari | Opera

Opera | Electron

Electron | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | last 2 versions | last 2 versions | last 2 versions | last 2 versions | last 2 versions | last 2 versions |

🎨 设计规范

ng-zorro-antd 与 Ant Design 设计规范定期同步,你可以在线查看同步日志

📦 安装

我们强烈推荐官方的 @angular/cli 工具链辅助进行开发,在实际项目开发中,它可以很好的满足对 TypeScript 代码的构建、调试、代理、打包部署等一系列工程化的需求。

$ ng new PROJECT_NAME
$ cd PROJECT_NAME
$ ng add ng-zorro-antd

如果你想了解更多CLI工具链的功能和命令,建议访问 Angular CLI 了解更多

🔨 使用

将想要使用的组件模块引入到你的组件中。

import { NzButtonModule } from 'ng-zorro-antd/button';

@Component({
  imports: [NzButtonModule]
})
export class AppComponent {}

@angular/cli 的用户不需要担心下面这项设置,但知道也挺有好处。

然后在 angular.json 文件中引入样式和 SVG icon 资源。

{
  "assets": [
+   {
+     "glob": "**/*",
+     "input": "./node_modules/@ant-design/icons-angular/src/inline-svg/",
+     "output": "/assets/"
+   }
  ],
  "styles": [
+   "node_modules/ng-zorro-antd/ng-zorro-antd.min.css"
  ]
}

参考快速上手以了解更多。

🔗 链接

⌨️ 开发

$ git clone git@github.com:NG-ZORRO/ng-zorro-antd.git
$ cd ng-zorro-antd
$ npm install
$ npm run start

浏览器会自动打开。

🤝 如何贡献

PRs Welcome

在任何形式的参与前,请先阅读 贡献者文档。如果你希望参与贡献,欢迎 Pull Request,或给我们 报告 Bug

强烈推荐阅读 《提问的智慧》(本指南不提供此项目的实际支持服务!)、《如何向开源社区提问题》《如何有效地报告 Bug》《如何向开源项目提交无法解答的问题》,更好的问题更容易获得帮助。

感谢 JetBrains 提供的免费开源 License 赞助

JetBrains

❓ 社区互助

如果您在使用的过程中碰到问题,可以通过下面几个途径寻求帮助,同时我们也鼓励资深用户通过下面的途径给新人提供帮助。

通过 Stack Overflow 或者 Segment Fault 提问时,建议加上 ng-zorro-antd 标签。

  1. Stack Overflow(English)
  2. Segment Fault(中文)
  3. Discord
  4. 加入钉钉 NG-ZORRO 自助服务群(中文)

ding talk qr-code

🎉 谁在使用

我们在这里列出了部分使用者,如果你的公司和产品使用了 NG-ZORRO,欢迎到 这里 留言。

Extension points exported contracts — how you extend this code

NzImageContainerOperation (Interface)
(no doc) [13 implementers]
components/image/image-preview.component.ts
NzTreeNodeBaseComponent (Interface)
(no doc) [6 implementers]
components/core/tree/nz-tree-base.definitions.ts
PanelSelector (Interface)
(no doc) [13 implementers]
components/date-picker/lib/interface.ts
ModalButtonOptions (Interface)
(no doc) [13 implementers]
components/modal/modal-types.ts
FlatNode (Interface)
Flat node with expandable and level information
components/tree-view/demo/virtual-scroll.ts
AbstractTestTransferComponent (Interface)
(no doc) [2 implementers]
components/transfer/transfer.spec.ts
NzCascaderComponentAsSource (Interface)
(no doc) [1 implementers]
components/cascader/typings.ts
NzDrawerOptionsOfComponent (Interface)
(no doc) [1 implementers]
components/drawer/drawer-options.ts

Core symbols most depended-on inside this repo

detectChanges
called by 3702
components/upload/upload-list.component.ts
detectChanges
called by 886
components/timeline/timeline-item.component.ts
createComponent
called by 597
components/popconfirm/popconfirm.ts
subscribe
called by 423
components/core/services/breakpoint.ts
click
called by 407
components/collapse/collapse.component.ts
dispatchMouseEvent
called by 405
components/core/testing/dispatch-events.ts
set
called by 364
components/core/config/config.service.ts
markForCheck
called by 245
components/core/tree/nz-tree-base.definitions.ts

Shape

Class 3,446
Method 3,199
Function 763
Interface 330
Enum 4

Languages

TypeScript100%

Modules by API surface

components/cascader/cascader.component.ts70 symbols
components/core/config/config.ts54 symbols
components/qr-code/qrcodegen.ts50 symbols
components/date-picker/date-picker.component.ts47 symbols
components/core/time/candy-date.ts46 symbols
components/slider/slider.spec.ts45 symbols
components/slider/slider.component.ts43 symbols
components/tooltip/base.ts39 symbols
components/time-picker/time-picker-panel.component.ts39 symbols
components/style/color/tinycolor2.cjs38 symbols
components/select/select.component.ts38 symbols
components/core/tree/nz-tree-base.service.ts38 symbols

Used by 2 indexed graphs manifest dependencies, hub-wide

Dependencies from manifests, versioned

@angular-devkit/core21.2.12 · 1×
@angular-devkit/schematics21.2.12 · 1×
@angular/animations21.2.14 · 1×
@angular/build21.2.12 · 1×
@angular/cdk21.2.12 · 1×
@angular/cli21.2.12 · 1×
@angular/common21.2.14 · 1×
@angular/compiler21.2.14 · 1×
@angular/compiler-cli21.2.14 · 1×
@angular/core21.2.14 · 1×
@angular/forms21.2.14 · 1×
@angular/language-service21.2.14 · 1×

For agents

$ claude mcp add ng-zorro-antd \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact