diff --git a/packages/primevue/README.md b/packages/primevue/README.md index 7adff46c8..30c91ad28 100644 --- a/packages/primevue/README.md +++ b/packages/primevue/README.md @@ -5,98 +5,6 @@ [![PrimeVue Hero](https://www.primefaces.org/static/social/primevue-preview.jpg)](https://primevue.org/) -# PrimeVue +# PrimeVue Website -PrimeVue is a rich set of open source UI Components for Vue. See [PrimeVue homepage](https://primevue.org/) for live showcase and documentation. - -## Download - -PrimeVue is available at [npm](https://www.npmjs.com/package/primevue). - -```bash -# Using npm -npm install primevue - -# Using yarn -yarn add primevue - -# Using pnpm -pnpm add primevue -``` - -## Plugin - -PrimeVue plugin is required to be installed as an application plugin to set up the default [configuration](https://primevue.org/configuration). The plugin is lightweight, only sets up the configuration object without affecting your application. PrimeVue has two styling modes; Styled and Unstyled. If you are just getting started, we suggest to using the styled mode. - -```javascript -import { createApp } from 'vue'; -import PrimeVue from 'primevue/config'; -const app = createApp(App); - -app.use(PrimeVue); -``` - -## Theming - -PrimeVue has two theming has modes; styled or unstyled. - -**Styled Mode** - -Styled mode provides pre-skinned components, default theme is Aura with emerald as the primary color. - -```javascript -import { createApp } from 'vue'; -import PrimeVueStyled from 'primevue/config'; -const app = createApp(App); - -app.use(PrimeVueStyled); -``` - -**Unstyled Mode** - -In unstyled mode, the components do not include any CSS so you'd need to style the components on your end. If you are using Tailwind CSS, visit the [Tailwind Presets](https://tailwind.primevue.org) project to get you started with styling the components with Tailwind utility classes. - -```javascript -import { createApp } from 'vue'; -import PrimeVueUnstyled from 'primevue/config'; -const app = createApp(App); - -app.use(PrimeVueUnstyled); -``` - -## Usage - -Each component can be imported individually so that you only bundle what you use. Import path is available in the documentation of the corresponding component. - -```javascript -import Button from 'primevue/button'; - -const app = createApp(App); -app.component('Button', Button); -``` - -## Prop Cases - -Component prop names are described as camel case throughout the documentation however kebab-case is also fully supported. Events on the other hand should always be kebab-case. - -```vue - - - - - -``` - -## Nuxt Integration - -The [nuxt-primevue](https://www.npmjs.com/package/nuxt-primevue) package is the official module by PrimeTek. See the nuxt documentation for details. [information](https://primevue.org/nuxt) - -## Example - -We've created various samples for the popular options in the Vue ecosystem. Visit the [primevue-examples](https://github.com/primefaces/primevue-examples) repository for the samples. - -## Contributors - - - - +PrimeVue is a rich set of open source UI Components for Vue. Visit the [PrimeVue website](https://primevue.org/) for interactive demos, comprehensive documentation and additional resources.