Update docs + improve game logic in wasm

Author: rezigned

.github/workflows/github-pages.yml

@@ -1,9 +1,9 @@
-# From https://book.leptos.dev/deployment/csr.html#github-pages
+# See https://book.leptos.dev/deployment/csr.html#github-pages
 name: Release to Github Pages
 
 on:
   push:
-    branches: [main, add-wasm-backend]
+    branches: [main]
     paths:
       - 'examples/wasm/**'
   workflow_dispatch:

examples/wasm/src/main.rs

@@ -99,6 +99,7 @@ pub fn main() {
 
 pub fn handle_key_event(event: &KeyboardEvent, is_keydown: bool) {
     let config = derived_config();
+    let is_game_over = isGameOver();
 
     // Log the key that was pressed
     if is_keydown {
@@ -111,29 +112,21 @@ pub fn handle_key_event(event: &KeyboardEvent, is_keydown: bool) {
         setKey(key.to_string(), desc);
     }
 
-    if isGameOver() {
-        return;
-    }
-
     if let Some(action) = config.get(event) {
         match action {
-            Action::Jump => {
-                if is_keydown {
-                    jump()
-                }
-            }
-            Action::Left => moveLeft(is_keydown),
-            Action::Right => moveRight(is_keydown),
-            Action::Pause => {
-                if is_keydown {
-                    pauseGame()
-                }
-            }
             Action::Quit => {
                 if is_keydown {
                     resetGame();
                 }
             }
+            _ if !is_game_over => match action {
+                Action::Left => moveLeft(is_keydown),
+                Action::Right => moveRight(is_keydown),
+                Action::Jump if is_keydown => jump(),
+                Action::Pause if is_keydown => pauseGame(),
+                _ => {}
+            },
+            _ => {}
         }
     }
 }

src/backend/crossterm.rs

@@ -1,4 +1,4 @@
-//! Key event parsing and cnnversion for the `crossterm` backend.
+//! Key event parsing and conversion for the `crossterm` backend.
 //!
 //! This module bridges `crossterm::event::KeyEvent` with a backend-agnostic
 //! representation (`KeyMap`) used for keybinding configuration and matching.
@@ -13,6 +13,17 @@
 //! # Limitations
 //! - Some `KeyCode` variants are not supported and will return an error.
 //! - Key groups (e.g., `@any`) are not reversible to `KeyEvent` due to the loss of specificity.
+//!
+//! # Examples
+//!
+//! Parsing from a string:
+//! ```
+//! use crossterm::event::{KeyCode, KeyEvent, KeyModifiers};
+//! use keymap::backend::crossterm::parse;
+//!
+//! let key = parse("ctrl-a").unwrap();
+//! assert_eq!(key, KeyEvent::new(KeyCode::Char('a'), KeyModifiers::CONTROL));
+//! ```
 use crossterm::event::{KeyCode, KeyEvent, KeyModifiers};
 use keymap_parser::{self as parser, Key, Modifier, Node};
 

src/backend/termion.rs

@@ -1,8 +1,14 @@
-//! Key event parsing and cnnversion for the `termion` backend.
+//! Key event parsing and conversion for the `termion` backend.
 //!
-//! This module bridges `termion` key events with the generic `keymap` system,
-//! allowing `KeyEvent` to be parsed from string representations, converted into
-//! `KeyMap` nodes, and looked up in a `Config<T>` instance.
+//! This module bridges `termion::event::Key` with a backend-agnostic
+//! representation (`KeyMap`) used for keybinding configuration and matching.
+//! It enables parsing human-readable key definitions and converting between
+//! representations suitable for UI and configuration layers.
+//!
+//! # Key Features
+//! - `parse`: Parses a string key representation (e.g., "ctrl-a") into a `KeyEvent`.
+//! - Implements `IntoKeyMap`, `ToKeyMap`, and `FromKeyMap` for `KeyEvent`.
+//! - Converts between `KeyEvent` (from termion) and internal `KeyMap` format.
 //!
 //! # Limitations
 //! - Termion only supports `alt` and `ctrl` modifiers on character keys.
@@ -15,8 +21,8 @@
 //!
 //! Parsing from a string:
 //! ```
+//! use keymap::backend::termion::parse;
 //! use termion::event::Key as KeyEvent;
-//! use keymap::backend::parse;
 //!
 //! let key: KeyEvent = parse("ctrl-a").unwrap();
 //! assert_eq!(key, KeyEvent::Ctrl('a'));

src/backend/wasm.rs

@@ -13,6 +13,18 @@
 //! # Limitations
 //! - Some `KeyboardEvent` variants are not supported and will return an error.
 //! - Key groups (e.g., `@any`) are not reversible to `KeyboardEvent` due to the loss of specificity.
+//!
+//! # Examples
+//!
+//! Parsing from a string:
+//! ```
+//! use keymap::backend::wasm::parse;
+//! use web_sys::KeyboardEvent;
+//!
+//! let event = parse("alt-b").unwrap();
+//! assert_eq!(event.key(), "b");
+//! assert_eq!(event.alt_key(), true);
+//! ```
 use keymap_parser::{self as parser, Key, Modifier, Node};
 use web_sys::{KeyboardEvent, KeyboardEventInit};