1 |
|
2 | [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
|
3 | [![Join the chat at https://gitter.im/primefaces/primeng](https://badges.gitter.im/primefaces/primeng.svg)](https://gitter.im/primefaces/primeng?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
4 | [![npm version](https://badge.fury.io/js/primeng.svg)](https://badge.fury.io/js/primeng)
|
5 | [![Build Status](https://travis-ci.org/primefaces/primeng.svg?branch=master)](https://travis-ci.org/primefaces/primeng)
|
6 |
|
7 | # PrimeNG
|
8 |
|
9 | UI Components for Angular
|
10 |
|
11 | See [PrimeNG homepage](http://www.primefaces.org/primeng) for live showcase and documentation.
|
12 |
|
13 | [![PrimeNG Logo](https://www.primefaces.org/wp-content/uploads/2018/05/primeng-sidebar.svg "PrimeNG")](https://www.primefaces.org/primeng)
|
14 |
|
15 | PrimeNG is a collection of rich UI components for Angular. All widgets are open source and free to use under MIT License. PrimeNG is developed by [PrimeTek Informatics](http://www.primetek.com.tr), a vendor with years of expertise in developing open source UI solutions. For project news and updates, please follow us on [twitter](https://twitter.com/prime_ng) and visit our [blog](https://www.primefaces.org/blog).
|
16 |
|
17 | - **80+ Components:** The most complete set of native widgets featuring 80+
|
18 | easy to use components for all your UI requirements.
|
19 |
|
20 | - **Open Source:** Hosted at GitHub, all widgets are open source and free to use under MIT license. Feel the power of open source.
|
21 |
|
22 | - **Productivity:** Allocate your valuable time on business logic rather than dealing with the complex user interface requirements.
|
23 |
|
24 | - **Themes:** Don't get tied up in just one look&feel. Choose from a variety of options including material and flat design.
|
25 |
|
26 | - **Templates:** Professionally designed highly customizable native Angular CLI application templates to get started in no time.
|
27 |
|
28 | - **Mobile:** Enhanced mobile user experience with touch optimized responsive design elements.
|
29 |
|
30 | ---
|
31 |
|
32 | #### Download
|
33 |
|
34 | PrimeNG is available at NPM, if you have an existing application run the following command to download it to your project.
|
35 |
|
36 | ```
|
37 | npm install primeng --save
|
38 | npm install primeicons --save
|
39 | ```
|
40 |
|
41 | #### Angular CLI Integration
|
42 |
|
43 | Add PrimeNG and PrimeIcons as a dependencies.
|
44 |
|
45 | ```
|
46 | "dependencies": {
|
47 | //...
|
48 | "primeng": "^7.0.0",
|
49 | "primeicons": "^1.0.0"
|
50 | },
|
51 | ```
|
52 |
|
53 | Configure required styles at the styles section, example below uses the Nova Light theme.
|
54 |
|
55 | ```
|
56 | "styles": [
|
57 | "node_modules/primeng/resources/themes/nova-light/theme.css",
|
58 | "node_modules/primeng/resources/primeng.min.css",
|
59 | "node_modules/primeicons/primeicons.css",
|
60 | //...
|
61 | ],
|
62 | ```
|
63 |
|
64 | That is all, you may now import PrimeNG components, for a working example visit the [PrimeNG CLI QuickStart sample](https://github.com/primefaces/primeng-quickstart-cli) at GitHub.
|