feat: Complete fleet — 94 skills across 10+ domains
Pulled ALL skills from 15 source repositories: - anthropics/skills: 16 (docs, design, MCP, testing) - obra/superpowers: 14 (TDD, debugging, agents, planning) - coreyhaines31/marketingskills: 25 (marketing, CRO, SEO, growth) - better-auth/skills: 5 (auth patterns) - vercel-labs/agent-skills: 5 (React, design, Vercel) - antfu/skills: 16 (Vue, Vite, Vitest, pnpm, Turborepo) - Plus 13 individual skills from various repos Mosaic Stack is not limited to coding — the Orchestrator and subagents serve coding, business, design, marketing, writing, logistics, analysis, and more. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
176
skills/vueuse-functions/references/onKeyStroke.md
Normal file
176
skills/vueuse-functions/references/onKeyStroke.md
Normal file
@@ -0,0 +1,176 @@
|
||||
---
|
||||
category: Sensors
|
||||
---
|
||||
|
||||
# onKeyStroke
|
||||
|
||||
Listen for keyboard keystrokes.
|
||||
|
||||
## Usage
|
||||
|
||||
```ts
|
||||
import { onKeyStroke } from '@vueuse/core'
|
||||
|
||||
onKeyStroke('ArrowDown', (e) => {
|
||||
e.preventDefault()
|
||||
})
|
||||
```
|
||||
|
||||
See [this table](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values) for all key codes.
|
||||
|
||||
### Listen To Multiple Keys
|
||||
|
||||
```ts
|
||||
import { onKeyStroke } from '@vueuse/core'
|
||||
|
||||
onKeyStroke(['s', 'S', 'ArrowDown'], (e) => {
|
||||
e.preventDefault()
|
||||
})
|
||||
|
||||
// listen to all keys by [true / skip the keyDefine]
|
||||
onKeyStroke(true, (e) => {
|
||||
e.preventDefault()
|
||||
})
|
||||
onKeyStroke((e) => {
|
||||
e.preventDefault()
|
||||
})
|
||||
```
|
||||
|
||||
### Custom Event Target
|
||||
|
||||
```ts
|
||||
import { onKeyStroke } from '@vueuse/core'
|
||||
// ---cut---
|
||||
onKeyStroke('A', (e) => {
|
||||
console.log('Key A pressed on document')
|
||||
}, { target: document })
|
||||
```
|
||||
|
||||
### Ignore Repeated Events
|
||||
|
||||
The callback will trigger only once when pressing `A` and **hold down**.
|
||||
|
||||
```ts
|
||||
import { onKeyStroke } from '@vueuse/core'
|
||||
// ---cut---
|
||||
// use `autoRepeat` option
|
||||
onKeyStroke('A', (e) => {
|
||||
console.log('Key A pressed')
|
||||
}, { dedupe: true })
|
||||
```
|
||||
|
||||
Reference: [KeyboardEvent.repeat](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/repeat)
|
||||
|
||||
## Directive Usage
|
||||
|
||||
```vue
|
||||
<script setup lang="ts">
|
||||
import { vOnKeyStroke } from '@vueuse/components'
|
||||
|
||||
function onUpdate(e: KeyboardEvent) {
|
||||
// impl...
|
||||
}
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<input v-on-key-stroke:c,v="onUpdate" type="text">
|
||||
<!-- with options -->
|
||||
<input v-on-key-stroke:c,v="[onUpdate, { eventName: 'keyup' }]" type="text">
|
||||
</template>
|
||||
```
|
||||
|
||||
### Custom Keyboard Event
|
||||
|
||||
```ts
|
||||
import { onKeyStroke } from '@vueuse/core'
|
||||
// ---cut---
|
||||
onKeyStroke('Shift', (e) => {
|
||||
console.log('Shift key up')
|
||||
}, { eventName: 'keyup' })
|
||||
```
|
||||
|
||||
Or
|
||||
|
||||
```ts
|
||||
import { onKeyUp } from '@vueuse/core'
|
||||
// ---cut---
|
||||
onKeyUp('Shift', () => console.log('Shift key up'))
|
||||
```
|
||||
|
||||
## Shorthands
|
||||
|
||||
- `onKeyDown` - alias for `onKeyStroke(key, handler, {eventName: 'keydown'})`
|
||||
- `onKeyPressed` - alias for `onKeyStroke(key, handler, {eventName: 'keypress'})`
|
||||
- `onKeyUp` - alias for `onKeyStroke(key, handler, {eventName: 'keyup'})`
|
||||
|
||||
## Type Declarations
|
||||
|
||||
```ts
|
||||
export type KeyPredicate = (event: KeyboardEvent) => boolean
|
||||
export type KeyFilter = true | string | string[] | KeyPredicate
|
||||
export type KeyStrokeEventName = "keydown" | "keypress" | "keyup"
|
||||
export interface OnKeyStrokeOptions {
|
||||
eventName?: KeyStrokeEventName
|
||||
target?: MaybeRefOrGetter<EventTarget | null | undefined>
|
||||
passive?: boolean
|
||||
/**
|
||||
* Set to `true` to ignore repeated events when the key is being held down.
|
||||
*
|
||||
* @default false
|
||||
*/
|
||||
dedupe?: MaybeRefOrGetter<boolean>
|
||||
}
|
||||
/**
|
||||
* Listen for keyboard keystrokes.
|
||||
*
|
||||
* @see https://vueuse.org/onKeyStroke
|
||||
*/
|
||||
export declare function onKeyStroke(
|
||||
key: KeyFilter,
|
||||
handler: (event: KeyboardEvent) => void,
|
||||
options?: OnKeyStrokeOptions,
|
||||
): () => void
|
||||
export declare function onKeyStroke(
|
||||
handler: (event: KeyboardEvent) => void,
|
||||
options?: OnKeyStrokeOptions,
|
||||
): () => void
|
||||
/**
|
||||
* Listen to the keydown event of the given key.
|
||||
*
|
||||
* @see https://vueuse.org/onKeyStroke
|
||||
* @param key
|
||||
* @param handler
|
||||
* @param options
|
||||
*/
|
||||
export declare function onKeyDown(
|
||||
key: KeyFilter,
|
||||
handler: (event: KeyboardEvent) => void,
|
||||
options?: Omit<OnKeyStrokeOptions, "eventName">,
|
||||
): () => void
|
||||
/**
|
||||
* Listen to the keypress event of the given key.
|
||||
*
|
||||
* @see https://vueuse.org/onKeyStroke
|
||||
* @param key
|
||||
* @param handler
|
||||
* @param options
|
||||
*/
|
||||
export declare function onKeyPressed(
|
||||
key: KeyFilter,
|
||||
handler: (event: KeyboardEvent) => void,
|
||||
options?: Omit<OnKeyStrokeOptions, "eventName">,
|
||||
): () => void
|
||||
/**
|
||||
* Listen to the keyup event of the given key.
|
||||
*
|
||||
* @see https://vueuse.org/onKeyStroke
|
||||
* @param key
|
||||
* @param handler
|
||||
* @param options
|
||||
*/
|
||||
export declare function onKeyUp(
|
||||
key: KeyFilter,
|
||||
handler: (event: KeyboardEvent) => void,
|
||||
options?: Omit<OnKeyStrokeOptions, "eventName">,
|
||||
): () => void
|
||||
```
|
||||
Reference in New Issue
Block a user