chore: Move to Typescript (#2783)
This PR moves the entire project to Typescript. Due to the ~1000 ignores this will lead to a messy codebase for a while, but the churn is worth it – all of those ignore comments are places that were never type-safe previously. closes #1282
This commit is contained in:
72
app/hooks/useKeyDown.ts
Normal file
72
app/hooks/useKeyDown.ts
Normal file
@@ -0,0 +1,72 @@
|
||||
import * as React from "react";
|
||||
import isTextInput from "~/utils/isTextInput";
|
||||
|
||||
export type KeyFilter = ((event: KeyboardEvent) => boolean) | string;
|
||||
|
||||
type Callback = (event: KeyboardEvent) => void;
|
||||
|
||||
// Registered keyboard event callbacks
|
||||
let callbacks: Callback[] = [];
|
||||
|
||||
// Track if IME input suggestions are open so we can ignore keydown shortcuts
|
||||
// in this case, they should never be triggered from mobile keyboards.
|
||||
let imeOpen = false;
|
||||
|
||||
// Based on implementation in react-use
|
||||
// https://github.com/streamich/react-use/blob/master/src/useKey.ts#L15-L22
|
||||
const createKeyPredicate = (keyFilter: KeyFilter) =>
|
||||
typeof keyFilter === "function"
|
||||
? keyFilter
|
||||
: typeof keyFilter === "string"
|
||||
? (event: KeyboardEvent) =>
|
||||
event.key === keyFilter ||
|
||||
event.code === `Key${keyFilter.toUpperCase()}`
|
||||
: keyFilter
|
||||
? (_event: KeyboardEvent) => true
|
||||
: (_event: KeyboardEvent) => false;
|
||||
|
||||
export default function useKeyDown(key: KeyFilter, fn: Callback): void {
|
||||
const predicate = createKeyPredicate(key);
|
||||
|
||||
React.useEffect(() => {
|
||||
const handler = (event: KeyboardEvent) => {
|
||||
if (predicate(event)) {
|
||||
fn(event);
|
||||
}
|
||||
};
|
||||
|
||||
callbacks.push(handler);
|
||||
return () => {
|
||||
callbacks = callbacks.filter((cb) => cb !== handler);
|
||||
};
|
||||
}, []);
|
||||
}
|
||||
|
||||
window.addEventListener("keydown", (event) => {
|
||||
if (imeOpen) {
|
||||
return;
|
||||
}
|
||||
|
||||
// reverse so that the last registered callbacks get executed first
|
||||
for (const callback of callbacks.reverse()) {
|
||||
if (event.defaultPrevented === true) {
|
||||
break;
|
||||
}
|
||||
|
||||
if (
|
||||
!isTextInput(event.target as HTMLElement) ||
|
||||
event.ctrlKey ||
|
||||
event.metaKey
|
||||
) {
|
||||
callback(event);
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
window.addEventListener("compositionstart", () => {
|
||||
imeOpen = true;
|
||||
});
|
||||
|
||||
window.addEventListener("compositionend", () => {
|
||||
imeOpen = false;
|
||||
});
|
||||
Reference in New Issue
Block a user