![](\"https://img.alicdn.com/tfs/TB1TFFaHAvoK1RjSZFwXXciCFXa-106-120.svg\")
\n \n\n \n \n \n
![\"IE](\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png\")
](http://godban.github.io/browsers-support-badges/)IE / Edge | [![\"Firefox\"](\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png\")
](http://godban.github.io/browsers-support-badges/)Firefox | [![\"Chrome\"](\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png\")
](http://godban.github.io/browsers-support-badges/)Chrome | [![\"Safari\"](\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png\")
](http://godban.github.io/browsers-support-badges/)Safari | [![\"Opera\"](\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png\")
](http://godban.github.io/browsers-support-badges/)Opera | [![\"Electron\"](\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/electron/electron_48x48.png\")
](http://godban.github.io/browsers-support-badges/)Electron |\n| --------- | --------- | --------- | --------- | --------- | --------- |\n| IE11, Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions | last 2 versions\n\n\n## 🎨 Design Specification\n\n`ng-zorro-antd` synchronizes design specification with [Ant Design](https://ant.design/docs/spec/introduce) on a regular basis, you can check the [log](https://nz-styles-syncer.now.sh/) online.\n\n\n## 📦 Installation\n\n**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.\n\n```bash\n$ ng new PROJECT_NAME\n$ cd PROJECT_NAME\n$ ng add ng-zorro-antd\n```\n\n> More information about `@angular/cli` [here](https://github.com/angular/angular-cli).\n\nYou can also install `ng-zorro-antd` with npm or yarn\n\n```bash\n$ npm install ng-zorro-antd\n```\n\n## 🔨 Usage\n\nImport the component modules you want to use into your `app.module.ts` file and [feature modules](https://angular.io/guide/feature-modules).\n\n```ts\nimport { NzButtonModule } from 'ng-zorro-antd/button';\n\n@NgModule({\n imports: [ NzButtonModule ]\n})\nexport class AppModule {\n}\n```\n\n> `@angular/cli` users won't have to worry about the things below but it's good to know.\n\nAnd import style and SVG icon assets file link in `angular.json`.\n\n```diff\n{\n \"assets\": [\n+ {\n+ \"glob\": \"**/*\",\n+ \"input\": \"./node_modules/@ant-design/icons-angular/src/inline-svg/\",\n+ \"output\": \"/assets/\"\n+ }\n ],\n \"styles\": [\n+ \"node_modules/ng-zorro-antd/ng-zorro-antd.min.css\"\n ]\n}\n```\n\nSee [Getting Started](https://ng.ant.design/docs/getting-started/en) for more details.\n\n## 🔗 Links\n\n* [ng-zorro-antd-mobile](https://github.com/NG-ZORRO/ng-zorro-antd-mobile)\n* [ng-alain](https://github.com/ng-alain/ng-alain)\n* [Snippet extension for VSCode](https://marketplace.visualstudio.com/items?itemName=cipchk.ng-zorro-vscode)\n\n## ⌨️ Development\n\n```bash\n$ git clone git@github.com:NG-ZORRO/ng-zorro-antd.git\n$ cd ng-zorro-antd\n$ npm install\n$ npm run start\n```\n\nBrowser would open automatically.\n\n## 🤝 Contributing\n\n[](https://github.com/NG-ZORRO/ng-zorro-antd/pulls)\n\nWe welcome all contributions. Please read our [CONTRIBUTING.md](https://github.com/NG-ZORRO/ng-zorro-antd/blob/master/CONTRIBUTING.md) first. You can submit any ideas as [pull requests](https://github.com/NG-ZORRO/ng-zorro-antd/pulls) or as [GitHub issues](https://github.com/NG-ZORRO/ng-zorro-antd/issues).\n\n\n> 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](https://github.com/seajs/seajs/issues/545) and [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html) prior to posting. Well written bug reports help us help you!\n\nThanks to [JetBrains](https://www.jetbrains.com/?from=ng-zorro-antd) for supporting us free open source licenses.\n\n[](https://www.jetbrains.com/?from=ng-zorro-antd)\n\n## ❓ Help from the Community\n\nFor questions on how to use ng-zorro-antd, please post questions to [![\"Stack](\"https://cdn.sstatic.net/Sites/stackoverflow/company/img/logos/so/so-logo.svg?v=2bb144720a66\"){kind=logo}
](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 [](https://gitter.im/ng-zorro/ng-zorro-antd) as well.\n\nAs always, we encourage experienced users to help those who are not familiar with `ng-zorro-antd`!\n\n## 🎉 Users\n\n- [Alibaba](http://www.alibaba.com/)\n- [Aliyun](http://www.aliyun.com/)\n- [ThoughtWorks](https://www.thoughtworks.com/)\n- [Ververica](https://www.ververica.com/)\n- [Apache Flink](https://flink.apache.org/)\n- [Apache Zeppelin](http://zeppelin.apache.org/)\n- [Apache Metron](https://metron.apache.org/)\n- [Process Automation Group](http://pag.company/)\n- [AISINOCO](http://www.aisino.com/)\n- [GongDao](https://www.gongdao.com/)\n- [UC Express](http://www.uce.cn/)\n- [Qingflow](https://qingflow.com/)\n- [DataGrand](http://datagrand.com/)\n- [ScentBird](https://www.scentbird.com/)\n- [Southern Institute of Technology](https://www.sit.ac.nz/)\n- [Hapify (Dynamic boilerplates tool)](https://hub.hapify.io/)\n\n> We list some users here, if your company or product uses NG-ZORRO, let us know [here](https://github.com/NG-ZORRO/ng-zorro-antd/issues/1142)!\n\n","readmeFilename":"README.md"}