viks 1.0.1

vim-like key crate
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

# viks

vim-like key crate

## Usage

Parse string to `Key`:

```rs
use viks::Key;

let a_key = Key::new("a").unwrap();
let shift_a_key = Key::new("<s-a>").unwrap();
let shift_a_key_alt = Key::new("A").unwrap();

assert_eq!(shift_a_key, shift_a_key_alt);
```

---

Parse string to `Keymap`(wrapper for `Vec<Key>`):

```rs
use viks::Keymap;

let zz_map = Keymap::new("zz").unwrap();
let exit_map = Keymap::new("ZZ").unwrap();
let exit_map_alt = Keymap::new("<s-z><s-z>").unwrap();

assert_eq!(exit_map, exit_map_alt);
```

avaliable ascii characters.

### Mapping

Special tags:

| string                  | key                   |
| ----------------------- | --------------------- |
| `<enter>` or `<cr>`     | KeyCode::Enter        |
| `<tab>`                 | KeyCode::Tab          |
| `<esc>`                 | KeyCode::Esc          |
| `<leader>` or `<space>` | KeyCode::Space        |
| `<bs>`                  | KeyCode::Backspace    |
| `<del>`                 | KeyCode::Delete       |
| `<lt>`                  | KeyCode::LessThanSign |

Modifier tags:

| string | key                  |
| ------ | -------------------- |
| <s-{}> | KeyModifier::Shift   |
| <a-{}> | KeyModifier::Alt     |
| <c-{}> | KeyModifier::Control |

## LICENSE

MIT