Core utilities and base functionality for PrimeVue UI component library
52
Quality
Pending
Does it follow best practices?
Impact
52%
1.15xAverage score across 10 eval scenarios
PrimeVue configuration plugin providing theme management, localization, global settings, and application setup. This is the core plugin that enables PrimeVue functionality across Vue applications.
Main Vue plugin for configuring PrimeVue across the application.
declare const PrimeVue: {
/**
* Install PrimeVue plugin with configuration options
* @param app - Vue application instance
* @param options - Configuration options
*/
install(app: any, options?: PrimeVueConfiguration): void;
};
interface PrimeVueConfiguration {
/** Enable ripple effect on components */
ripple?: boolean;
/** @deprecated Use inputVariant instead */
inputStyle?: 'filled' | 'outlined' | undefined;
/** Input component styling variant */
inputVariant?: 'filled' | 'outlined' | undefined;
/** Localization options */
locale?: PrimeVueLocaleOptions;
/** Filter match mode options */
filterMatchModeOptions?: any;
/** Z-index configuration for overlays */
zIndex?: PrimeVueZIndexOptions;
/** Theme configuration */
theme?: any;
/** Enable unstyled mode */
unstyled?: boolean;
/** PassThrough configuration */
pt?: any;
/** PassThrough options */
ptOptions?: any;
/** Content Security Policy options */
csp?: PrimeVueCSPOptions;
}
declare const defaultOptions: PrimeVueConfiguration;Usage Examples:
import { createApp } from 'vue';
import PrimeVue from '@primevue/core/config';
import App from './App.vue';
const app = createApp(App);
// Basic setup
app.use(PrimeVue);
// With configuration
app.use(PrimeVue, {
theme: 'aura-light-green',
ripple: true,
locale: {
accept: 'Yes',
reject: 'No',
// ... more locale options
},
zIndex: {
modal: 1100,
overlay: 1000,
menu: 1000,
tooltip: 1100
}
});Vue composable for accessing PrimeVue configuration within components.
/**
* Access PrimeVue configuration from within Vue components
* @returns PrimeVue instance with configuration
* @throws Error if PrimeVue is not installed
*/
declare function usePrimeVue(): {
config: PrimeVueConfiguration;
};Usage Examples:
import { usePrimeVue } from '@primevue/core/config';
// In a Vue component
export default {
setup() {
const primevue = usePrimeVue();
// Access configuration
const isRippleEnabled = primevue.config.ripple;
const currentTheme = primevue.config.theme;
return { isRippleEnabled, currentTheme };
}
};Low-level functions for PrimeVue setup and configuration management.
/**
* Setup PrimeVue with configuration
* @param app - Vue application instance
* @param options - Configuration options
* @returns PrimeVue instance
*/
declare function setup(app: any, options: PrimeVueConfiguration): any;
/**
* Clear PrimeVue configuration and theme watchers
*/
declare function clearConfig(): void;
/**
* Setup configuration watchers and theme management
* @param app - Vue application instance
* @param PrimeVue - PrimeVue instance
*/
declare function setupConfig(app: any, PrimeVue: any): void;interface PrimeVueZIndexOptions {
/** Z-index for modal overlays */
modal?: number;
/** Z-index for general overlays */
overlay?: number;
/** Z-index for menu components */
menu?: number;
/** Z-index for tooltip components */
tooltip?: number;
}interface PrimeVueCSPOptions {
/** Nonce value for Content Security Policy */
nonce?: string;
}interface PrimeVueLocaleOptions {
// Filter labels
startsWith?: string;
contains?: string;
notContains?: string;
endsWith?: string;
equals?: string;
notEquals?: string;
noFilter?: string;
lt?: string;
lte?: string;
gt?: string;
gte?: string;
dateIs?: string;
dateIsNot?: string;
dateBefore?: string;
dateAfter?: string;
clear?: string;
apply?: string;
matchAll?: string;
matchAny?: string;
addRule?: string;
removeRule?: string;
// Common actions
accept?: string;
reject?: string;
choose?: string;
upload?: string;
cancel?: string;
completed?: string;
pending?: string;
// File handling
fileSizeTypes: string[];
fileChosenMessage?: string;
noFileChosenMessage?: string;
// Date/Time
dayNames: string[];
dayNamesShort: string[];
dayNamesMin: string[];
monthNames: string[];
monthNamesShort: string[];
chooseYear?: string;
chooseMonth?: string;
chooseDate?: string;
prevDecade?: string;
nextDecade?: string;
prevYear?: string;
nextYear?: string;
prevMonth?: string;
nextMonth?: string;
prevHour?: string;
nextHour?: string;
prevMinute?: string;
nextMinute?: string;
prevSecond?: string;
nextSecond?: string;
am?: string;
pm?: string;
today?: string;
weekHeader?: string;
firstDayOfWeek?: number;
showMonthAfterYear?: boolean;
dateFormat?: string;
// Password strength
weak?: string;
medium?: string;
strong?: string;
passwordPrompt?: string;
// Messages
emptyFilterMessage?: string;
searchMessage?: string;
selectionMessage?: string;
emptySelectionMessage?: string;
emptySearchMessage?: string;
emptyMessage?: string;
// Accessibility
aria?: PrimeVueLocaleAriaOptions;
}
interface PrimeVueLocaleAriaOptions {
trueLabel?: string;
falseLabel?: string;
nullLabel?: string;
star?: string;
stars?: string;
selectAll?: string;
unselectAll?: string;
close?: string;
previous?: string;
next?: string;
navigation?: string;
scrollTop?: string;
moveUp?: string;
moveTop?: string;
moveDown?: string;
moveBottom?: string;
moveToTarget?: string;
moveToSource?: string;
moveAllToTarget?: string;
moveAllToSource?: string;
pageLabel?: string;
firstPageLabel?: string;
lastPageLabel?: string;
nextPageLabel?: string;
prevPageLabel?: string;
rowsPerPageLabel?: string;
jumpToPageDropdownLabel?: string;
jumpToPageInputLabel?: string;
selectRow?: string;
unselectRow?: string;
expandRow?: string;
collapseRow?: string;
showFilterMenu?: string;
hideFilterMenu?: string;
filterOperator?: string;
filterConstraint?: string;
editRow?: string;
saveEdit?: string;
cancelEdit?: string;
listView?: string;
gridView?: string;
slide?: string;
slideNumber?: string;
zoomImage?: string;
zoomIn?: string;
zoomOut?: string;
rotateRight?: string;
rotateLeft?: string;
listLabel?: string;
}PrimeVue extends Vue's global properties and component system:
declare module 'vue' {
interface ComponentCustomProperties {
$primevue: {
config: PrimeVueConfiguration;
};
}
}// Main plugin import
import PrimeVue from '@primevue/core/config';
// Named imports
import { usePrimeVue, setup, defaultOptions } from '@primevue/core/config';
// From main package
import { usePrimeVue } from '@primevue/core';Install with Tessl CLI
npx tessl i tessl/npm-primevue--coreevals
scenario-1
scenario-2
scenario-3
scenario-4
scenario-5
scenario-6
scenario-7
scenario-8
scenario-9
scenario-10