We are still updating this page. Some data may be missing here — we will complete it shortly.
Usage
The DashboardSearch component extends the CommandPalette component, so you can pass any property such as icon, placeholder, etc.
Use it inside the default slot of the DashboardGroup component:
layouts/dashboard.vue
<template>
<B24DashboardGroup>
<B24SidebarLayout>
<template #navbar>
<B24NavbarSection>
<B24DashboardSearchButton />
</B24NavbarSection>
</template>
<B24DashboardSearch />
<slot />
</B24SidebarLayout>
</B24DashboardGroup>
</template>
You can open the CommandPalette by pressing K, by using the DashboardSearchButton component or by using a
v-model:open directive.Shortcut
Use the shortcut prop to change the shortcut used in defineShortcuts to open the ContentSearch component. Defaults to meta_k ( K).
app.vue
<template>
<B24DashboardSearch
v-model:search-term="searchTerm"
shortcut="meta_k"
:groups="groups"
:fuse="{ resultLimit: 42 }"
/>
</template>
Color Mode
By default, a group of commands will be added to the command palette so you can switch between light and dark mode. This will only take effect if the colorMode is not forced in a specific page which can be achieved through definePageMeta:
pages/index.vue
<script setup lang="ts">
definePageMeta({
colorMode: 'dark'
})
</script>
You can disable this behavior by setting the color-mode prop to false:
app.vue
<template>
<B24DashboardSearch
v-model:search-term="searchTerm"
:color-mode="false"
:groups="groups"
:fuse="{ resultLimit: 42 }"
/>
</template>
API
Props
Slots
Emits
Expose
When accessing the component via a template ref, you can use the following:
Theme
app.config.ts
export default defineAppConfig({
b24ui: {
dashboardSearch: {
slots: {
modal: 'p-0 pt-0 pb-[10px]',
input: ''
},
variants: {
fullscreen: {
false: {
modal: 'sm:max-w-[768px] sm:h-[436px]'
}
}
}
}
}
})
vite.config.ts
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import bitrix24UIPluginVite from '@bitrix24/b24ui-nuxt/vite'
export default defineConfig({
plugins: [
vue(),
bitrix24UIPluginVite({
b24ui: {
dashboardSearch: {
slots: {
modal: 'p-0 pt-0 pb-[10px]',
input: ''
},
variants: {
fullscreen: {
false: {
modal: 'sm:max-w-[768px] sm:h-[436px]'
}
}
}
}
}
})
]
})