Skip to content

Commit

Permalink
docs(command-palette): update
Browse files Browse the repository at this point in the history
  • Loading branch information
benjamincanac committed Sep 12, 2024
1 parent d9b14bc commit ce91b5d
Show file tree
Hide file tree
Showing 2 changed files with 118 additions and 0 deletions.
117 changes: 117 additions & 0 deletions docs/content/3.components/command-palette.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,127 @@ links:
- label: GitHub
icon: i-simple-icons-github
to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/CommandPalette.vue
navigation:
badge:
label: Todo
---

## 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.

::note
You can also use it without any of these and either use the `select` field on each item and/or the `@update:model-value` event to handle the selection.
::

### Groups

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"}
- `disabled?: boolean`{lang="ts-type"}
- `slot?: string`{lang="ts-type"}
- `select?(e?: Event): void`{lang="ts-type"}

::component-code
---
collapse: true
ignore:
- groups
- class
external:
- groups
class: '!p-0'
props:
groups:
- id: 'users'
label: 'Users'
items:
- label: 'John Doe'
suffix: '[email protected]'
icon: 'i-heroicons-user'
- label: 'Jane Doe'
suffix: '[email protected]'
icon: 'i-heroicons-user'
- label: 'John Smith'
suffix: '[email protected]'
icon: 'i-heroicons-user'
class: 'flex-1'
---
::

### Multiple

Use the `multiple` prop to allow multiple selections.

::component-code
---
collapse: true
ignore:
- groups
- class
external:
- groups
class: '!p-0'
props:
groups:
- id: 'actions'
label: 'Actions'
items:
- label: 'Add new file'
suffix: 'Create a new file in the current directory or workspace.'
icon: 'i-heroicons-document-plus'
kbds:
- 'meta'
- 'N'
- label: 'Add new folder'
suffix: 'Create a new folder in the current directory or workspace.'
icon: 'i-heroicons-folder-plus'
kbds:
- 'meta'
- 'F'
- label: 'Add hashtag'
suffix: 'Add a hashtag to the current item.'
icon: 'i-heroicons-hashtag'
kbds:
- 'meta'
- 'H'
- label: 'Add label'
suffix: 'Add a label to the current item.'
icon: 'i-heroicons-tag'
kbds:
- 'meta'
- 'L'
class: 'flex-1'
---
::

### Placeholder

### Icon

### Loading

### Disabled

### Close

## Examples

### Control search term
Expand Down
1 change: 1 addition & 0 deletions docs/nuxt.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@ export default defineNuxtConfig({
'UCheckbox',
'UChip',
'UCollapsible',
'UCommandPalette',
'UContextMenu',
'UDrawer',
'UDropdownMenu',
Expand Down

0 comments on commit ce91b5d

Please sign in to comment.