kbd-egui 0.1.0

egui bridge for kbd — converts egui key events and modifiers to kbd types.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

# kbd-egui

[![crates.io](https://img.shields.io/crates/v/kbd-egui.svg)](https://crates.io/crates/kbd-egui)
[![docs.rs](https://docs.rs/kbd-egui/badge.svg)](https://docs.rs/kbd-egui)

[`kbd`](https://crates.io/crates/kbd) bridge for [egui](https://docs.rs/egui) — converts key events and modifiers to `kbd` types.

This lets GUI key events (from egui) and global hotkey events (from [`kbd-global`](https://docs.rs/kbd-global)) feed into the same `Dispatcher`. Useful in egui apps that want both in-window shortcuts and system-wide hotkeys handled through a single hotkey registry.

Egui has a smaller, custom key enum that is not 1:1 with the W3C specification — some egui keys are logical/shifted characters without a single physical key equivalent (e.g., `Colon`, `Pipe`, `Plus`), and those return `None`.

```toml
[dependencies]
kbd = "0.1"
kbd-egui = "0.1"
```

## Extension traits

- **`EguiKeyExt`** — converts an `egui::Key` to a `kbd::key::Key`
- **`EguiModifiersExt`** — converts `egui::Modifiers` to a `Vec<Modifier>`
- **`EguiEventExt`** — converts a full `egui::Event` keyboard event to a `kbd::hotkey::Hotkey`

## Usage

```rust
use egui::{Key as EguiKey, Modifiers};
use kbd::prelude::*;
use kbd_egui::{EguiEventExt, EguiKeyExt, EguiModifiersExt};

let key = EguiKey::A.to_key();
assert_eq!(key, Some(Key::A));

let event = egui::Event::Key {
    key: EguiKey::C,
    physical_key: None,
    pressed: true,
    repeat: false,
    modifiers: Modifiers::CTRL,
};
let hotkey = event.to_hotkey();
assert_eq!(hotkey, Some(Hotkey::new(Key::C).modifier(Modifier::Ctrl)));
```

## Key mapping

| egui | kbd | Notes |
|---|---|---|
| `Key::A` – `Key::Z` | `Key::A` – `Key::Z` | Letters |
| `Key::Num0` – `Key::Num9` | `Key::DIGIT0` – `Key::DIGIT9` | Digits |
| `Key::F1` – `Key::F35` | `Key::F1` – `Key::F35` | Function keys |
| `Key::Minus`, `Key::Period`, … | `Key::MINUS`, `Key::PERIOD`, … | Physical-position punctuation |
| `Key::ArrowDown`, `Key::Enter`, … | `Key::ARROW_DOWN`, `Key::ENTER`, … | Navigation / editing |
| `Key::Copy`, `Key::Cut`, `Key::Paste` | `Key::COPY`, `Key::CUT`, `Key::PASTE` | Clipboard |
| `Key::Colon`, `Key::Pipe`, `Key::Plus`, … | `None` | Logical/shifted — no single physical key |

## Modifier mapping

| egui | kbd | Notes |
|---|---|---|
| `ctrl` | `Modifier::Ctrl` | |
| `shift` | `Modifier::Shift` | |
| `alt` | `Modifier::Alt` | |
| `mac_cmd` | `Modifier::Super` | Avoids double-counting with `command` on macOS |

## License

kbd-egui is licensed under the MIT license. See the [`LICENSE`](../../LICENSE) file for more information.