ui/docs/content/3.components/command-palette.md at 2e9aeb5f05e94d63ea453c4f07a3e84ee2a02773

arthur/ui

mirror of https://github.com/ArthurDanjou/ui.git synced 2026-01-14 20:19:34 +01:00

Files

Benjamin Canac ba874c9191 docs(app): framework select global (#2719 )

Co-authored-by: harlan <harlan@harlanzw.com>

2024-11-25 15:47:52 +01:00

13 KiB

Raw Blame History

title, description, links

title

description

links

CommandPalette

A command palette with full-text search powered by Fuse.js for efficient fuzzy matching.

label	to	target
Fuse.js	https://fusejs.io/	_blank

label	icon	to
Combobox	i-custom-radix-vue	https://www.radix-vue.com/components/combobox.html

label	icon	to
GitHub	i-simple-icons-github	https://github.com/nuxt/ui/tree/v3/src/runtime/components/CommandPalette.vue

Usage

Use the v-model directive to control the value of the CommandPalette or the default-value prop to set the initial value when you do not need to control its state.

::tip{to="#control-selected-items"} You can also use the @update:model-value event to listen to the selected item(s). ::

Groups

The CommandPalette component filters groups and ranks matching commands by relevance as users type. It provides dynamic, instant search results for efficient command discovery. Use the groups prop as an array of objects with the following properties:

id: string{lang="ts-type"}
label?: string{lang="ts-type"}
slot?: string{lang="ts-type"}
items?: CommandPaletteItem[]{lang="ts-type"}
filter?: boolean{lang="ts-type"}
postFilter?: (searchTerm: string, items: T[]) => T[]{lang="ts-type"}
highlightedIcon?: string{lang="ts-type"}

Each group takes some items as an array of objects with the following properties:

prefix?: string{lang="ts-type"}
label?: string{lang="ts-type"}
suffix?: string{lang="ts-type"}
icon?: string{lang="ts-type"}
avatar?: AvatarProps{lang="ts-type"}
chip?: ChipProps{lang="ts-type"}
kbds?: string[] | KbdProps[]{lang="ts-type"}
active?: boolean{lang="ts-type"}
loading?: boolean{lang="ts-type"}
disabled?: boolean{lang="ts-type"}
slot?: string{lang="ts-type"}
onSelect?(e?: Event): void{lang="ts-type"}

::component-code

collapse: true ignore:

groups
modelValue
class external:
groups
modelValue class: '!p-0' props: modelValue: {} groups:
- id: 'users' label: 'Users' items:
  - label: 'Benjamin Canac' suffix: 'benjamincanac' avatar: src: 'https://github.com/benjamincanac.png'
  - label: 'Sylvain Marroufin' suffix: 'smarroufin' avatar: src: 'https://github.com/smarroufin.png'
  - label: 'Sébastien Chopin' suffix: 'atinux' avatar: src: 'https://github.com/atinux.png'
  - label: 'Romain Hamel' suffix: 'romhml' avatar: src: 'https://github.com/romhml.png'
  - label: 'Haytham A. Salama' suffix: 'Haythamasalama' avatar: src: 'https://github.com/Haythamasalama.png'
  - label: 'Daniel Roe' suffix: 'danielroe' avatar: src: 'https://github.com/danielroe.png'
  - label: 'Neil Richter' suffix: 'noook' avatar: src: 'https://github.com/noook.png' class: 'flex-1'

::caution You must provide an id for each group otherwise the group will be ignored. ::

Multiple

Use the multiple prop to allow multiple selections.

::component-code

collapse: true ignore:

groups
modelValue
multiple
class external:
groups
modelValue class: '!p-0' props: multiple: true modelValue: [] groups:
- id: 'users' label: 'Users' items:
  - label: 'Benjamin Canac' suffix: 'benjamincanac' avatar: src: 'https://github.com/benjamincanac.png'
  - label: 'Sylvain Marroufin' suffix: 'smarroufin' avatar: src: 'https://github.com/smarroufin.png'
  - label: 'Sébastien Chopin' suffix: 'atinux' avatar: src: 'https://github.com/atinux.png'
  - label: 'Romain Hamel' suffix: 'romhml' avatar: src: 'https://github.com/romhml.png'
  - label: 'Haytham A. Salama' suffix: 'Haythamasalama' avatar: src: 'https://github.com/Haythamasalama.png'
  - label: 'Daniel Roe' suffix: 'danielroe' avatar: src: 'https://github.com/danielroe.png'
  - label: 'Neil Richter' suffix: 'noook' avatar: src: 'https://github.com/noook.png' class: 'flex-1'

::caution Ensure to pass an array to the default-value prop or the v-model directive. ::

Placeholder

Use the placeholder prop to change the placeholder text.

::component-code

collapse: true ignore:

class
groups external:
groups class: '!p-0' props: placeholder: 'Search an app...' groups:
- id: 'apps' items:
  - label: 'Calendar' icon: 'i-lucide-calendar'
  - label: 'Music' icon: 'i-lucide-music'
  - label: 'Maps' icon: 'i-lucide-map' class: 'flex-1'

Icon

Use the icon prop to customize the input Icon. Defaults to i-lucide-search.

::component-code

collapse: true ignore:

class
groups external:
groups class: '!p-0' props: icon: 'i-lucide-box' groups:
- id: 'apps' items:
  - label: 'Calendar' icon: 'i-lucide-calendar'
  - label: 'Music' icon: 'i-lucide-music'
  - label: 'Maps' icon: 'i-lucide-map' class: 'flex-1'

::framework-only #nuxt :::tip{to="/getting-started/icons/nuxt#theme"} You can customize this icon globally in your app.config.ts under ui.icons.search key. :::

#vue :::tip{to="/getting-started/icons/vue#theme"} You can customize this icon globally in your vite.config.ts under ui.icons.search key. ::: ::

Loading

Use the loading prop to show a loading icon on the CommandPalette.

::component-code

collapse: true ignore:

class
groups external:
groups class: '!p-0' props: loading: true groups:
- id: 'apps' items:
  - label: 'Calendar' icon: 'i-lucide-calendar'
  - label: 'Music' icon: 'i-lucide-music'
  - label: 'Maps' icon: 'i-lucide-map' class: 'flex-1'

Loading Icon

Use the loading-icon prop to customize the loading icon. Defaults to i-lucide-refresh-ccw.

::component-code

collapse: true ignore:

class
groups external:
groups class: '!p-0' props: loading: true loadingIcon: 'i-lucide-repeat-2' groups:
- id: 'apps' items:
  - label: 'Calendar' icon: 'i-lucide-calendar'
  - label: 'Music' icon: 'i-lucide-music'
  - label: 'Maps' icon: 'i-lucide-map' class: 'flex-1'

::framework-only #nuxt :::tip{to="/getting-started/icons/nuxt#theme"} You can customize this icon globally in your app.config.ts under ui.icons.loading key. :::

#vue :::tip{to="/getting-started/icons/vue#theme"} You can customize this icon globally in your vite.config.ts under ui.icons.loading key. ::: ::

Disabled

Use the disabled prop to disable the CommandPalette.

::component-code

collapse: true ignore:

groups
class external:
groups class: '!p-0' props: disabled: true groups:
- id: 'apps' items:
  - label: 'Calendar' icon: 'i-lucide-calendar'
  - label: 'Music' icon: 'i-lucide-music'
  - label: 'Maps' icon: 'i-lucide-map' class: 'flex-1'

Close

Use the close prop to display a Button to dismiss the CommandPalette.

::tip An update:open event will be emitted when the close button is clicked. ::

::component-code

collapse: true ignore:

class
groups
close external:
groups class: '!p-0' props: close: true groups:
- id: 'apps' items:
  - label: 'Calendar' icon: 'i-lucide-calendar'
  - label: 'Music' icon: 'i-lucide-music'
  - label: 'Maps' icon: 'i-lucide-map' class: 'flex-1'

You can also pass all the props of the Button component to customize it.

::component-code

collapse: true prettier: true ignore:

close.color
close.variant
groups
class external:
groups class: '!p-0' props: close: color: primary variant: outline class: 'rounded-full' groups:
- id: 'apps' items:
  - label: 'Calendar' icon: 'i-lucide-calendar'
  - label: 'Music' icon: 'i-lucide-music'
  - label: 'Maps' icon: 'i-lucide-map' class: 'flex-1'

Close Icon

Use the close-icon prop to customize the close button Icon. Defaults to i-lucide-x.

::component-code

collapse: true ignore:

class
groups
close external:
groups class: '!p-0' props: close: true closeIcon: 'i-lucide-arrow-right' groups:
- id: 'apps' items:
  - label: 'Calendar' icon: 'i-lucide-calendar'
  - label: 'Music' icon: 'i-lucide-music'
  - label: 'Maps' icon: 'i-lucide-map' class: 'flex-1'

::framework-only #nuxt :::tip{to="/getting-started/icons/nuxt#theme"} You can customize this icon globally in your app.config.ts under ui.icons.close key. :::

#vue :::tip{to="/getting-started/icons/vue#theme"} You can customize this icon globally in your vite.config.ts under ui.icons.close key. ::: ::

Examples

Control selected item(s)

You can control the selected item by using the default-value prop or the v-model directive, by using the select field on each item or by using the @update:model-value event.

::component-example

collapse: true name: 'command-palette-select-example' class: '!p-0'

::note This example demonstrates how to use the @update:model-value event to handle different selection scenarios. ::

Control search term

Use the v-model:search-term directive to control the search term.

::component-example

collapse: true name: 'command-palette-search-term-example' class: '!p-0'

::note This example uses the @update:model-value event to reset the search term when an item is selected. ::

With fetched items

You can fetch items from an API and use them in the CommandPalette.

::component-example

collapse: true name: 'command-palette-fetch-example' class: '!p-0'

Without internal search

You can set the filter field to false on a group to disable the internal search and use your own search logic.

::component-example

collapse: true name: 'command-palette-filter-example' class: '!p-0'

::note This example uses refDebounced to debounce the API calls. ::

With post-filtered items

You can use the postFilter field on a group to filter items after the search happened.

::component-example

collapse: true name: 'command-palette-post-filter-example' class: '!p-0'

::note Start typing to see items with higher level appear. ::

With custom fuse search

You can use the fuse prop to override the options of useFuse which defaults to:

{
  fuseOptions: {
    ignoreLocation: true,
    threshold: 0.1,
    keys: ['label', 'suffix']
  },
  resultLimit: 12,
  matchAllWhenSearchEmpty: true
}

::tip The fuseOptions are the options of Fuse.js, the resultLimit is the maximum number of results to return and the matchAllWhenSearchEmpty is a boolean to match all items when the search term is empty. ::

You can for example set { fuseOptions: { includeMatches: true } }{lang="ts-type"} to highlight the search term in the items.

::component-example

collapse: true name: 'command-palette-fuse-example' class: '!p-0'

You can use the CommandPalette component inside a Popover's content.

::component-example

You can use the CommandPalette component inside a Modal's content.

::component-example

Within a Drawer

You can use the CommandPalette component inside a Drawer's content.

::component-example

collapse: true name: 'drawer-command-palette-example'

Listen open state

When using the close prop, you can listen to the update:open event when the button is clicked.

::component-example

collapse: true name: 'command-palette-open-example'

::note This can be useful when using the CommandPalette inside a Modal for example. ::

With custom slot

Use the slot property to customize a specific item or group.

You will have access to the following slots:

#{{ item.slot }}{lang="ts-type"}
#{{ item.slot }}-leading{lang="ts-type"}
#{{ item.slot }}-label{lang="ts-type"}
#{{ item.slot }}-trailing{lang="ts-type"}
#{{ group.slot }}{lang="ts-type"}
#{{ group.slot }}-leading{lang="ts-type"}
#{{ group.slot }}-label{lang="ts-type"}
#{{ group.slot }}-trailing{lang="ts-type"}

::component-example

name: 'command-palette-custom-slot-example' class: '!p-0'

::tip{to="#slots"} You can also use the #item, #item-leading, #item-label and #item-trailing slots to customize all items. ::

API

Props

:component-props

Slots

:component-slots

Emits

:component-emits

Theme

:component-theme

13 KiB Raw Blame History

Usage

Groups

::component-code

Multiple

::component-code

Placeholder

::component-code

Icon

::component-code

Loading

::component-code

Loading Icon

::component-code

Disabled

::component-code

Close

::component-code

::component-code

Close Icon

::component-code

Examples

Control selected item(s)

::component-example

collapse: true name: 'command-palette-select-example' class: '!p-0'

Control search term

::component-example

collapse: true name: 'command-palette-search-term-example' class: '!p-0'

With fetched items

::component-example

collapse: true name: 'command-palette-fetch-example' class: '!p-0'

Without internal search

::component-example

collapse: true name: 'command-palette-filter-example' class: '!p-0'

With post-filtered items

::component-example

collapse: true name: 'command-palette-post-filter-example' class: '!p-0'

With custom fuse search

::component-example

collapse: true name: 'command-palette-fuse-example' class: '!p-0'

Within a Popover

::component-example

collapse: true name: 'popover-command-palette-example'

Within a Modal

::component-example

collapse: true name: 'modal-command-palette-example'

Within a Drawer

::component-example

collapse: true name: 'drawer-command-palette-example'

Listen open state

::component-example

collapse: true name: 'command-palette-open-example'

With custom slot

::component-example

name: 'command-palette-custom-slot-example' class: '!p-0'

API

Props

Slots

Emits

Theme

13 KiB

Raw Blame History