arthur/ui
1
0
Fork 0
mirror of https://github.com/ArthurDanjou/ui.git synced 2026-01-30 11:47:55 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs(define-shortcuts): update

Browse Source
This commit is contained in:
Benjamin Canac
2024-07-18 17:51:20 +02:00
parent 35f72351d0
commit 5317c5724f
1 changed files with 0 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/content/2.composables/1.define-shortcuts.md
View File

@@ -95,27 +95,6 @@ defineShortcuts({
``` ```
_`enter` shortcut will only trigger when `queryInput` is focused._ _`enter` shortcut will only trigger when `queryInput` is focused._
### `whenever`
Prop: `whenever?: WatchSource<boolean>[]`
`whenever` allows to add constraints on the shortcut triggering behavior. This array can contain `Ref<boolean>`, `ComputedRef<boolean>` or `() => boolean`.
```ts
defineShortcuts({
meta_k: {
usingInput: true,
handler: () => { isOpen.value = !isOpen.value }
},
escape: {
usingInput: true,
whenever: [isOpen],
handler: () => { isOpen.value = false }
}
})
```
_`escape` shortcut will only trigger when `isOpen` is `true`._
### Simple shortcut ### Simple shortcut
In case the shortcut does not need any config, it can be written as a function. In case the shortcut does not need any config, it can be written as a function.