arthur/ui
1
0
Fork 0
mirror of https://github.com/ArthurDanjou/ui.git synced 2026-01-14 20:19:34 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs(command-palette): add API section

Browse Source
This commit is contained in:
Benjamin Canac
2024-01-23 11:50:23 +01:00
parent a47d9cc006
commit 5b134b07ef
1 changed files with 19 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/content/5.navigation/2.command-palette.md
View File

@@ -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