配置

PrimeVue 的应用程序小部件配置。

配置由从 primevue/config 导入的 PrimeVue 实例管理。


import PrimeVue from 'primevue/config';
const app = createApp(App);

app.use(PrimeVue, { /* options */ });

样式模式提供基于设计令牌架构的主题。有关详细信息,例如构建自己的主题,请参见 样式模式 文档。


import PrimeVue from 'primevue/config';
import Aura from '@primevue/themes/aura';

const app = createApp(App);

app.use(PrimeVue, {
    theme: {
        preset: Aura,
        options: {
            prefix: 'p',
            darkModeSelector: 'system',
            cssLayer: false
        }
    }
 });

无样式模式指示组件不要添加任何内置样式类,以便可以使用自定义 css 或库(如 Tailwind、Bootstrap 或 PrimeFlex)对其进行样式设置。有关更多信息,请访问 无样式模式 文档。


import { createApp } from "vue";
import PrimeVue from "primevue/config";
const app = createApp(App);

app.use(PrimeVue, { unstyled: true });

定义每个组件类型的共享传递属性。有关更多信息,请访问 传递属性 文档。


import { createApp } from "vue";
import PrimeVue from "primevue/config";
const app = createApp(App);

app.use(PrimeVue, {
    pt: {
        slider: {
            handle: { class: 'bg-primary text-primary-contrast' }
        }
    }
});

用于配置组件的 ptOptions 属性和 usePassThrough 方法。mergeSections 定义是否添加主配置中的部分,而 mergeProps 控制是否覆盖或合并定义的属性。mergeSections 的默认值为 truemergeProps 的默认值为 false


import { createApp } from "vue";
import PrimeVue from "primevue/config";
const app = createApp(App);

app.use(PrimeVue, {
    ptOptions: {
        mergeSections: true,
        mergeProps: false
    }
});

涟漪是支持组件(如按钮)的可选动画。它默认情况下处于禁用状态,需要在应用程序的入口文件(例如 main.js)中,在 PrimeVue 设置期间启用。


import { createApp } from "vue";
import PrimeVue from "primevue/config";
const app = createApp(App);

app.use(PrimeVue, { ripple: true });

输入字段有两种样式,默认值为 outlined,在字段周围带有边框,而 filled 替代方案会在字段中添加背景颜色。将 p-variant-filled 应用于输入的祖先会启用填充样式。如果您希望在整个应用程序中使用填充输入,请使用全局容器(例如文档主体或应用程序元素)来应用样式类。请注意,如果您将其添加到应用程序元素,则被传送到文档主体的组件(如对话框)将无法显示填充输入,因为它们在 DOM 树中不是应用程序根元素的后代,要解决这种情况,请将 inputVariant 设置为 PrimeVue 配置中的 filled


import {createApp} from "vue";
import PrimeVue from "primevue/config";
const app = createApp(App);

app.use(PrimeVue, { inputVariant: "filled" });

ZIndexes 会自动管理,以确保叠加组件的层叠在组合多个组件时能顺利工作。但仍然可能存在您想要配置默认值的情况,例如自定义布局,其中标题部分是固定的。在这种情况下,下拉菜单需要显示在应用程序标题下方,但模态对话框应该显示在上面。PrimeVue 配置提供 zIndex 属性来自定义组件类别的默认值。下面描述了默认值,可以在设置 PrimeVue 时自定义。


import {createApp} from "vue";
import PrimeVue from "primevue/config";
const app = createApp(App);

app.use(PrimeVue, {
    zIndex: {
        modal: 1100,        //dialog, drawer
        overlay: 1000,      //select, popover
        menu: 1000,         //overlay menus
        tooltip: 1100       //tooltip
    }
});

核心动态生成的样式元素要使用的 nonce 值。


app.use(PrimeVue, {
    csp: {
        nonce: '...'
    }
});

use 函数的第二个参数可用于在 PrimeVue 安装期间初始化语言环境。


app.use(PrimeVue, {
    locale: {
        accept: 'Aceptar',
        reject: 'Rechazar',
        //...
    }
});

语言环境配置是反应式的,因此任何更改都会立即反映在 UI 中。假设您正在做一个多语言应用程序,并且需要动态更改语言。


import { defineComponent, onMounted } from "vue";
import { usePrimeVue } from "primevue/config";

export default defineComponent({
    setup() {
        const changeToSpanish = () => {
            const primevue = usePrimeVue();
            primevue.config.locale.accept = "Aceptar";
            primevue.config.locale.reject = "Rechazar";
        }

        onMounted(() => {
            changeToSpanish();
        })
    }
});

社区支持的 PrimeLocale 存储库中提供了可供立即使用的语言环境设置。如果您能使用拉取请求为该存储库做出贡献,并与社区其他成员共享,我们将不胜感激。

配置由从 primevue/config 导入的语言环境 API 管理。

语言环境选项

startsWith以…开头
contains包含
notContains不包含
endsWith以…结尾
equals等于
notEquals不等于
noFilter无过滤器
lt小于
lte小于或等于
gt大于
gte大于或等于
dateIs日期是
dateIsNot日期不是
dateBefore日期在之前
dateAfter日期在之后
clear清除
apply应用
matchAll匹配所有
matchAny匹配任何
addRule添加规则
removeRule删除规则
accept
reject
choose选择
upload上传
cancel取消
completed已完成
pending待定
fileSizeTypes['B', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB']
dayNames['星期日', '星期一', '星期二', '星期三', '星期四', '星期五', '星期六']
dayNamesShort['周日', '周一', '周二', '周三', '周四', '周五', '周六']
dayNamesMin['日', '一', '二', '三', '四', '五', '六']
monthNames['一月', '二月', '三月', '四月', '五月', '六月', '七月', '八月', '九月', '十月', '十一月', '十二月']
monthNamesShort['一月', '二月', '三月', '四月', '五月', '六月', '七月', '八月', '九月', '十月', '十一月', '十二月']
chooseYear选择年份
chooseMonth选择月份
chooseDate选择日期
prevDecade上一个十年
nextDecade下一个十年
prevYear上一年
nextYear下一年
prevMonth上一个月
nextMonth下一个月
prevHour上一个小时
nextHour下一个小时
prevMinute上一分钟
nextMinute下一分钟
prevSecond上一秒
nextSecond下一秒
amam
pmpm
today今天
weekHeader
firstDayOfWeek0
showMonthAfterYearfalse
dateFormatmm/dd/yy
weak
medium中等
strong
passwordPrompt输入密码
searchMessage有 {0} 个结果可用
selectionMessage已选择 {0} 项
emptySelectionMessage未选择任何项目
emptySearchMessage未找到结果
fileChosenMessage{0} 个文件
noFileChosenMessage未选择任何文件
emptyMessage没有可用选项
aria.trueLabel
aria.falseLabel
aria.nullLabel未选择
aria.star1 星
aria.stars{star} 星
aria.selectAll已选择所有项目
aria.unselectAll已取消选择所有项目
aria.close关闭
aria.previous上一个
aria.next下一个
aria.navigation导航
aria.scrollTop滚动到顶部
aria.moveTop移至顶部
aria.moveUp向上移动
aria.moveDown向下移动
aria.moveBottom移至底部
aria.moveToTarget移至目标
aria.moveToSource移至来源
aria.moveAllToTarget全部移至目标
aria.moveAllToSource全部移至来源
aria.pageLabel第 {page} 页
aria.firstPageLabel首页
aria.lastPageLabel尾页
aria.nextPageLabel下一页
aria.prevPageLabel上一页
aria.rowsPerPageLabel每页行数
aria.jumpToPageDropdownLabel跳转到页面下拉菜单
aria.jumpToPageInputLabel跳转到页面输入
aria.selectRow选中行
aria.unselectRow取消选中行
aria.expandRow展开行
aria.collapseRow折叠行
aria.showFilterMenu显示筛选菜单
aria.hideFilterMenu隐藏筛选菜单
aria.filterOperator筛选运算符
aria.filterConstraint筛选条件
aria.editRow编辑行
aria.saveEdit保存编辑
aria.cancelEdit取消编辑
aria.listView列表视图
aria.gridView网格视图
aria.slide幻灯片
aria.slideNumber{slideNumber}
aria.zoomImage缩放图片
aria.zoomIn放大
aria.zoomOut缩小
aria.rotateRight向右旋转
aria.rotateLeft向左旋转