vertumnus
/
primevue-mirror
mirror of https://github.com/primefaces/primevue.git
1
0
Fork 0
Code Packages Releases Activity

Update readme

pull/12/head
Onur Senture 2019-05-27 13:32:08 +03:00 committed by GitHub
parent 5127e9b003
commit ed19bc86bd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 76 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

98
README.md
View File

@ -1,34 +1,88 @@
# primevue
## Project setup [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
``` [![npm version](https://badge.fury.io/js/primevue.svg)](https://badge.fury.io/js/primevue)
npm install [![Join the chat at https://gitter.im/primefaces/primevue](https://badges.gitter.im/primefaces/primevue.svg)](https://gitter.im/primefaces/primevue?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
# PrimeVue
![alt text](https://www.primefaces.org/wp-content/uploads/2019/05/primevue-logo.png "PrimeVue")
PrimeVue is available at npm, if you have an existing application run the following commands to download PrimeVue and PrimeIcons to your project.
```js
npm install primevue --save
npm install primeicons --save
``` ```
### Compiles and hot-reloads for development ### Module Loader
This is the recommended way if your application uses [vue-cli](https://cli.vuejs.org/) or has a webpack based build with [vue-loader](https://github.com/vuejs/vue-loader) configured. Import the components as .vue files for seamless integration within your project where path of each component is available at the "import" section of a component documentation.
```js
//import {ComponentName} from 'primevue/{componentname}';
import {Dialog} from 'primevue/dialog';
``` ```
npm run serve In the next step, register the component with the tag name you'd like to use.
```js
Vue.component('Dialog', Dialog);
```
Then you'll be able to utilize the component in your application.
```markup
<Dialog></Dialog>
``` ```
### Compiles and minifies for production ### Script Tag
``` Other alternative is utilizing the components directly within the browser with UMD packages.
npm run build ```markup
<meta charset="utf-8">
<title>calendar demo</title>
<script src="https://unpkg.com/vue"></script>
<script src="https://unpkg.com/primevue/components/calendar/calendar.umd.js"></script>
<div id="app">
<p-calendar></p-calendar>
</div>
<script>
new Vue({
components: {
'p-calendar': calendar
}
}).$mount('#app')
</script>
``` ```
### Run your tests ### Dependencies
``` Majority of PrimeVue components (95%) are native and there are some exceptions having 3rd party dependencies such as Quill for Editor.
npm run test
In addition, components require PrimeIcons library for icons.
```js
dependencies: {
"vue": "^2.6.10",
"primeicons": "^1.0.0"
}
``` ```
### Lints and fixes files Here is the list of components with 3rd party dependencies.
```
npm run lint Component | Dependency
--- | ---
Charts | Charts.js 2.1.x+
Editor | Quill.js 1.3.3+
FullCalendar | FullCalendar 4.0.2+
PrimeFlex | DataView
### Styles
The css dependencies are as follows, note that you may change the theme with another one of your choice. If you are using a bundler such as webpack with a css loader you may import them to your main application component.
```javascript
primevue/resources/themes/nova-light/theme.css //theme
primevue/resources/primevue.min.css //shared css
primeicons/primeicons.css //icons
``` ```
### Run your unit tests ### Quickstart
``` An example application based on vue-cli is available at [github](https://github.com/primefaces/primevue-quickstart).
npm run test:unit
```
### Customize configuration
See [Configuration Reference](https://cli.vuejs.org/config/).