仪表盘侧边栏折叠

ButtonGitHub
一个用于在桌面端折叠侧边栏的按钮。

用法

DashboardSidebar 组件的 collapsible 属性被设置时,DashboardSidebarCollapse 组件用于折叠/展开 DashboardSidebar 组件。

<template>
  <UDashboardSidebarCollapse />
</template>

它继承自 Button 组件,因此你可以传递任何属性,例如 colorvariantsize 等。

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

示例

header 插槽中

你可以将此组件放置在 DashboardSidebar 组件的 header 插槽中,并使用 collapsed 属性来隐藏标题的左侧部分,例如。

layouts/dashboard.vue
<template>
  <UDashboardGroup>
    <UDashboardSidebar collapsible>
      <template #header="{ collapsed }">
        <Logo v-if="!collapsed" />

        <UDashboardSidebarCollapse variant="subtle" />
      </template>
    </UDashboardSidebar>

    <slot />
  </UDashboardGroup>
</template>

leading 插槽中

你可以将此组件放置在 DashboardNavbar 组件的 leading 插槽中,例如在标题之前显示它。

pages/index.vue
<script setup lang="ts">
definePageMeta({
  layout: 'dashboard'
})
</script>

<template>
  <UDashboardPanel>
    <template #header>
      <UDashboardNavbar title="Home">
        <template #leading>
          <UDashboardSidebarCollapse variant="subtle" />
        </template>
      </UDashboardNavbar>
    </template>
  </UDashboardPanel>
</template>

API

属性

属性默认值类型
as'button'any

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

color'neutral'"错误" | "中性" | "主要" | "次要" | "成功" | "信息" | "警告"
variant'ghost'"link" | "ghost" | "solid" | "outline" | "soft" | "subtle"
side'left'"left" | "right"

要折叠的侧边栏的侧边。

autofocusfalse | true | "true" | "false"
disabledboolean
namestring
type'button'"reset" | "submit" | "button"

当不是链接时,按钮的类型。

labelstring
activeColor"错误" | "中性" | "主要" | "次要" | "成功" | "信息" | "警告"
activeVariant"link" | "ghost" | "solid" | "outline" | "soft" | "subtle"
尺寸'md'"xs" | "sm" | "md" | "lg" | "xl"
正方形boolean

以四边等距内边距渲染按钮。

blockboolean

渲染全宽按钮。

loadingAutoboolean

根据 @click promise 状态自动设置加载状态

图标any

根据 leadingtrailing 属性显示图标。

avatarAvatarProps

在左侧显示头像。

前置boolean

当为 true 时,图标将显示在左侧。

leadingIconany

在左侧显示图标。

尾部boolean

当为 true 时,图标将显示在右侧。

trailingIconany

在右侧显示图标。

loadingboolean

当为 true 时,将显示加载图标。

loadingIconappConfig.ui.icons.loadingany

loading prop 为 true 时显示的图标。

ui{ base?: ClassNameValue; label?: ClassNameValue; leadingIcon?: ClassNameValue; leadingAvatar?: ClassNameValue; leadingAvatarSize?: ClassNameValue; trailingIcon?: ClassNameValue; }
此组件还支持所有原生 <button> HTML 属性。

主题

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

更新日志

184ea— chore: 减少类型冗余,通过省略操作按钮中的链接属性

5b177— feat: 扩展原生 HTML 属性 (#5348)

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