ng-zorro-developer
Generates NG-ZORRO code and guidance for Angular projects using `ng-zorro-antd`. Covers installation, LESS-variable theming (default, dark, compact, aliyun presets), the experimental dynamic CSS-variable theme, component usage across all categories (general, layout, navigation, data entry, data display, feedback), ReactiveForms / Signal Forms integration via `nz-form`, internationalisation (`provideNzI18n`), accessibility, and the module → standalone migration. Use when the user mentions NG-ZORRO, ng-zorro, ng-zorro-antd, Ant Design for Angular, `nz-*` components, `Nz*Module`, OR when the Angular project's `package.json` contains `ng-zorro-antd`. Pairs with `angular-developer` for Angular fundamentals.
Mofiro Jean · 已有静态检查记录
安装与使用
运行命令前先阅读来源与依赖说明。复制命令不会自动安装或执行。
npx skills add mofirojean/angular-ui-skills --skill ng-zorro-developer技能说明
name: ng-zorro-developer
description: Generates NG-ZORRO code and guidance for Angular projects using ng-zorro-antd. Covers installation, LESS-variable theming (default, dark, compact, aliyun presets), the experimental dynamic CSS-variable theme, component usage across all categories (general, layout, navigation, data entry, data display, feedback), ReactiveForms / Signal Forms integration via nz-form, internationalisation (provideNzI18n), accessibility, and the module → standalone migration. Use when the user mentions NG-ZORRO, ng-zorro, ng-zorro-antd, Ant Design for Angular, nz-* components, Nz*Module, OR when the Angular project's package.json contains ng-zorro-antd. Pairs with angular-developer for Angular fundamentals.
license: MIT
metadata:
author: Mofiro Jean
version: '0.0.1'
NG-ZORRO Developer Guidelines
Pairs with
angular-developer, that skill provides Angular fundamentals (signals, DI, routing, forms, SSR, accessibility). This skill focuses on NG-ZORRO specifics. Install both for the best experience.
Compatibility
- Tracks:
ng-zorro-antd@22.0.0, aligned with Angular^22.0.0. NG-ZORRO follows Angular's major version, the major number ofng-zorro-antdalways matches@angular/core. - v21 → v22 (real breaking changes): v22 removes long-deprecated inputs and changes date-component setup. The headline items: date-related components no longer ship a default date adapter (call
provideNzDateFnsAdapter()explicitly, anddate-fnsis now v4); all components moved toOnPush; and a batch of deprecated APIs were removed (nz-buttonnzSearch,nz-cascadernzDisplayWith,nz-inputnzAutosize+nz-input-groupslots +nzStepperless,nz-modalnzOnOk/nzOnCancelinput usage,nz-uploadnzTransformFile,nz-tooltipcdkConnectedOverlayPush, plus dropdown/collapse/message/transfer removals). See migration.md. - Works for: NG-ZORRO v17 → v22 projects. The skill assumes the v21/v22 API surface, the
migration.mdreference covers the module → standalone shift, the i18n provider change, the v22 removals, and the per-version deprecations. - Angular: v17 or newer (standalone components and the new control flow); v22 for
ng-zorro-antd@22. v22 is the closest match. - Zoneless / OnPush: NG-ZORRO officially supports zoneless change detection and
ChangeDetectionStrategy.OnPush, the components are signal-aware and usemarkForCheck()internally where needed. - SSR: First-class. Works under Angular Universal /
@angular/ssr. - Internationalisation:
provideNzI18n(en_US)at the root, swap locales at runtime viaNzI18nService. - Not supported: NG-ZORRO v16 and below (Angular v16 and below, NgModule-only patterns, no signals support).
If the project's ng-zorro-antd major doesn't match @angular/core, the install will fail npm peer checks. Tell the user to upgrade Angular first, then NG-ZORRO, in lockstep, see migration.md.
-
Check the project's NG-ZORRO version before answering. Major versions track Angular and pick up real changes, the i18n provider became
provideNzI18nin v17, full standalone-class exports landed in v18, dynamic theme is still experimental in v21.package.jsonis the source of truth. -
Detect the import style up front. Pre-v18 code imports
Nz*Moduleand registers them in@NgModule.imports. v18+ exports each component as a standalone class (e.g.NzButtonComponent) plus a slim directive set (e.g.NzButtonDirectivefor thenz-buttonattribute). New code should use standalone imports, neverNz*Modulein a v18+ project. Both styles still work, mixing them in a single template is fine. See setup.md. -
Detect the theming mode. If
src/styles.lessimportsng-zorro-antd/ng-zorro-antd.less→ LESS variable mode (the default). If the project usesng-zorro-antd/style/dynamic-theme/dynamic-theme.lessandNzConfigServiceto flip CSS variables at runtime → Dynamic theme (experimental). The two paths share variable names but customise at very different layers. See theming.md. -
After generating NG-ZORRO code, run
ng build. The most common AI mistakes are: (a) importingNz*Moduleinto a standalone component (works, but stale pattern, prefer the standalone class); (b) forgetting to register the locale (provideNzI18n(en_US)), which makes DatePicker / Pagination throw at runtime; (c) using v15-eranzI18nServiceinitialisation viaAPP_INITIALIZER, replaced by the provider in v17; (d) using<nz-icon>withoutprovideNzIconsPatch/ registering icons viaprovideNzIcons. See setup.md and migration.md.
NG-ZORRO architecture: directives, components, services
NG-ZORRO mixes three patterns. Knowing which one a component uses changes how you wire it up:
- Attribute directives on native elements, e.g.
<button nz-button nzType="primary">Save</button>. The directive enhances a native control. Most general components (Button, Tooltip, Popover, Dropdown trigger) follow this shape. - Standalone components, e.g.
<nz-table>,<nz-form-item>,<nz-date-picker>. Render their own DOM, used for anything with internal layout or template projection. - Injectable services for imperative UI,
NzModalService,NzMessageService,NzNotificationService,NzDrawerService. Imported viaprovideNzModal()/provideNzMessage()etc. inapp.config.ts.
Default to the directive form when both exist (e.g. nz-button over a wrapper component). Reach for the service form when the surface is genuinely imperative (toasts, transient confirmations, programmatic dialogs).
Installation and theming
- Setup:
ng add ng-zorro-antd(schematics handles i18n, styles, animations, icon registration). Manual install,provideNzI18n, `provideNzI