ContentSearchButtonPRO

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

用法

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

<template>
  <UContentSearchButton />
</template>

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

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

折叠状态

使用 collapsed 属性来显示按钮的标签和键盘快捷键。默认为 true。

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

键盘快捷键

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

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

API

属性

属性默认值类型
color

'neutral'

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

collapsed

true

boolean

键盘快捷键

["meta", "k"]

(string | undefined)[] | KbdProps[]

icon

appConfig.ui.icons.search

string

按钮中显示的图标。

label

t('contentSearchButton.label')

string

按钮中显示的标签。

size

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

variant

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

按钮的变体。未折叠时默认为 'outline'，折叠时默认为 'ghost'。

ui

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

插槽

插槽类型
leading

{}

default

{}

trailing

{}

主题

app.config.ts
export default defineAppConfig({
  uiPro: {
    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({
      uiPro: {
        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 uiPro from '@nuxt/ui-pro/vite'

export default defineConfig({
  plugins: [
    vue(),
    uiPro({
      uiPro: {
        contentSearchButton: {
          slots: {
            base: '',
            trailing: 'hidden lg:flex items-center gap-0.5 ms-auto'
          }
        }
      }
    })
  ]
})

ContentSearch

一个可用于文档的、开箱即用的 CommandPalette。

ContentSurround

一对用于在页面之间导航的上一个和下一个链接。