An enterprise-class UI components based on Ant Design and Angular 7. ๐Ÿœ
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github doc: move back some md file (#972) Jan 26, 2018
components fix(module:radio): fix radio ContentChildren error (#2660) Dec 19, 2018
docs release(7.0.0-rc.1): release 7.0.0-rc.1 (#2623) Dec 12, 2018
integration build: bump webpack integration (#2524) Nov 30, 2018
schematics fix(schematics): compatible with old version options (#2622) Dec 12, 2018
scripts release(7.0.0-rc.1): release 7.0.0-rc.1 (#2623) Dec 12, 2018
.editorconfig feat(publish): add publish script (#1979) Sep 7, 2018
.gitignore refactor(schematics): refactor schematics (#2602) Dec 11, 2018
.nvmrc ci: specify node version, doc: a minor fix for IE 11 on windows 7 (#2284 Oct 18, 2018
.travis.yml feat(module:icon): switch to SVG icons (#2171) Oct 8, 2018
CHANGELOG.md release(7.0.0-rc.1): release 7.0.0-rc.1 (#2623) Dec 12, 2018
CODE_OF_CONDUCT.md doc: move back some md file (#972) Jan 26, 2018
CONTRIBUTING.md doc: move back some md file (#972) Jan 26, 2018
LICENSE fix(module:button): fix button loading bug (#2251) Oct 10, 2018
README-zh_CN.md release(7.0.0-rc.0): release 7.0.0-rc.0 (#2565) Nov 30, 2018
README.md docs(readme): fix typo (#2580) Dec 4, 2018
angular.json refactor(module:icon): switch dependency to support tree shake (#2266) Oct 16, 2018
logo.svg refactor(module:checkbox): support checkbox onPush (#2478) Nov 19, 2018
package.json refactor(schematics): refactor schematics (#2602) Dec 11, 2018
rollup.config.js refactor(ng:6.0): support angular 6.0 (#1404) May 31, 2018
setup-shared-libs.sh ci: move integration test back (#1139) Mar 14, 2018
tsconfig-build.json wip(build:package): move package tools back (#1128) Mar 14, 2018
tsconfig.json build: use ng-packagr to generate library (#2126) Sep 18, 2018
tslint.json refactor(module:all): support Angular 7.0 (#2372) Oct 29, 2018

README.md

NG-ZORRO

An enterprise-class UI components based on Ant Design and Angular.

Travis branch Codecov Dependencies GitHub Release Date npm package NPM downloads GitHub license Gitter extension-for-VSCode

English | ็ฎ€ไฝ“ไธญๆ–‡

โœจ Features

  • An enterprise-class UI design system for web applications.
  • A set of 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.

๐Ÿ–ฅ Environment Support

IE / Edge
IE / Edge
Firefox
Firefox
Chrome
Chrome
Safari
Safari
Opera
Opera
Electron
Electron
IE11, Edge last 2 versions last 2 versions last 2 versions last 2 versions last 2 versions

Listing @angular/cdk as its dependency, ng-zorro-antd supports the most recent two versions of all major browsers.

๐ŸŽจ 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.

$ ng new PROJECT_NAME
$ cd PROJECT_NAME
$ ng add ng-zorro-antd --i18n=en_US

More information about @angular/cli here.

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

$ npm install ng-zorro-antd

๐Ÿ”จ Usage

Import the module into every module where you want to use the components.

import { NgZorroAntdModule } from 'ng-zorro-antd';

@NgModule({
  imports: [ NgZorroAntdModule ]
})
export class AppModule {
}

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

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

{
  "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

โŒจ๏ธ Development

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

Browser would open automatically.

๐Ÿ—บ Road Map

Check this issue to read our plans for later 2018.

๐Ÿค Contributing

PRs Welcome

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 (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!

โ“ Help from the Community

For questions on how to use ng-zorro-antd, please post questions to Stack Overflow using the ng-zorro tag. If you're not finding what you need on stackoverflow, you can find us on Gitter as well.

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

๐ŸŽ‰ Users

If your company or product uses NG-ZORRO, let us know here!

โ˜€๏ธ License

MIT