仪表盘搜索按钮

ButtonGitHub
一个预设样式的按钮，用于打开仪表盘搜索模态框。

用法

DashboardSearchButton 组件用于打开 DashboardSearch 模态框。

<template>
  <UDashboardSearchButton />
</template>

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

<template>
  <UDashboardSearchButton variant="subtle" />
</template>
按钮在未折叠时默认为 color="neutral" 和 variant="outline"，折叠时为 variant="ghost"。

折叠

使用 collapsed 属性来隐藏按钮的标签，并键盘按键默认为 false。

<template>
  <UDashboardSearchButton collapsed />
</template>
当在 DashboardSidebar 组件中使用此按钮时，请直接使用 collapsed 插槽属性。

键盘按键

使用 kbds 属性在按钮中显示键盘按键。默认值为 ['meta', 'K']，以匹配 DashboardSearch 组件的默认快捷键。

<template>
  <UDashboardSearchButton :kbds="['alt', 'O']" />
</template>

API

属性

属性默认值类型
图标

appConfig.ui.icons.search

字符串 | 对象

按钮中显示的图标。

label

t('dashboardSearchButton.label')

string

按钮中显示的标签。

color

'neutral'

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

按钮的颜色。

variant

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

按钮的样式。未折叠时默认为 'outline'，折叠时默认为 'ghost'。

尺寸

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

collapsed

false

boolean

按钮是否折叠。

tooltip

false

boolean | TooltipProps

当按钮折叠时，显示一个带有按钮标签的工具提示。这优先于全局的 tooltip 属性。

键盘按键

["meta", "k"]

(string|undefined)[]|KbdProps[]

要在按钮中显示的键盘按键。 { variant: 'subtle' }

ui

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

插槽

插槽类型
前置

{}

default

{}

尾部

{}

主题

app.config.ts
export default defineAppConfig({
  ui: {
    dashboardSearchButton: {
      slots: {
        base: '',
        trailing: 'hidden lg:flex items-center gap-0.5 ms-auto'
      }
    }
  }
})
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: {
        dashboardSearchButton: {
          slots: {
            base: '',
            trailing: 'hidden lg:flex items-center gap-0.5 ms-auto'
          }
        }
      }
    })
  ]
})

更新日志

3173b— fix: proxySlots 响应性 (#4969)

61b60— 功能：允许传递组件而不是名称 (#4766)

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

DashboardSearch

一个即用型的 CommandPalette，可添加到您的仪表板。

DashboardSidebar

一个可调整大小且可折叠的侧边栏，用于显示在仪表板中。