Skip to content

ConfigProvider 全局配置

介绍

用于全局配置 NutUI 组件,提供暗黑模式、动态主题。

深色模式

将 ConfigProvider 组件的 theme 属性设置为 dark,可以开启深色模式。

深色模式会全局生效,使页面上的所有 NutUI 组件变为深色风格。

html
<template>
  <nut-config-provider :theme="theme">
    <nut-cell title="深色模式">
      <template #link>
        <nut-switch v-model="darkMode" @change="onChange"></nut-switch>
      </template>
    </nut-cell>

    <nut-cell title="我是标题" sub-title="副标题描述" desc="描述文字"></nut-cell>
  </nut-config-provider>
</template>
ts
const theme = ref("");
const darkMode = ref(false);

function onChange(value: boolean) {
  theme.value = value ? "dark" : "";
};

主题定制

NutUI 组件可以通过 CSS 变量 来组织样式, 通过覆盖这些 CSS 变量,可以实现定制主题、动态切换主题等功能。

示例

这些变量的默认值被定义在 page 节点上,Web 端被定义在 :root 节点上。

css
:root, page {
  --nut-primary-color: #fa2c19;
  --nut-primary-color-end: #fa6419;
}

通过 CSS 覆盖

你可以直接在代码中覆盖这些 CSS 变量,Button 组件的样式会随之发生改变:

scss
// 添加这段样式后,按钮的 primary 类型会变成绿色
:root, page {
  --nut-button-primary-background-color: green;
}

通过 ConfigProvider 覆盖

ConfigProvider 组件提供了覆盖 CSS 变量的能力,你需要在根节点包裹一个 ConfigProvider 组件,并通过 theme-vars 属性来配置一些主题变量。

html
<template>
  <nut-config-provider :theme-vars="themeVars">
    <nut-form>
      <nut-form-item label="滑块">
        <nut-range v-model="range" hidden-tag></nut-range>
      </nut-form-item>
    </nut-form>
  </nut-config-provider>
</template>
ts
const range = ref(30);

const themeVars = reactive({
  primaryColor: "#008000",
  primaryColorEnd: "#008000"
});

// 当然,你也可以选择使用组件变量去替换,如果同时设置了基础变量和组件变量,组件变量会覆盖基础变量。
// const themeVars = {
//   rangeBgColor: "rgba(25,137,250,0.15)",
//   rangeBarBgColor: "#0289fa",
//   rangeBarBtnBorder: "1px solid #0289fa"
// };

主题变量

基础变量

NutUI 中的 CSS 变量分为 基础变量组件变量。组件变量会继承基础变量,因此在修改基础变量后,会影响所有相关的组件。

修改变量

基础变量中的主色调需要您使用十六进制色值来进行覆盖,请勿使用类似于 redgreen 来进行覆盖。

基础变量和组件变量都能通过 :root, page 选择器和 ConfigProvider 组件修改,对于主色调推荐您使用 ConfigProvider 组件来修改, 因为部分组件的变量激活色的渐变色使用的是 rgba() 实现,使用 :root, page 选择器修改主色调会有部分组件变量不生效。

scss
// 如果您仍旧选择使用 :root 选择器来进行修改主色调,您还需要修改以下 3 个组件变量色 primaryColor 为设置的主色调

:root, page {
  --nut-address-region-tab-line: linear-gradient(90deg, primaryColor 0%, rgba(primaryColor, 0.15) 100%);
  --nut-tabs-horizontal-tab-line-color: linear-gradient(180deg, primaryColor 0%, rgba(primaryColor, 0.15) 100%);
  --nut-tabs-vertical-tab-line-color: linear-gradient(180deg, primaryColor 0%, rgba(primaryColor, 0.15) 100%);
}

变量列表

下面是所有的基础变量:

scss
:root, page {
  // 主色调
  --nut-primary-color: #fa2c19;
  --nut-primary-color-end: #fa6419;
  // 辅助色
  --nut-help-color: #f5f5f5;
  // 标题常规文字
  --nut-title-color: #1a1a1a;
  // 副标题
  --nut-title-color2: #666666;
  // 次内容
  --nut-text-color: #808080;
  // 特殊禁用色
  --nut-disable-color: #cccccc;
  --nut-white: #ffffff;
  --nut-black: #000000;
  --nut-required-color: #fa2c19;
  // 暗黑模式下颜色
  --nut-dark-background: #131313;
  --nut-dark-background2: #1b1b1b;
  --nut-dark-background3: #141414;
  --nut-dark-background4: #323233;
  --nut-dark-background5: #646566;
  --nut-dark-background6: #380e08;
  --nut-dark-background7: #707070;
  --nut-dark-color: var(--nut-white);
  --nut-dark-color2: #f2270c;
  --nut-dark-color3: rgba(232, 230, 227, 0.8);
  --nut-dark-color-gray: var(--nut-text-color);
  --nut-dark-calendar-choose-color: rgba(227, 227, 227, 0.2);
  --nut-dark-calendar-disabled: #646566;
  // 字体
  --nut-font-family: PingFang SC, Microsoft YaHei, Helvetica, Hiragino Sans GB, SimSun, sans-serif;
  // Font
  --nut-font-size-0: 10px;
  --nut-font-size-1: 12px;
  --nut-font-size-2: 14px;
  --nut-font-size-3: 16px;
  --nut-font-size-4: 18px;
  --nut-font-weight-bold: 400;
  --nut-font-size-small: var(--nut-font-size-1);
  --nut-font-size-base: var(--nut-font-size-2);
  --nut-font-size-large: var(--nut-font-size-3);
  --nut-line-height-base: 1.5;
}

API

Props

参数说明类型可选值默认值
theme主题风格stringdark-
theme-vars自定义主题变量object--
z-index 1.7.11设置所有弹窗类组件的 z-index,该属性对全局生效number-2000

MIT Licensed