颜色模式按钮

ButtonGitHub
一个用于在浅色和深色模式之间切换的按钮。

用法

ColorModeButton 组件扩展了 Button 组件，因此你可以传递任何属性，例如 color、variant、size 等。

<template>
  <UColorModeButton />
</template>
按钮默认使用 color="neutral" 和 variant="ghost"。

示例

使用自定义图标

使用 app.config.ts 通过 ui.icons 属性来自定义图标。

app.config.ts
export default defineAppConfig({
  ui: {
    icons: {
      light: 'i-ph-sun',
      dark: 'i-ph-moon'
    }
  }
})

使用 vite.config.ts 通过 ui.icons 属性来自定义图标。

vite.config.ts
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import ui from '@nuxt/ui/vite'

export default defineConfig({
  plugins: [
    vue(),
    ui({
      ui: {
        icons: {
          light: 'i-ph-sun',
          dark: 'i-ph-moon'
        }
      }
    })
  ]
})

带回退插槽

由于按钮被包裹在ClientOnly组件中，你可以传递一个 fallback 插槽，在组件加载时显示一个占位符。

<template>
  <UColorModeButton>
    <template #fallback>
      <UButton loading variant="ghost" color="neutral" />
    </template>
  </UColorModeButton>
</template>

API

属性

属性默认值类型
as

'button'

any

此组件在不是链接时应呈现的元素或组件。

color

'neutral'

"primary" | "secondary" | "success" | "info" | "warning" | "error" | "neutral"

variant

'ghost'

"link" | "ghost" | "solid" | "outline" | "soft" | "subtle"

尺寸

'md'

"md" | "xs" | "sm" | "lg" | "xl"

disabled

boolean

ui

{ base?: ClassNameValue; label?: ClassNameValue; leadingIcon?: ClassNameValue; leadingAvatar?: ClassNameValue; leadingAvatarSize?: ClassNameValue; trailingIcon?: ClassNameValue; }

插槽

插槽类型
回退

{}

更新日志

5cb65— 特性：导入 @nuxt/ui-pro 组件

ColorModeAvatar

一个在亮色和暗色模式下具有不同源的 Avatar。

ColorModeImage

一个在亮色和暗色模式下具有不同源的图像元素。