Skip to content

ConfigProviders 全局化配置

功能描述

ConfigProviders 是一个功能强大的 Naive UI 全局化配置组件,提供了完整的应用级配置能力,包括主题设置、语言配置、全局样式、各种 Provider 配置等特性。它基于 Naive UI 的多个 Provider 组件实现,为 Vue 应用提供了统一的全局配置管理体验。

安装

bash
# 使用 npm
npm install @oiij/naive-ui

# 使用 yarn
yarn add @oiij/naive-ui

# 使用 pnpm
pnpm add @oiij/naive-ui

基本使用

loading

API

Props

NameTypeDefaultDescription
configProviderPropsConfigProviderProps-ConfigProviderProps 配置
loadingBarPropsLoadingBarProviderProps-LoadingBarProviderProps 配置
fullLoadingPropsFullLoadingProps-FullLoadingProps 配置
dialogProviderPropsDialogProviderProps-DialogProviderProps 配置
modalProviderPropsModalProviderProps-ModalProviderProps 配置
notificationProviderPropsNotificationProviderProps-NotificationProviderProps 配置
messageProviderPropsMessageProviderProps-MessageProviderProps 配置

Slots

NameDescription
default默认插槽

类型定义

ts
export type ConfigProvidersProps = {
  globalStyle?: boolean
  configProviderProps?: ConfigProviderProps
  loadingBarProps?: LoadingBarProviderProps
  fullLoadingProps?: FullLoadingProps
  dialogProviderProps?: DialogProviderProps
  modalProviderProps?: ModalProviderProps
  notificationProviderProps?: NotificationProviderProps
  messageProviderProps?: MessageProviderProps
}

export type LoadingIns = {
  start: () => void
  finish: () => void
}

declare global {
  // eslint-disable-next-line ts/consistent-type-definitions
  interface Window {
    $dialog: DialogProviderInst
    $loading: LoadingIns
    $loadingBar: LoadingBarProviderInst
    $message: MessageProviderInst
    $modal: ModalProviderInst
    $notification: NotificationProviderInst
  }
}