Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(useKeyModifier)!: rename type ModifierOptions to UseModifierOptions #1871

Merged
merged 1 commit into from Jul 12, 2022
Merged

fix(useKeyModifier)!: rename type ModifierOptions to UseModifierOptions #1871

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 5 additions & 3 deletions packages/core/useKeyModifier/index.ts
View file
Open in desktop
Expand Up @@ -9,7 +9,7 @@ export type KeyModifier = 'Alt' | 'AltGraph' | 'CapsLock' | 'Control' | 'Fn' | '

const defaultEvents: WindowEventName[] = ['mousedown', 'mouseup', 'keydown', 'keyup']

export interface ModifierOptions<Initial> extends ConfigurableDocument {
export interface UseModifierOptions<Initial> extends ConfigurableDocument {
/**
* Event names that will prompt update to modifier states
*
Expand All @@ -25,7 +25,9 @@ export interface ModifierOptions<Initial> extends ConfigurableDocument {
initial?: Initial
}

export function useKeyModifier<Initial extends boolean | null>(modifier: KeyModifier, options: ModifierOptions<Initial> = {}) {
export type UseKeyModifierReturn<Initial> = Ref<Initial extends boolean ? boolean : boolean | null>

export function useKeyModifier<Initial extends boolean | null>(modifier: KeyModifier, options: UseModifierOptions<Initial> = {}): UseKeyModifierReturn<Initial> {
const {
events = defaultEvents,
document = defaultDocument,
Expand All @@ -43,5 +45,5 @@ export function useKeyModifier<Initial extends boolean | null>(modifier: KeyModi
})
}

return state as Ref<Initial extends boolean ? boolean : boolean | null>
return state
}