github / github/hotkey

API alterations to allow injection of hotkey parsing and event processing

Aperta
#69 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
JavaScript
Stelle
3.3k
Fork
99
Merge medio
14h 22m
PR unite (30g)
6

Descrizione

I think a useful migration strategy would be to allow serialization/comparison to be overridden as part of the API.

When we talk about what this library does that is "novel" (as in, something you cannot _reasonably achieve_ in a few LOC locally) the library does three things:

- It manages many shortcuts by implementing a Radix Trie.
- It manages event listening & dispatch avoiding footguns: for example delegated events, ensuring hotkeys aren't fired on form fields, etc.
- It provides the above with a simple `install`/`uninstall` API to simplify adding/removing event listeners and state from the Radix Trie.
- It comes up with some lose specification of how to expand/compare hotkey strings to decide when to fire a hotkey combo.

The last one is what causes us a lot of trouble and causes some trashing in this library. `radix-trie.ts` hasn't been touched in 9 months, prior to that 2 years ago. I'd say `radix-trie` is "feature complete". Meanwhile `hotkey.ts` has a regular cadence of alterations every few months as we reach edge cases and scale our use of this library.

The chief problems with the serialization format are:

- It is a psuedo specification. There's no formal set of possible values or a well defined grammar or spec. It is an ad-hoc grammar using RegExps. While this works fine for the most part, it is a source of bugs and confusion, as well as differences of opinion.
- It doesn't properly encode all of the state about what we as developers _intend_ shortcuts to be. We've discussed this quite a lot synchronously; the concept of "logical" (`WSAD`) vs "Semiotic" (`?`) shortcuts.

Effectively the serialization of these shortcuts is, what you might call, unsolved. So I say let's make that apparent by allowing it to be overridden in the API.

The current API is as follows:

```typescript
export install(element: HTMLElement, hotkey?: string): void {}
export uninstall(element: HTMLElement): void {}
```

I propose we expand this to the following:

```typescript
export type ProcessHotkey = (hotkey: string): string[][]
export type ProcessEvent = (event: KeyboardEvent): string

export class HotkeyManager {
constructor(
processHotkey: ProcessHotkey = expandHotkeyToEdges,
processEvent: ProcessEvent = eventToHotkeyString
)

install(element: HTMLelement, hotkey?: string): void {}

uninstall(element: HTMLElement): void {}
}

const defaultManager = new HotkeyManager()
export const install = defaultManager.install
export const uninstall = defaultManager.uninstall
```

By making a class, we can define custom processing for shortcut keys which allows users to define their own shortcut models, but also allows us to make more breaking changes behind experimental APIs, and even feature flag them. By still exposing the `install`/`uninstall` functions per the existing API, we ensure backwards compatibility which minimizes breaking changes, and allows us to "make the hard change easy then make the easy change". A 2.0 change could effectively swap the default hotkey functions out for the newer API, as a one line change.

Thoughts @github/ui-frameworks?

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Start by reading hotkey.ts and radix-trie.ts, then compare the current install/uninstall API with the proposed HotkeyManager, ProcessHotkey, and ProcessEvent interfaces. Determine how custom serialization and event processing would integrate without changing the existing default exports; done means the API design and compatibility behavior are agreed and implemented.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
typescript
Ambito
frontend
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.