Skip to content

Commit

Permalink
docs(command-palette): add API section
Browse files Browse the repository at this point in the history
  • Loading branch information
benjamincanac committed Jan 23, 2024
1 parent a47d9cc commit 5b134b0
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/content/5.navigation/2.command-palette.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,25 @@ componentProps:

:component-props

## API

When accessing the component via a template ref, you can use the following:

::field-group
::field{name="query" type="string"}
The current query.
::
::field{name="updateQuery (query)"}
Updates the current query.
::
::field{name="results" type="ComputedRef<Fuse.FuseResult<Command>[]>"}
The results exposed by [useFuse](https://vueuse.org/integrations/useFuse/#usefuse).
::
::field{name="comboboxApi"}
The Combobox [API](https://github.com/tailwindlabs/headlessui/blob/main/packages/%40headlessui-vue/src/components/combobox/combobox.ts#L384) exposed by Headless UI.
::
::

## Config

:component-preset

1 comment on commit 5b134b0

@vercel
Copy link

@vercel vercel bot commented on 5b134b0 Jan 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

ui – ./

ui-git-dev-nuxt-js.vercel.app
ui.nuxt.com
ui-nuxt-js.vercel.app

Please sign in to comment.