-
-
Notifications
You must be signed in to change notification settings - Fork 89
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: ♻️ ref based navigation (#346)
* refactor: ♻️ ref based navigation * refactor: ♻️ zero dependency * refactor: ♻️ fixed search * docs: 📝 updated documentation
- Loading branch information
1 parent
80eae41
commit 0db6569
Showing
21 changed files
with
583 additions
and
411 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| /* | ||
| * copied from https://github.com/imbhargav5/rooks/blob/master/packages/shared/useKeyRef.ts | ||
| */ | ||
|
|
||
| import { Ref, useEffect, useCallback, useRef, useMemo } from "react"; | ||
|
|
||
| interface Options { | ||
| /** | ||
| * Condition which if true, will enable the event listeners | ||
| */ | ||
| when?: boolean; | ||
| /** | ||
| * Keyboardevent types to listen for. Valid options are keyDown, keyPress and keyUp | ||
| */ | ||
| eventTypes?: Array<string | number>; | ||
| /** | ||
| * target ref on which the events should be listened. If no target is specified, | ||
| * events are listened to on the window | ||
| */ | ||
| target?: Ref<HTMLElement> | null; | ||
| } | ||
|
|
||
| const defaultOptions = { | ||
| when: true, | ||
| eventTypes: ["keydown"], | ||
| }; | ||
|
|
||
| /** | ||
| * useKey hook | ||
| * | ||
| * Fires a callback on keyboard events like keyDown, keyPress and keyUp | ||
| * | ||
| * @param {[string|number]} keyList | ||
| * @param {function} callback | ||
| * @param {Options} options | ||
| */ | ||
| function useKey( | ||
| input: string | number | Array<string | number>, | ||
| callback: (e: KeyboardEvent) => any, | ||
| opts?: Options | ||
| ): void { | ||
| const keyList: Array<string | number> = useMemo( | ||
| () => (Array.isArray(input) ? input : [input]), | ||
| [input] | ||
| ); | ||
| const options = Object.assign({}, defaultOptions, opts); | ||
| const { when, eventTypes } = options; | ||
| const callbackRef = useRef<(e: KeyboardEvent) => any>(callback); | ||
| let { target } = options; | ||
|
|
||
| useEffect(() => { | ||
| callbackRef.current = callback; | ||
| }); | ||
|
|
||
| const handle = useCallback( | ||
| (e: KeyboardEvent) => { | ||
| if (keyList.some((k) => e.key === k || e.code === k)) { | ||
| callbackRef.current(e); | ||
| } | ||
| }, | ||
| [keyList] | ||
| ); | ||
|
|
||
| useEffect((): any => { | ||
| if (when && typeof window !== "undefined") { | ||
| const targetNode = target ? target["current"] : window; | ||
| eventTypes.forEach((eventType) => { | ||
| targetNode && targetNode.addEventListener(eventType, handle); | ||
| }); | ||
| return () => { | ||
| eventTypes.forEach((eventType) => { | ||
| targetNode && targetNode.removeEventListener(eventType, handle); | ||
| }); | ||
| }; | ||
| } | ||
| }, [when, eventTypes, keyList, target, callback]); | ||
| } | ||
|
|
||
| export { useKey }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| export const KEY = { | ||
| ARROW_DOWN: "ArrowDown", | ||
| ARROW_UP: "ArrowUp", | ||
| ENTER: "Enter", | ||
| ESCAPE: "Escape", | ||
| SPACE: "Space", | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.