feat(version): versions

1 files changed, 148 insertions, 0 deletions

diff --git a/src/templates/assets/javascripts/browser/keyboard/index.ts b/src/templates/assets/javascripts/browser/keyboard/index.ts
new file mode 100644
index 00000000..783f2cda
--- /dev/null
+++ b/src/templates/assets/javascripts/browser/keyboard/index.ts
@@ -0,0 +1,148 @@
+/*
+ * Copyright (c) 2016-2023 Martin Donath <martin.donath@squidfunk.com>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to
+ * deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+ * sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+ * IN THE SOFTWARE.
+ */
+
+import {
+  EMPTY,
+  Observable,
+  filter,
+  fromEvent,
+  map,
+  merge,
+  share,
+  startWith,
+  switchMap
+} from "rxjs"
+
+import { getActiveElement } from "../element"
+import { getToggle } from "../toggle"
+
+/* ----------------------------------------------------------------------------
+ * Types
+ * ------------------------------------------------------------------------- */
+
+/**
+ * Keyboard mode
+ */
+export type KeyboardMode =
+  | "global"                           /* Global */
+  | "search"                           /* Search is open */
+
+/* ------------------------------------------------------------------------- */
+
+/**
+ * Keyboard
+ */
+export interface Keyboard {
+  mode: KeyboardMode                   /* Keyboard mode */
+  type: string                         /* Key type */
+  claim(): void                        /* Key claim */
+}
+
+/* ----------------------------------------------------------------------------
+ * Helper functions
+ * ------------------------------------------------------------------------- */
+
+/**
+ * Check whether an element may receive keyboard input
+ *
+ * @param el - Element
+ * @param type - Key type
+ *
+ * @returns Test result
+ */
+function isSusceptibleToKeyboard(
+  el: HTMLElement, type: string
+): boolean {
+  switch (el.constructor) {
+
+    /* Input elements */
+    case HTMLInputElement:
+      /* @ts-expect-error - omit unnecessary type cast */
+      if (el.type === "radio")
+        return /^Arrow/.test(type)
+      else
+        return true
+
+    /* Select element and textarea */
+    case HTMLSelectElement:
+    case HTMLTextAreaElement:
+      return true
+
+    /* Everything else */
+    default:
+      return el.isContentEditable
+  }
+}
+
+/* ----------------------------------------------------------------------------
+ * Functions
+ * ------------------------------------------------------------------------- */
+
+/**
+ * Watch composition events
+ *
+ * @returns Composition observable
+ */
+export function watchComposition(): Observable<boolean> {
+  return merge(
+    fromEvent(window, "compositionstart").pipe(map(() => true)),
+    fromEvent(window, "compositionend").pipe(map(() => false))
+  )
+    .pipe(
+      startWith(false)
+    )
+}
+
+/**
+ * Watch keyboard
+ *
+ * @returns Keyboard observable
+ */
+export function watchKeyboard(): Observable<Keyboard> {
+  const keyboard$ = fromEvent<KeyboardEvent>(window, "keydown")
+    .pipe(
+      filter(ev => !(ev.metaKey || ev.ctrlKey)),
+      map(ev => ({
+        mode: getToggle("search") ? "search" : "global",
+        type: ev.key,
+        claim() {
+          ev.preventDefault()
+          ev.stopPropagation()
+        }
+      } as Keyboard)),
+      filter(({ mode, type }) => {
+        if (mode === "global") {
+          const active = getActiveElement()
+          if (typeof active !== "undefined")
+            return !isSusceptibleToKeyboard(active, type)
+        }
+        return true
+      }),
+      share()
+    )
+
+  /* Don't emit during composition events - see https://bit.ly/3te3Wl8 */
+  return watchComposition()
+    .pipe(
+      switchMap(active => !active ? keyboard$ : EMPTY)
+    )
+}