内容搜索

一个随时可用的命令面板，可添加到您的文档中。

此组件仅在安装了 @nuxt/content 模块时可用。

用法

ContentSearch 组件扩展了 CommandPalette 组件，因此您可以传递任何属性，例如 icon、placeholder 等。

将 files 和 navigation 属性与您使用 @nuxt/content 中的 queryCollectionSearchSections 和 queryCollectionNavigation 可组合函数获取的 files 和 navigation 值一起使用。

您可以通过按 K，使用 ContentSearchButton 组件或使用 useContentSearch 可组合函数打开 CommandPalette：const { open } = useContentSearch()。

快捷键

使用 shortcut 属性更改 defineShortcuts 中用于打开 ContentSearch 组件的快捷键。默认为 meta_k ( K)。

app.vue

<template>
  <UApp>
    <ClientOnly>
      <LazyUContentSearch
        v-model:search-term="searchTerm"
        shortcut="meta_k"
        :files="files"
        :navigation="navigation"
        :fuse="{ resultLimit: 42 }"
      />
    </ClientOnly>
  </UApp>
</template>

颜色模式

默认情况下，一组命令将被添加到命令面板中，以便您可以在浅色和深色模式之间切换。这仅在特定页面中未强制设置 colorMode 时生效，这可以通过 definePageMeta 实现

pages/index.vue

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

您可以通过将 color-mode 属性设置为 false 来禁用此行为

app.vue

<template>
  <UApp>
    <ClientOnly>
      <LazyUContentSearch
        v-model:search-term="searchTerm"
        :color-mode="false"
        :files="files"
        :navigation="navigation"
        :fuse="{ resultLimit: 42 }"
      />
    </ClientOnly>
  </UApp>
</template>

示例

在 `app.vue` 中

在您的 app.vue 或布局中使用 ContentSearch 组件

app.vue

<script setup lang="ts">
const { data: navigation } = await useAsyncData('navigation', () => queryCollectionNavigation('content'))
const { data: files } = useLazyAsyncData('search', () => queryCollectionSearchSections('content'), {
  server: false
})

const links = [{
  label: 'Docs',
  icon: 'i-lucide-book',
  to: '/docs/getting-started'
}, {
  label: 'Components',
  icon: 'i-lucide-box',
  to: '/docs/components'
}, {
  label: 'Showcase',
  icon: 'i-lucide-presentation',
  to: '/showcase'
}]

const searchTerm = ref('')
</script>

<template>
  <UApp>
    <ClientOnly>
      <LazyUContentSearch
        v-model:search-term="searchTerm"
        :files="files"
        shortcut="meta_k"
        :navigation="navigation"
        :links="links"
        :fuse="{ resultLimit: 42 }"
      />
    </ClientOnly>
  </UApp>
</template>

建议将 ContentSearch 组件封装在ClientOnly组件中，这样它就不会在服务器上渲染。

API

属性

属性	默认值	类型
`图标`	`appConfig.ui.icons.search`	`any` 输入框中显示的图标。
`placeholder`	`t('commandPalette.placeholder')`	`string` 输入框的占位文本。
`autofocus`	`true`	`boolean` 组件挂载时自动聚焦输入框。
`loading`		`boolean` 当为 `true` 时，将显示加载图标。
`loadingIcon`	`appConfig.ui.icons.loading`	`any` 当 `loading` prop 为 `true` 时显示的图标。
`close`	`true`	`boolean \| Omit<ButtonProps, LinkPropsKeys>` 在输入框中显示一个关闭按钮（例如在模态框中使用时很有用）。 `{ size: 'md', color: 'neutral', variant: 'ghost' }`
`closeIcon`	`appConfig.ui.icons.close`	`any` 关闭按钮中显示的图标。
`快捷方式`	`'meta_k'`	`string` 打开搜索的键盘快捷键（由`defineShortcuts`)
`links`		`ContentSearchLink[]` 链接组作为命令面板中的第一个组显示。
`导航`		`ContentNavigationItem[]`
`分组`		`CommandPaletteGroup<ContentSearchItem>[]` 在导航和颜色模式组之间显示的自定义组。
`文件`		`ContentSearchFile[]`
`fuse`	`{ fuseOptions: { includeMatches: true } }`	`UseFuseOptions<ContentSearchLink>` 用于 `useFuse` 的选项useFuse传递给CommandPalette.
`colorMode`	`true`	`boolean` 当 `true` 时，主题命令将被添加到组中。
`title`		`string`
`description`		`string`
`叠加层`	`true`	`boolean` 在模态框后面渲染一个叠加层。
`过渡动画`	`true`	`boolean` 在打开或关闭时为模态框添加动画效果。
`内容`		`DialogContentProps & Partial<EmitsToProps<DialogContentImplEmits>>` 模态框的内容。
`可关闭的`	`true`	`boolean` 当为 `false` 时，点击外部或按下 Escape 键时模态框将不会关闭。
`全屏`	`false`	`boolean` 当为 `true` 时，模态框将占据整个屏幕。
`modal`		`boolean` 对话框的模态性。当设置为 `true` 时，与外部元素的交互将被禁用，并且只有对话框内容对屏幕阅读器可见。
`portal`	`true`	`string \| false \| true \| HTMLElement` 在传送门中渲染模态框。
`搜索词`	`''`	`string`
`ui`		{ modal?: ClassNameValue; input?: ClassNameValue; } & { root?: ClassNameValue; input?: ClassNameValue; close?: ClassNameValue; back?: ClassNameValue; content?: ClassNameValue; footer?: ClassNameValue; viewport?: ClassNameValue; group?: ClassNameValue; empty?: ClassNameValue; label?: ClassNameValue; item?: ClassNameValue; itemLeadingIcon?: ClassNameValue; itemLeadingAvatar?: ClassNameValue; itemLeadingAvatarSize?: ClassNameValue; itemLeadingChip?: ClassNameValue; itemLeadingChipSize?: ClassNameValue; itemTrailing?: ClassNameValue; itemTrailingIcon?: ClassNameValue; itemTrailingHighlightedIcon?: ClassNameValue; itemTrailingKbds?: ClassNameValue; itemTrailingKbdsSize?: ClassNameValue; itemWrapper?: ClassNameValue; itemLabel?: ClassNameValue; itemDescription?: ClassNameValue; itemLabelBase?: ClassNameValue; itemLabelPrefix?: ClassNameValue; itemLabelSuffix?: ClassNameValue; }

插槽

插槽	类型
`空`	`{ searchTerm?: string \| undefined; }`
`页脚`	{ ui: { root: (props?: Record<string, any> \| undefined) => string; input: (props?: Record<string, any> \| undefined) => string; close: (props?: Record<string, any> \| undefined) => string; back: (props?: Record<string, any> \| undefined) => string; content: (props?: Record<string, any> \| undefined) => string; footer: (props?: Record<string, any> \| undefined) => string; viewport: (props?: Record<string, any> \| undefined) => string; group: (props?: Record<string, any> \| undefined) => string; empty: (props?: Record<string, any> \| undefined) => string; label: (props?: Record<string, any> \| undefined) => string; item: (props?: Record<string, any> \| undefined) => string; itemLeadingIcon: (props?: Record<string, any> \| undefined) => string; itemLeadingAvatar: (props?: Record<string, any> \| undefined) => string; itemLeadingAvatarSize: (props?: Record<string, any> \| undefined) => string; itemLeadingChip: (props?: Record<string, any> \| undefined) => string; itemLeadingChipSize: (props?: Record<string, any> \| undefined) => string; itemTrailing: (props?: Record<string, any> \| undefined) => string; itemTrailingIcon: (props?: Record<string, any> \| undefined) => string; itemTrailingHighlightedIcon: (props?: Record<string, any> \| undefined) => string; itemTrailingKbds: (props?: Record<string, any> \| undefined) => string; itemTrailingKbdsSize: (props?: Record<string, any> \| undefined) => string; itemWrapper: (props?: Record<string, any> \| undefined) => string; itemLabel: (props?: Record<string, any> \| undefined) => string; itemDescription: (props?: Record<string, any> \| undefined) => string; itemLabelBase: (props?: Record<string, any> \| undefined) => string; itemLabelPrefix: (props?: Record<string, any> \| undefined) => string; itemLabelSuffix: (props?: Record<string, any> \| undefined) => string; }; }
`返回`	{ ui: { root: (props?: Record<string, any> \| undefined) => string; input: (props?: Record<string, any> \| undefined) => string; close: (props?: Record<string, any> \| undefined) => string; back: (props?: Record<string, any> \| undefined) => string; content: (props?: Record<string, any> \| undefined) => string; footer: (props?: Record<string, any> \| undefined) => string; viewport: (props?: Record<string, any> \| undefined) => string; group: (props?: Record<string, any> \| undefined) => string; empty: (props?: Record<string, any> \| undefined) => string; label: (props?: Record<string, any> \| undefined) => string; item: (props?: Record<string, any> \| undefined) => string; itemLeadingIcon: (props?: Record<string, any> \| undefined) => string; itemLeadingAvatar: (props?: Record<string, any> \| undefined) => string; itemLeadingAvatarSize: (props?: Record<string, any> \| undefined) => string; itemLeadingChip: (props?: Record<string, any> \| undefined) => string; itemLeadingChipSize: (props?: Record<string, any> \| undefined) => string; itemTrailing: (props?: Record<string, any> \| undefined) => string; itemTrailingIcon: (props?: Record<string, any> \| undefined) => string; itemTrailingHighlightedIcon: (props?: Record<string, any> \| undefined) => string; itemTrailingKbds: (props?: Record<string, any> \| undefined) => string; itemTrailingKbdsSize: (props?: Record<string, any> \| undefined) => string; itemWrapper: (props?: Record<string, any> \| undefined) => string; itemLabel: (props?: Record<string, any> \| undefined) => string; itemDescription: (props?: Record<string, any> \| undefined) => string; itemLabelBase: (props?: Record<string, any> \| undefined) => string; itemLabelPrefix: (props?: Record<string, any> \| undefined) => string; itemLabelSuffix: (props?: Record<string, any> \| undefined) => string; }; }
`close`	{ ui: { root: (props?: Record<string, any> \| undefined) => string; input: (props?: Record<string, any> \| undefined) => string; close: (props?: Record<string, any> \| undefined) => string; back: (props?: Record<string, any> \| undefined) => string; content: (props?: Record<string, any> \| undefined) => string; footer: (props?: Record<string, any> \| undefined) => string; viewport: (props?: Record<string, any> \| undefined) => string; group: (props?: Record<string, any> \| undefined) => string; empty: (props?: Record<string, any> \| undefined) => string; label: (props?: Record<string, any> \| undefined) => string; item: (props?: Record<string, any> \| undefined) => string; itemLeadingIcon: (props?: Record<string, any> \| undefined) => string; itemLeadingAvatar: (props?: Record<string, any> \| undefined) => string; itemLeadingAvatarSize: (props?: Record<string, any> \| undefined) => string; itemLeadingChip: (props?: Record<string, any> \| undefined) => string; itemLeadingChipSize: (props?: Record<string, any> \| undefined) => string; itemTrailing: (props?: Record<string, any> \| undefined) => string; itemTrailingIcon: (props?: Record<string, any> \| undefined) => string; itemTrailingHighlightedIcon: (props?: Record<string, any> \| undefined) => string; itemTrailingKbds: (props?: Record<string, any> \| undefined) => string; itemTrailingKbdsSize: (props?: Record<string, any> \| undefined) => string; itemWrapper: (props?: Record<string, any> \| undefined) => string; itemLabel: (props?: Record<string, any> \| undefined) => string; itemDescription: (props?: Record<string, any> \| undefined) => string; itemLabelBase: (props?: Record<string, any> \| undefined) => string; itemLabelPrefix: (props?: Record<string, any> \| undefined) => string; itemLabelSuffix: (props?: Record<string, any> \| undefined) => string; }; }
`item`	{ item: ContentSearchItem; index: number; ui: { root: (props?: Record<string, any> \| undefined) => string; input: (props?: Record<string, any> \| undefined) => string; close: (props?: Record<string, any> \| undefined) => string; back: (props?: Record<string, any> \| undefined) => string; content: (props?: Record<string, any> \| undefined) => string; footer: (props?: Record<string, any> \| undefined) => string; viewport: (props?: Record<string, any> \| undefined) => string; group: (props?: Record<string, any> \| undefined) => string; empty: (props?: Record<string, any> \| undefined) => string; label: (props?: Record<string, any> \| undefined) => string; item: (props?: Record<string, any> \| undefined) => string; itemLeadingIcon: (props?: Record<string, any> \| undefined) => string; itemLeadingAvatar: (props?: Record<string, any> \| undefined) => string; itemLeadingAvatarSize: (props?: Record<string, any> \| undefined) => string; itemLeadingChip: (props?: Record<string, any> \| undefined) => string; itemLeadingChipSize: (props?: Record<string, any> \| undefined) => string; itemTrailing: (props?: Record<string, any> \| undefined) => string; itemTrailingIcon: (props?: Record<string, any> \| undefined) => string; itemTrailingHighlightedIcon: (props?: Record<string, any> \| undefined) => string; itemTrailingKbds: (props?: Record<string, any> \| undefined) => string; itemTrailingKbdsSize: (props?: Record<string, any> \| undefined) => string; itemWrapper: (props?: Record<string, any> \| undefined) => string; itemLabel: (props?: Record<string, any> \| undefined) => string; itemDescription: (props?: Record<string, any> \| undefined) => string; itemLabelBase: (props?: Record<string, any> \| undefined) => string; itemLabelPrefix: (props?: Record<string, any> \| undefined) => string; itemLabelSuffix: (props?: Record<string, any> \| undefined) => string; }; }
`item-leading`	{ item: ContentSearchItem; index: number; ui: { root: (props?: Record<string, any> \| undefined) => string; input: (props?: Record<string, any> \| undefined) => string; close: (props?: Record<string, any> \| undefined) => string; back: (props?: Record<string, any> \| undefined) => string; content: (props?: Record<string, any> \| undefined) => string; footer: (props?: Record<string, any> \| undefined) => string; viewport: (props?: Record<string, any> \| undefined) => string; group: (props?: Record<string, any> \| undefined) => string; empty: (props?: Record<string, any> \| undefined) => string; label: (props?: Record<string, any> \| undefined) => string; item: (props?: Record<string, any> \| undefined) => string; itemLeadingIcon: (props?: Record<string, any> \| undefined) => string; itemLeadingAvatar: (props?: Record<string, any> \| undefined) => string; itemLeadingAvatarSize: (props?: Record<string, any> \| undefined) => string; itemLeadingChip: (props?: Record<string, any> \| undefined) => string; itemLeadingChipSize: (props?: Record<string, any> \| undefined) => string; itemTrailing: (props?: Record<string, any> \| undefined) => string; itemTrailingIcon: (props?: Record<string, any> \| undefined) => string; itemTrailingHighlightedIcon: (props?: Record<string, any> \| undefined) => string; itemTrailingKbds: (props?: Record<string, any> \| undefined) => string; itemTrailingKbdsSize: (props?: Record<string, any> \| undefined) => string; itemWrapper: (props?: Record<string, any> \| undefined) => string; itemLabel: (props?: Record<string, any> \| undefined) => string; itemDescription: (props?: Record<string, any> \| undefined) => string; itemLabelBase: (props?: Record<string, any> \| undefined) => string; itemLabelPrefix: (props?: Record<string, any> \| undefined) => string; itemLabelSuffix: (props?: Record<string, any> \| undefined) => string; }; }
`item-label`	{ item: ContentSearchItem; index: number; ui: { root: (props?: Record<string, any> \| undefined) => string; input: (props?: Record<string, any> \| undefined) => string; close: (props?: Record<string, any> \| undefined) => string; back: (props?: Record<string, any> \| undefined) => string; content: (props?: Record<string, any> \| undefined) => string; footer: (props?: Record<string, any> \| undefined) => string; viewport: (props?: Record<string, any> \| undefined) => string; group: (props?: Record<string, any> \| undefined) => string; empty: (props?: Record<string, any> \| undefined) => string; label: (props?: Record<string, any> \| undefined) => string; item: (props?: Record<string, any> \| undefined) => string; itemLeadingIcon: (props?: Record<string, any> \| undefined) => string; itemLeadingAvatar: (props?: Record<string, any> \| undefined) => string; itemLeadingAvatarSize: (props?: Record<string, any> \| undefined) => string; itemLeadingChip: (props?: Record<string, any> \| undefined) => string; itemLeadingChipSize: (props?: Record<string, any> \| undefined) => string; itemTrailing: (props?: Record<string, any> \| undefined) => string; itemTrailingIcon: (props?: Record<string, any> \| undefined) => string; itemTrailingHighlightedIcon: (props?: Record<string, any> \| undefined) => string; itemTrailingKbds: (props?: Record<string, any> \| undefined) => string; itemTrailingKbdsSize: (props?: Record<string, any> \| undefined) => string; itemWrapper: (props?: Record<string, any> \| undefined) => string; itemLabel: (props?: Record<string, any> \| undefined) => string; itemDescription: (props?: Record<string, any> \| undefined) => string; itemLabelBase: (props?: Record<string, any> \| undefined) => string; itemLabelPrefix: (props?: Record<string, any> \| undefined) => string; itemLabelSuffix: (props?: Record<string, any> \| undefined) => string; }; }
`项目描述`	{ item: ContentSearchItem; index: number; ui: { root: (props?: Record<string, any> \| undefined) => string; input: (props?: Record<string, any> \| undefined) => string; close: (props?: Record<string, any> \| undefined) => string; back: (props?: Record<string, any> \| undefined) => string; content: (props?: Record<string, any> \| undefined) => string; footer: (props?: Record<string, any> \| undefined) => string; viewport: (props?: Record<string, any> \| undefined) => string; group: (props?: Record<string, any> \| undefined) => string; empty: (props?: Record<string, any> \| undefined) => string; label: (props?: Record<string, any> \| undefined) => string; item: (props?: Record<string, any> \| undefined) => string; itemLeadingIcon: (props?: Record<string, any> \| undefined) => string; itemLeadingAvatar: (props?: Record<string, any> \| undefined) => string; itemLeadingAvatarSize: (props?: Record<string, any> \| undefined) => string; itemLeadingChip: (props?: Record<string, any> \| undefined) => string; itemLeadingChipSize: (props?: Record<string, any> \| undefined) => string; itemTrailing: (props?: Record<string, any> \| undefined) => string; itemTrailingIcon: (props?: Record<string, any> \| undefined) => string; itemTrailingHighlightedIcon: (props?: Record<string, any> \| undefined) => string; itemTrailingKbds: (props?: Record<string, any> \| undefined) => string; itemTrailingKbdsSize: (props?: Record<string, any> \| undefined) => string; itemWrapper: (props?: Record<string, any> \| undefined) => string; itemLabel: (props?: Record<string, any> \| undefined) => string; itemDescription: (props?: Record<string, any> \| undefined) => string; itemLabelBase: (props?: Record<string, any> \| undefined) => string; itemLabelPrefix: (props?: Record<string, any> \| undefined) => string; itemLabelSuffix: (props?: Record<string, any> \| undefined) => string; }; }
`item-trailing`	{ item: ContentSearchItem; index: number; ui: { root: (props?: Record<string, any> \| undefined) => string; input: (props?: Record<string, any> \| undefined) => string; close: (props?: Record<string, any> \| undefined) => string; back: (props?: Record<string, any> \| undefined) => string; content: (props?: Record<string, any> \| undefined) => string; footer: (props?: Record<string, any> \| undefined) => string; viewport: (props?: Record<string, any> \| undefined) => string; group: (props?: Record<string, any> \| undefined) => string; empty: (props?: Record<string, any> \| undefined) => string; label: (props?: Record<string, any> \| undefined) => string; item: (props?: Record<string, any> \| undefined) => string; itemLeadingIcon: (props?: Record<string, any> \| undefined) => string; itemLeadingAvatar: (props?: Record<string, any> \| undefined) => string; itemLeadingAvatarSize: (props?: Record<string, any> \| undefined) => string; itemLeadingChip: (props?: Record<string, any> \| undefined) => string; itemLeadingChipSize: (props?: Record<string, any> \| undefined) => string; itemTrailing: (props?: Record<string, any> \| undefined) => string; itemTrailingIcon: (props?: Record<string, any> \| undefined) => string; itemTrailingHighlightedIcon: (props?: Record<string, any> \| undefined) => string; itemTrailingKbds: (props?: Record<string, any> \| undefined) => string; itemTrailingKbdsSize: (props?: Record<string, any> \| undefined) => string; itemWrapper: (props?: Record<string, any> \| undefined) => string; itemLabel: (props?: Record<string, any> \| undefined) => string; itemDescription: (props?: Record<string, any> \| undefined) => string; itemLabelBase: (props?: Record<string, any> \| undefined) => string; itemLabelPrefix: (props?: Record<string, any> \| undefined) => string; itemLabelSuffix: (props?: Record<string, any> \| undefined) => string; }; }
`内容`	`{ close: () => void; }`

事件

事件	类型
`update:searchTerm`	`[value: string]`

可访问属性

通过模板引用访问组件时，您可以使用以下内容：

名称	类型
`commandPaletteRef`	`Ref<InstanceType<typeof UCommandPalette> \| null>`

主题

app.config.ts

export default defineAppConfig({
  ui: {
    contentSearch: {
      slots: {
        modal: '',
        input: '[&>input]:text-base/5'
      },
      variants: {
        fullscreen: {
          false: {
            modal: 'sm:max-w-3xl h-full sm:h-[28rem]'
          }
        }
      }
    }
  }
})

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: {
        contentSearch: {
          slots: {
            modal: '',
            input: '[&>input]:text-base/5'
          },
          variants: {
            fullscreen: {
              false: {
                modal: 'sm:max-w-3xl h-full sm:h-[28rem]'
              }
            }
          }
        }
      }
    })
  ]
})

更新日志

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

dd81d— feat: 添加 data-slot 属性 (#5447)

e751b— 修复：提高性能和过滤逻辑 (#5433)

fce2d— 修复！：一致的暴露引用 (#5385)

8a259— 修复：去除描述和后缀的重复

63c0a— feat: 在使用的 slot prop 中暴露 ui (#5207)

095a0— 修复：代理模态框属性以支持全屏

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

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

946c2— 修复：使 ui.modal 生效

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

ContentNavigation

用于组织页面链接的手风琴式导航组件。

ContentSearchButton

一个预设样式的按钮，用于打开 ContentSearch 模态框。