内容搜索按钮

ButtonGitHub
一个预设样式的按钮，用于打开内容搜索模态框。
此组件仅在安装了 @nuxt/content 模块时可用。

用法

ContentSearchButton 组件用于打开 ContentSearch 模态框。

<template>
  <UContentSearchButton />
</template>

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

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

折叠

使用 collapsed prop 来显示按钮的标签和键盘按键。默认为 true。

<template>
  <UContentSearchButton :collapsed="false" />
</template>

键盘按键

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

<template>
  <UContentSearchButton :collapsed="false" :kbds="['alt', 'O']" />
</template>

API

属性

属性默认值类型
图标

appConfig.ui.icons.search

字符串 | 对象

按钮中显示的图标。

label

t('contentSearchButton.label')

string

按钮中显示的标签。

color

'neutral'

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

按钮的颜色。

variant

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

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

尺寸

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

collapsed

true

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: {
    contentSearchButton: {
      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: {
        contentSearchButton: {
          slots: {
            base: '',
            trailing: 'hidden lg:flex items-center gap-0.5 ms-auto'
          }
        }
      }
    })
  ]
})

更新日志

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

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

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

ContentSearch

一个现成的 CommandPalette，可添加到您的文档中。

ContentSurround

一对 prev 和 next 链接，用于在页面之间导航。