Go to file
Cagatay Civici 6dc91b26cd Fixed color issue in hover 2024-05-30 11:57:44 +03:00
.github Update bug_report.yml 2024-01-31 12:59:40 +03:00
.vscode Refactor settings.json 2024-05-21 14:14:34 +01:00
api-generator Refactor #5785 2024-05-27 12:24:31 +03:00
assets Fixed templates text visuals 2024-05-30 02:00:38 +03:00
components Better border radius for nested items of Nora and Lara 2024-05-30 11:51:01 +03:00
directives Move to directives folder 2023-10-15 17:04:58 +03:00
doc Fixed color issue in hover 2024-05-30 11:57:44 +03:00
layouts Lift the state up 2024-05-26 03:28:48 +03:00
middleware landing scroll top fix 2022-12-28 12:32:27 +03:00
modules/nuxt-primevue Fixed #5769 - Add OverlayBadge component, deprecate Badge directive 2024-05-22 11:06:17 +03:00
pages Migrated shrink and grow 2024-05-30 02:48:15 +03:00
plugins Remove comments 2024-05-27 10:20:40 +03:00
public Merge branch 'master' into v4 2024-04-01 01:39:50 +03:00
server/api FileUpload upload file Nuxt updates 2023-10-23 17:23:28 +03:00
service Deferred context added 2024-02-21 10:31:43 +03:00
themes More contrast for Noir states 2024-05-25 23:55:27 +03:00
.editorconfig Fixed #4530 - Export styles of all components 2023-10-02 11:46:09 +01:00
.eslintrc.js Refactor #3965, Improve build and Added *Base models 2023-07-03 23:20:35 +01:00
.gitignore Refactor settings.json 2024-05-21 14:14:34 +01:00
.prettierignore prettier warnings fixed 2022-12-20 15:32:32 +03:00
.prettierrc.json Lint changes 2022-09-14 17:26:41 +03:00
CHANGELOG.md Set new version 2024-05-15 15:04:07 +03:00
LICENSE.md Update year 2024-02-23 16:41:53 +03:00
README.md Update readme 2024-04-02 13:38:09 +03:00
app.vue Revert "Error page dark mode change fixes" 2024-05-24 11:17:58 +03:00
build-meta.js Theming API: Change package build 2024-03-27 13:13:15 +00:00
error-backup.vue Add backup file 2024-05-24 11:16:21 +03:00
error.vue Update error page 2024-05-27 10:12:51 +03:00
nuxt-vite.config.js Visual updates for OverlayBadge 2024-05-25 14:57:35 +03:00
nuxt.config.js Format fixes 2024-05-22 16:52:56 +03:00
package-lock.json Bumped our plugin 2024-05-24 19:14:09 +03:00
package.json Move migration to guides 2024-05-27 14:15:29 +03:00
rollup.config.js Refactor #5774 2024-05-24 15:00:32 +01:00
tailwind.config.js Fixed DataView loading demo, aligned breakpoints 2024-05-24 09:45:57 +03:00
tsconfig.json Fixed #4530 - Export styles of all components 2023-10-02 11:46:09 +01:00
vitest.config.js Renamed alias file 2023-10-24 15:12:26 +03:00

README.md

License: MIT npm version Discord Chat Prime Discussions

PrimeVue Hero

PrimeVue

PrimeVue is a rich set of open source UI Components for Vue. See PrimeVue homepage for live showcase and documentation.

Download

PrimeVue is available at npm.

# 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. 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.

Styled Mode

Styled mode provides pre-skinned components, default theme is Aura with emerald as the primary color.

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 project to get you started with styling the components with Tailwind utility classes.

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.

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.

<Dialog :showHeader="false"></Dialog>

<!-- can be written as -->

<Dialog :show-header="false"></Dialog>

Nuxt Integration

The nuxt-primevue package is the official module by PrimeTek. See the nuxt documentation for details. information

Example

We've created various samples for the popular options in the Vue ecosystem. Visit the primevue-examples repository for the samples.

Contributors