ConfigProvider (настройка)

Глобальная конфигурация дочерних компонентов через provide/inject: единое управление темой, размером и интернационализацией.

Базовое использование

Базовое использование

Размер по умолчанию:

Маленький размер:

<script setup lang="ts">
import { LhConfigProvider, LhButton } from '@lh-ui/vue3'
</script>

<template>
  <!-- Размер по умолчанию -->
  <LhButton>Обычная кнопка</LhButton>
  <!-- Основная (отключена) -->
  <LhButton type="primary" disabled>Основная</LhButton>
  <!-- Маленький размер -->
  <LhConfigProvider :size="'small'">
    <!-- Маленькая кнопка -->
    <LhButton>Маленькая кнопка</LhButton>
    <!-- Маленькая основная -->
    <LhButton type="primary">Маленькая основная</LhButton>
  </LhConfigProvider>
</template>

<script>
import { LhConfigProvider, LhButton } from '@lh-ui/vue3'

export default {
  components: { LhConfigProvider, LhButton },
}
</script>

<template>
  <!-- Размер по умолчанию -->
  <LhButton>Обычная кнопка</LhButton>
  <!-- Основная (отключена) -->
  <LhButton type="primary" disabled>Основная</LhButton>
  <!-- Маленький размер -->
  <LhConfigProvider :size="'small'">
    <!-- Маленькая кнопка -->
    <LhButton>Маленькая кнопка</LhButton>
    <!-- Маленькая основная -->
    <LhButton type="primary">Маленькая основная</LhButton>
  </LhConfigProvider>
</template>

Пользовательские фирменные цвета

Пользовательские фирменные цвета

<script setup lang="ts">
import { LhConfigProvider, LhButton } from '@lh-ui/vue3'
</script>

<template>
  <LhConfigProvider :theme-vars="{ 'primary-color': '#e6a23c' }">
    <LhButton>По умолчанию</LhButton>
    <LhButton type="primary">Золотая тема</LhButton>
  </LhConfigProvider>
</template>

<script>
import { LhConfigProvider, LhButton } from '@lh-ui/vue3'

export default {
  components: { LhConfigProvider, LhButton },
}
</script>

<template>
  <LhConfigProvider :theme-vars="{ 'primary-color': '#e6a23c' }">
    <LhButton>По умолчанию</LhButton>
    <LhButton type="primary">Золотая тема</LhButton>
  </LhConfigProvider>
</template>

Тема по компонентам (componentTheme)

Через componentTheme можно отдельно переопределять переменные темы для указанного компонента; приоритет выше, чем у глобального themeVars.

Настройка по компонентам

<script setup lang="ts">
import { LhConfigProvider, LhButton } from '@lh-ui/vue3'
</script>

<template>
  <LhConfigProvider
    :component-theme="{ button: { 'primary-color': '#e6a23c' } }"
  >
    <!-- Button, золотая тема -->
    <LhButton type="primary">Button, золотая тема</LhButton>
    <!-- Success не затрагивается -->
    <LhButton type="success">Success не затрагивается</LhButton>
  </LhConfigProvider>
</template>

<script>
import { LhConfigProvider, LhButton } from '@lh-ui/vue3'

export default {
  components: { LhConfigProvider, LhButton },
}
</script>

<template>
  <LhConfigProvider
    :component-theme="{ button: { 'primary-color': '#e6a23c' } }"
  >
    <!-- Button, золотая тема -->
    <LhButton type="primary">Button, золотая тема</LhButton>
    <!-- Success не затрагивается -->
    <LhButton type="success">Success не затрагивается</LhButton>
  </LhConfigProvider>
</template>

Белый список фоновых узоров (patternComponents)

Через patternComponents указывается, какие компоненты поддерживают эффект фонового узора.

Белый список узоров

<script setup lang="ts">
import { LhConfigProvider, LhButton } from '@lh-ui/vue3'
</script>

<template>
  <LhConfigProvider :pattern-components="['button']">
    <LhButton bg-pattern="var(--lh-pattern-willow)">Узор ивы</LhButton>
    <LhButton bg-pattern="var(--lh-pattern-cloud)">Узор благих облаков</LhButton>
  </LhConfigProvider>
</template>

<script>
import { LhConfigProvider, LhButton } from '@lh-ui/vue3'

export default {
  components: { LhConfigProvider, LhButton },
}
</script>

<template>
  <LhConfigProvider :pattern-components="['button']">
    <LhButton bg-pattern="var(--lh-pattern-willow)">Узор ивы</LhButton>
    <LhButton bg-pattern="var(--lh-pattern-cloud)">Узор благих облаков</LhButton>
  </LhConfigProvider>
</template>

Значение bg-pattern — это CSS-переменная (например var(--lh-pattern-willow)) или URL изображения; само имя узора (например willow) не сработает. Названия остальных узоров — в разделе Кастомизация узоров.

Интернационализация

Глобальный языковой пакет настраивается через locale.

Переключение языка

<script setup lang="ts">
import { ref, computed } from 'vue'
import { LhConfigProvider, LhButton, zhCN, enUS } from '@lh-ui/vue3'

const locale = ref('zh-CN')
const currentLocale = computed(() => locale.value === 'zh-CN' ? zhCN : enUS)
function toggleLocale() {
  locale.value = locale.value === 'zh-CN' ? 'en-US' : 'zh-CN'
}
</script>

<template>
  <LhConfigProvider :locale="currentLocale">
    <LhButton @click="toggleLocale">
      {{ locale === 'zh-CN' ? 'Switch to English' : '切换中文' }}
    </LhButton>
  </LhConfigProvider>
</template>

<script>
import { LhConfigProvider, LhButton, zhCN, enUS } from '@lh-ui/vue3'

export default {
  components: { LhConfigProvider, LhButton },
  data() {
    return { locale: 'zh-CN' }
  },
  computed: {
    currentLocale() {
      return this.locale === 'zh-CN' ? zhCN : enUS
    },
  },
  methods: {
    toggleLocale() {
      this.locale = this.locale === 'zh-CN' ? 'en-US' : 'zh-CN'
    },
  },
}
</script>

<template>
  <LhConfigProvider :locale="currentLocale">
    <LhButton @click="toggleLocale">
      {{ locale === 'zh-CN' ? 'Switch to English' : '切换中文' }}
    </LhButton>
  </LhConfigProvider>
</template>

ConfigProvider API

Props

Свойство	Описание	Тип	По умолчанию
size	Глобальный размер	LhSizes	—
locale	Настройка интернационализации	LocaleType	—
themeVars	Глобальные переменные темы	{ [x: string]: string; }	—
patternComponents	Белый список фоновых узоров	[LhThemeableComponent](#type-LhThemeableComponent)[]	—
componentTheme	Переменные темы по именам компонентов	{ button?: Record<string, string>; input?: Record<string, string>; dialog?: Record<string, string>; tooltip?: Record<string, string>; icon?: Record<string, string>; card?: Record<string, string>; alert?: Record<string, string>; popover?: Record<string, string>; popconfirm?: Record<string, string>; drawer?: Record<string, string>; dropdown?: Record<string, string>; message?: Record<string, string>; notification?: Record<string, string>; loading?: Record<string, string>; timeline?: Record<string, string>; collapse?: Record<string, string>; rate?: Record<string, string>; segmented?: Record<string, string>; calendar?: Record<string, string>; affix?: Record<string, string>; backtop?: Record<string, string>; image?: Record<string, string>; menu?: Record<string, string>; table?: Record<string, string>; layout?: Record<string, string>; tree?: Record<string, string>; transfer?: Record<string, string>; upload?: Record<string, string>; anchor?: Record<string, string>; steps?: Record<string, string>; }	—

Slots

Слот	Описание
default	Содержимое компонентов, к которым применяется настройка

Типы

TypeScript-типы, экспортируемые этим компонентом (извлечены автоматически из packages/components/config-provider/src/types.ts и исходников @lh-ui/share/core/*; раскройте нужный пункт, чтобы увидеть полное определение; описания свойств — в таблице Props выше):

LhThemeableComponent

/**
 * Множество имён компонентов, поддерживающих настройку темы
 */
export type LhThemeableComponent =
  | 'button'
  | 'input'
  | 'dialog'
  | 'tooltip'
  | 'icon'
  | 'card'
  | 'alert'
  | 'popover'
  | 'popconfirm'
  | 'drawer'
  | 'dropdown'
  | 'message'
  | 'notification'
  | 'loading'
  | 'timeline'
  | 'collapse'
  | 'rate'
  | 'segmented'
  | 'calendar'
  | 'affix'
  | 'backtop'
  | 'image'
  | 'menu'
  | 'table'
  | 'layout'
  | 'tree'
  | 'transfer'
  | 'upload'
  | 'anchor'
  | 'steps'

LhConfigProviderProps

/**
 * Настройки ConfigProvider
 */
export interface LhConfigProviderProps {
  /** Глобальный размер */
  size?: LhSizes
  /** Глобальный язык */
  locale?: LocaleType
  /** Глобальные переменные темы
   * Поддерживаемые ключи (префикс --lh- добавляется автоматически):
   * - `primary-color`, `success-color`, `warning-color`, `danger-color`, `info-color`
   * - `gold-color`, `vermilion-color`, `jade-color`
   * - `bg-color`, `text-color`, `border-color`
   * - `bg-pattern` — URL фонового узора (например `var(--lh-pattern-willow)`)
   * - `bg-pattern-opacity` — прозрачность узора
   * - `bg-pattern-color` — цвет узора
   * - `decoration-color` — декоративный цвет */
  themeVars?: Record<string, string>
  /** Белый список компонентов с включённым фоновым узором
   * - фоновый узор применяется только для компонентов из белого списка через глобальный `themeVars` (bg-pattern)
   * - пустой массив или undefined означают, что фоновый узор отключён для всех компонентов
   * - узоры, переданные самим компонентом через `bgPattern` или `themeVars`, этому ограничению не подчиняются
   */
  patternComponents?: LhThemeableComponent[]
  /** Переменные темы по отдельным компонентам (переопределяют глобальный themeVars)
   * Ключ — имя компонента, значение — объект переменных темы этого компонента
   * Приоритет: собственные props компонента > componentTheme[имя компонента] > глобальный themeVars
   */
  componentTheme?: Partial<Record<LhThemeableComponent, Record<string, string>>>
}