fix(onKeyStroke)!: rename type KeyStrokeOptions to `OnKeyStrokeOpti…

…ons` (#1807)
vueuse · Jul 10, 2022 · 57ed5e7 · 57ed5e7
1 parent 24edeaa
commit 57ed5e7
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/packages/core/onKeyStroke/directive.test.ts b/packages/core/onKeyStroke/directive.test.ts
@@ -3,7 +3,7 @@ import type { VueWrapper } from '@vue/test-utils'
 import { mount } from '@vue/test-utils'
 
 import { vOnKeyStroke } from './directive'
-import type { KeyStrokeOptions } from '.'
+import type { OnKeyStrokeOptions } from '.'
 
 const App = defineComponent({
   props: {
@@ -51,7 +51,7 @@ describe('vOnKeyStroke', () => {
   describe('given options', () => {
     beforeEach(() => {
       onUpdate = vi.fn()
-      const options: KeyStrokeOptions = {
+      const options: OnKeyStrokeOptions = {
         passive: false,
       }
       wrapper = mount(App, {

diff --git a/packages/core/onKeyStroke/directive.ts b/packages/core/onKeyStroke/directive.ts
@@ -1,11 +1,11 @@
 import { directiveHooks } from '@vueuse/shared'
 import type { ObjectDirective } from 'vue-demi'
-import type { KeyStrokeOptions } from '.'
+import type { OnKeyStrokeOptions } from '.'
 import { onKeyStroke } from '.'
 
 type BindingValueFunction = (event: KeyboardEvent) => void
 
-type BindingValueArray = [BindingValueFunction, KeyStrokeOptions]
+type BindingValueArray = [BindingValueFunction, OnKeyStrokeOptions]
 
 export const vOnKeyStroke: ObjectDirective<
 HTMLElement,

diff --git a/packages/core/onKeyStroke/index.ts b/packages/core/onKeyStroke/index.ts
@@ -5,7 +5,7 @@ import { defaultWindow } from '../_configurable'
 export type KeyPredicate = (event: KeyboardEvent) => boolean
 export type KeyFilter = null | undefined | string | string[] | KeyPredicate
 export type KeyStrokeEventName = 'keydown' | 'keypress' | 'keyup'
-export interface KeyStrokeOptions {
+export interface OnKeyStrokeOptions {
   eventName?: KeyStrokeEventName
   target?: MaybeComputedRef<EventTarget>
   passive?: boolean
@@ -36,7 +36,7 @@ const createKeyPredicate = (keyFilter: KeyFilter): KeyPredicate => {
  * @param handler
  * @param options
  */
-export function onKeyStroke(key: KeyFilter, handler: (event: KeyboardEvent) => void, options: KeyStrokeOptions = {}) {
+export function onKeyStroke(key: KeyFilter, handler: (event: KeyboardEvent) => void, options: OnKeyStrokeOptions = {}) {
   const { target = defaultWindow, eventName = 'keydown', passive = false } = options
   const predicate = createKeyPredicate(key)
   const listener = (e: KeyboardEvent) => {
@@ -55,7 +55,7 @@ export function onKeyStroke(key: KeyFilter, handler: (event: KeyboardEvent) => v
  * @param handler
  * @param options
  */
-export function onKeyDown(key: KeyFilter, handler: (event: KeyboardEvent) => void, options: Omit<KeyStrokeOptions, 'eventName'> = {}) {
+export function onKeyDown(key: KeyFilter, handler: (event: KeyboardEvent) => void, options: Omit<OnKeyStrokeOptions, 'eventName'> = {}) {
   return onKeyStroke(key, handler, { ...options, eventName: 'keydown' })
 }
 
@@ -67,7 +67,7 @@ export function onKeyDown(key: KeyFilter, handler: (event: KeyboardEvent) => voi
  * @param handler
  * @param options
  */
-export function onKeyPressed(key: KeyFilter, handler: (event: KeyboardEvent) => void, options: Omit<KeyStrokeOptions, 'eventName'> = {}) {
+export function onKeyPressed(key: KeyFilter, handler: (event: KeyboardEvent) => void, options: Omit<OnKeyStrokeOptions, 'eventName'> = {}) {
   return onKeyStroke(key, handler, { ...options, eventName: 'keypress' })
 }
 
@@ -79,6 +79,6 @@ export function onKeyPressed(key: KeyFilter, handler: (event: KeyboardEvent) =>
  * @param handler
  * @param options
  */
-export function onKeyUp(key: KeyFilter, handler: (event: KeyboardEvent) => void, options: Omit<KeyStrokeOptions, 'eventName'> = {}) {
+export function onKeyUp(key: KeyFilter, handler: (event: KeyboardEvent) => void, options: Omit<OnKeyStrokeOptions, 'eventName'> = {}) {
   return onKeyStroke(key, handler, { ...options, eventName: 'keyup' })
 }