mirror of
https://github.com/ArthurDanjou/ui.git
synced 2026-01-17 13:38:07 +01:00
124 lines
2.7 KiB
Markdown
124 lines
2.7 KiB
Markdown
---
|
|
description: 'Learn how to display and define keyboard shortcuts in your app.'
|
|
---
|
|
|
|
## Overview
|
|
|
|
Some components like [Dropdown](/elements/dropdown), [Command Palette](/navigation/command-palette) and [Tooltip](/overlays/tooltip) support the display of keyboard shortcuts.
|
|
|
|
```vue
|
|
<UDropdown :items="[{ label: 'Edit', shortcuts: ['E'] }]" />
|
|
```
|
|
|
|
Shortcuts are displayed and styled through the [Kbd](/elements/kbd) component.
|
|
|
|
```vue
|
|
<template>
|
|
<div class="flex items-center gap-0.5">
|
|
<UKbd>⌘</UKbd>
|
|
<UKbd>K</UKbd>
|
|
</div>
|
|
</template>
|
|
```
|
|
|
|
::alert{icon="i-heroicons-light-bulb"}
|
|
You will have a preview of how shortcuts are rendered in each component page.
|
|
::
|
|
|
|
## `defineShortcuts`
|
|
|
|
This module provides a `defineShortcuts` composable that allows you to define keyboard shortcuts in your app really easily.
|
|
|
|
```vue
|
|
<template>
|
|
<UModal v-model="isOpen" />
|
|
</template>
|
|
|
|
<script setup lang="ts">
|
|
const isOpen = ref(false)
|
|
|
|
defineShortcuts({
|
|
meta_k: {
|
|
usingInput: true,
|
|
handler: () => {
|
|
isOpen.value = !isOpen.value
|
|
}
|
|
}
|
|
})
|
|
</script>
|
|
```
|
|
|
|
### `usingInput`
|
|
|
|
Prop: `usingInput?: string | boolean`
|
|
|
|
By default, `usingInput` is `false`, meaning it will only trigger when no input is focused. When set to `true`, the shortcut will also trigger when any input is focused.
|
|
|
|
For a more advanced behavior, `usingInput` can be set to the name of an input, so it only triggers when focusing this specific input.
|
|
|
|
```vue
|
|
<template>
|
|
<UInput v-model="query" name="queryInput" />
|
|
</template>
|
|
|
|
<script setup lang="ts">
|
|
const query = ref('')
|
|
|
|
defineShortcuts({
|
|
enter: {
|
|
usingInput: 'queryInput',
|
|
handler: () => {
|
|
// TODO
|
|
}
|
|
}
|
|
})
|
|
</script>
|
|
```
|
|
_`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
|
|
|
|
In case the shortcut does not need any config, it can be written as a function.
|
|
|
|
```ts
|
|
defineShortcuts({
|
|
'?': () => openHelpModal()
|
|
})
|
|
```
|
|
|
|
## `useShortcuts`
|
|
|
|
To display shortcuts in your app according to the user's OS, you can use the `useShortcuts` composable.
|
|
|
|
```vue
|
|
<script setup>
|
|
const { metaSymbol } = useShortcuts()
|
|
</script>
|
|
|
|
<template>
|
|
<UKbd>{{ metaSymbol }}</UKbd>
|
|
</template>
|
|
```
|
|
_`metaSymbol` will display either `⌘` on MacOS or `Ctrl` on any other OS_
|