DashboardSeitenbarToggle

Ein Button zum Umschalten der Seitenleiste auf dem Handy.

Bearbeiten

Die Komponente DashboardSidebarToggle wird von den Komponenten DashboardNavbar und DashboardSidebar verwendet.

Es wird automatisch auf dem Handy angezeigt, um die Sidebar umzuschalten, **Sie müssen es nicht manuell hinzufügen **.

<template>
  <UDashboardSidebarToggle />
</template>

Es erweitert die Button-Komponente, sodass Sie jede Eigenschaft wie color, variant, size usw. übergeben können.

<template>
  <UDashboardSidebarToggle variant="subtle" />
</template>

Die Standardeinstellungen sind color="neutral" und variant="ghost".

Examples Bearbeiten

Innerhalb des `toggle` Steckplatzes

Auch wenn diese Komponente automatisch auf dem Handy angezeigt wird, können Sie den toggle-Steckplatz der Komponenten DashboardNavbar und DashboardSidebar verwenden, um die Schaltfläche anzupassen.

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

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

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

<template>
  <UDashboardPanel>
    <template #header>
      <UDashboardNavbar title="Home">
        <template #toggle>
          <UDashboardSidebarToggle variant="subtle" />
        </template>
      </UDashboardNavbar>
    </template>
  </UDashboardPanel>
</template>

Bei Verwendung der toggle-side-Prop der Komponenten DashboardSidebar und DashboardNavbar wird die Schaltfläche auf der angegebenen Seite angezeigt.

API (englisch)

Props Bearbeiten

Prop	Default	Type
`as`	`'button'`	`any` The element or component this component should render as when not a link.
`color`	`'neutral'`	`"error" \| "neutral" \| "primary" \| "secondary" \| "success" \| "info" \| "warning"`
`variant`	`'ghost'`	`"ghost" \| "solid" \| "outline" \| "soft" \| "subtle" \| "link"`
`side`	`'left'`	`"left" \| "right"` The side of the sidebar to toggle.
`autofocus`		`false \| true \| "true" \| "false"`
`disabled`		`boolean`
`name`		`string`
`type`	`'button'`	`"reset" \| "submit" \| "button"` The type of the button when not a link.
`label`		`string`
`activeColor`		`"error" \| "neutral" \| "primary" \| "secondary" \| "success" \| "info" \| "warning"`
`activeVariant`		`"ghost" \| "solid" \| "outline" \| "soft" \| "subtle" \| "link"`
`size`	`'md'`	`"xs" \| "sm" \| "md" \| "lg" \| "xl"`
`square`		`boolean` Render the button with equal padding on all sides.
`block`		`boolean` Render the button full width.
`loadingAuto`		`boolean` Set loading state automatically based on the `@click` promise state
`icon`		`any` Display an icon based on the `leading` and `trailing` props.
`avatar`		`AvatarProps` Display an avatar on the left side.
`leading`		`boolean` When `true`, the icon will be displayed on the left side.
`leadingIcon`		`any` Display an icon on the left side.
`trailing`		`boolean` When `true`, the icon will be displayed on the right side.
`trailingIcon`		`any` Display an icon on the right side.
`loading`		`boolean` When `true`, the loading icon will be displayed.
`loadingIcon`	`appConfig.ui.icons.loading`	`any` The icon when the `loading` prop is `true`.
`ui`		`{ base?: any; }`

Diese Komponente unterstützt auch alle nativen <button> HTML-Attribute.

Theme Bearbeiten

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: ''
            }
          }
        }
      }
    })
  ]
})

Changelog (englisch)

No recent changes

DashboardSidebarCollapse

A Button to collapse the sidebar on desktop.

DashboardToolbar

A toolbar to display under the navbar in a dashboard.