NG-ZORRO

Angular UI Component Library based on Ant Design

NG-ZORRO/ng-zorro-antd ng.ant.design ng-zorro-antd

README

NG-ZORRO

An enterprise-class Angular UI component library based on Ant Design.

English | 简体中文

✨ Features

- An enterprise-class UI design system for Angular applications.

- 60+ high-quality Angular components out of the box.

- Written in TypeScript with predictable static types.

- The whole package of development and design resources and tools.

- Support OnPush mode, high performance.

- Powerful theme customization in every detail.

- Internationalization support for dozens of languages.

☀️ License

MIT

🖥 Environment Support

Angular ^14.0.0

Server-side Rendering

Modern browsers including the following specific versions

Electron

[	[	[	[	[	[
---------	---------	---------	---------	---------	---------
Edge	last	last	last	last	last

🎨 Design Specification

ng-zorro-antd synchronizes design specification with Ant Design on a regular basis, you can check the log online.

📦 Installation

We recommend using @angular/cli to install. It not only makes development easier, but also allows you to take advantage of the rich ecosystem of angular packages and tooling.

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

More information about @angular/cli here.

You can also install ng-zorro-antd with npm or yarn

``` sh
$ npm install ng-zorro-antd
```

🔨 Usage

Import the component modules you want to use into your app.module.ts file and feature modules.

```ts
import { NzButtonModule } from 'ng-zorro-antd/button';
@NgModule({
imports: [ NzButtonModule ]
})
export class AppModule {
}
```

@angular/cli users won't have to worry about the things below but it's good to know.

And import style and SVG icon assets file link in angular.json.

```diff
{
"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"
]
}
```

See Getting Started for more details.

🔗 Links

ng-zorro-antd-mobile

ng-alain

Snippet extension for VSCode

⌨️ Development

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

Browser would open automatically.

🤝 Contributing

We welcome all contributions. Please read our CONTRIBUTING.md first. You can submit any ideas as pull requests or as GitHub issues.

If you're new to posting issues, we ask that you read [How To Ask Questions The Smart Way](http://www.catb.org/~esr/faqs/smart-questions.html) (This guide does not provide actual support services for this project!), How to Ask a Question in Open Source Community and How to Report Bugs Effectively prior to posting. Well written bug reports help us help you!

Thanks to JetBrains for supporting us free open source licenses.

❓ Help from the Community

For questions on how to use ng-zorro-antd, please post questions to [

](http://stackoverflow.com/questions/tagged/ng-zorro-antd) using the `ng-zorro-antd` tag. If you're not finding what you need on stackoverflow, you can find us on [![Discord](https://img.shields.io/discord/748677963142135818?label=Discord&style=flat-square)](https://discord.com/channels/748677963142135818/764322550712893451) as well.

As always, we encourage experienced users to help those who are not familiar with ng-zorro-antd!