仪表盘侧边栏切换

ButtonGitHub
一个用于在移动设备上切换侧边栏的按钮。

用法

DashboardSidebarToggle 组件由 DashboardNavbar 和 DashboardSidebar 组件使用。

它会在移动设备上自动显示以切换侧边栏，您无需手动添加它。

<template>
  <UDashboardSidebarToggle />
</template>

它继承自 Button 组件，因此你可以传递任何属性，例如 color、variant、size 等。

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

示例

在 toggle 插槽内

尽管此组件会在移动设备上自动显示，但您可以使用 DashboardNavbar 和 DashboardSidebar 组件的 toggle 插槽来定制按钮。

<template>
  <UDashboardGroup>
    <UDashboardSidebar>
      <template #toggle>
        <UDashboardSidebarToggle variant="subtle" />
      </template>
    </UDashboardSidebar>

    <slot />
  </UDashboardGroup>
</template>
当使用 DashboardSidebar 和 DashboardNavbar 组件的 toggle-side 属性时，按钮将显示在指定的侧边。

API

属性

属性默认值类型
as

'button'

any

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

side

'left'

"left" | "right"

color

'neutral'

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

variant

'ghost'

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

disabled

boolean

尺寸

'md'

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

ui

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

主题

app.config.ts
export default defineAppConfig({
  ui: {
    dashboardSidebarToggle: {
      base: 'lg:hidden',
      variants: {
        side: {
          left: '',
          right: ''
        }
      }
    }
  }
})
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: {
        dashboardSidebarToggle: {
          base: 'lg:hidden',
          variants: {
            side: {
              left: '',
              right: ''
            }
          }
        }
      }
    })
  ]
})

更新日志

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

DashboardSidebarCollapse

A Button to collapse the sidebar on desktop.

DashboardToolbar

A toolbar to display under the navbar in a dashboard.