Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add keybind mode & text section #430

Merged
merged 1 commit into from
Jan 22, 2024
Merged

docs: add keybind mode & text section #430

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
197 changes: 103 additions & 94 deletions docs/docs/key-bindings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,118 +7,96 @@ language: 'en'

### MacOS

Open configuration: `Command + Comma (,)`

Toggle VI Mode: `Alt + Shift + Space`

Copy: `Command + C`

Paste: `Command + V`

Create new window: `Command + N`

Create new tab: `Command + T`

Move to next tab: `Control + Tab` or `Command + Shift + RightBracket (])`

Move to previous tab: `Control + Shift + Tab` or `Command + Shift + LeftBracket ([)`

Increase font size: `Command + Plus (+)`

Decrease font size: `Command + Minus (-)`

Reset font size: `Command + 0`

Minimize window: `Command + M`

Quit: `Command + Q`

Close tab: `Command + W`

Select the first tab: `Command + 1`

Select the second tab: `Command + 2`

Select the third tab: `Command + 3`

Select the fourth tab: `Command + 4`

Select the fifth tab: `Command + 5`

Select the sixth tab: `Command + 6`

Select the seventh tab: `Command + 7`

Select the eighth tab: `Command + 8`

Select the last tab: `Command + 9`
| Action | Key |
| ---------------------- | -------------------------------------------------------------- |
| Open configuration | `Command + Comma (,)` |
| Toggle VI Mode | `Alt + Shift + Space` |
| Copy | `Command + C` |
| Paste | `Command + V` |
| Create new window | `Command + N` |
| Create new tab | `Command + T` |
| Move to next tab | `Control + Tab` or `Command + Shift + RightBracket (])` |
| Move to previous tab | `Control + Shift + Tab` or `Command + Shift + LeftBracket ([)` |
| Increase font size | `Command + Plus (+)` |
| Decrease font size | `Command + Minus (-)` |
| Reset font size | `Command + 0` |
| Minimize window | `Command + M` |
| Quit | `Command + Q` |
| Close tab | `Command + W` |
| Select the first tab | `Command + 1` |
| Select the second tab | `Command + 2` |
| Select the third tab | `Command + 3` |
| Select the fourth tab | `Command + 4` |
| Select the fifth tab | `Command + 5` |
| Select the sixth tab | `Command + 6` |
| Select the seventh tab | `Command + 7` |
| Select the eighth tab | `Command + 8` |
| Select the last tab | `Command + 9` |

### Windows

Open configuration: `Control + Shift + Comma (,)`

Toggle VI Mode: `Alt + Shift + Space`

Copy: `Control + Shift + C`

Paste: `Control + Shift + V`

Create new window: `Control + Shift + N`

Create new tab: `Control + Shift + T`

Move to next tab: `Control + Tab` or `Control + Shift + RightBracket (])`

Move to previous tab: `Control + Shift + Tab` `Control + Shift + LeftBracket ([)`

Increase font size: `Control + Plus (+)`

Decrease font size: `Control + Minus (-)`

Reset font size: `Control + 0`

Close tab or quit: `Control + Shift + W`
| Action | Key |
| -------------------- | ----------------------------------------------------------- |
| Open configuration | `Control + Shift + Comma (,)` |
| Toggle VI Mode | `Alt + Shift + Space` |
| Copy | `Control + Shift + C` |
| Paste | `Control + Shift + V` |
| Create new window | `Control + Shift + N` |
| Create new tab | `Control + Shift + T` |
| Move to next tab | `Control + Tab` or `Control + Shift + RightBracket (])` |
| Move to previous tab | `Control + Shift + Tab` `Control + Shift + LeftBracket ([)` |
| Increase font size | `Control + Plus (+)` |
| Decrease font size | `Control + Minus (-)` |
| Reset font size | `Control + 0` |
| Close tab or quit | `Control + Shift + W` |

### Linux and BSD

Open configuration: `Control + Shift + Comma (,)`

Toggle VI Mode: `Alt + Shift + Space`

Copy: `Control + Shift + C`

Paste: `Control + Shift + V`

Create new window: `Control + Shift + N`

Create new tab: `Control + Shift + T`

Move to next tab:`Control + Tab` or `Control + Shift + RightBracket (])`

Move to previous tab: `Control + Shift + Tab` or `Control + Shift + LeftBracket ([)`
| Action | Key |
| -------------------- | -------------------------------------------------------------- |
| Open configuration | `Control + Shift + Comma (,)` |
| Toggle VI Mode | `Alt + Shift + Space` |
| Copy | `Control + Shift + C` |
| Paste | `Control + Shift + V` |
| Create new window | `Control + Shift + N` |
| Create new tab | `Control + Shift + T` |
| Move to next tab | `Control + Tab` or `Control + Shift + RightBracket (])` |
| Move to previous tab | `Control + Shift + Tab` or `Control + Shift + LeftBracket ([)` |
| Increase font size | `Control + Plus (+)` |
| Decrease font size | `Control + Minus (-)` |
| Reset font size | `Control + 0` |
| Close tab or quit | `Control + Shift + W` |

Increase font size: `Control + Plus (+)`

Decrease font size: `Control + Minus (-)`
<br/>

Reset font size: `Control + 0`
## [Custom key bindings](#custom-key-bindings)

Close tab or quit: `Control + Shift + W`
Rio allows you to add new keybindings and overwrite any default key bindings.

<br/>
Keybinds are built using the following trigger fields:

## [Custom key bindings](#custom-key-bindings)
| Name | Description |
| ------------- | --------------- |
| [key](#key) | The key pressed |
| [with](#with) | Modifier keys |
| [mode](#mode) | Terminal mode |

Rio also allow you to add key bindings per configuration or ovewritte any default key bindings listed above.
Whom can be be combined with the following effect fields:

To achieve it you will need to change your configuration file with the key binding rules.
| Name | Description |
| ----------------- | ---------------------- |
| [action](#action) | Predefined Rio actions |
| [bytes](#bytes) | Write byte sequence |
| [text](#text) | Write text sequence |

```toml
[bindings]
keys = [
{ key = "q", with = "super", action = "Quit" }
{ key = "q", with = "super", action = "Quit" },
# Bytes[27, 91, 53, 126] is equivalent to "\x1b[5~"
{ key = "home", with = "super | shift", bytes = [27, 91, 53, 126] }
{ key = "home", with = "super | shift", bytes = [27, 91, 53, 126] },
# Remove existing keybind
{ key = "v", with = "control | shift", action = "none" },
]
```

Expand Down Expand Up @@ -230,6 +208,37 @@ with = "control | shift"
A `~` operator can be used before a mode to apply the binding whenever
the mode is *not* active, e.g. `~Alt`. -->

### [Mode](#mode)

There is currently four different modes:

- `vi`
- `alt` (Alt screen)
- `appcursor`
- `appkeypad`

`~` can be prefixed to disable the keybind while in that mode.

```toml
[bindings]
keys = [
# Enable VI mode on escape, when not in VI mode.
{ key = "esc", mode = "~vi", action = "ToggleVIMode" },
]
```

### [Text](#text)

`text` can be used to write specific text on key press:

```toml
[bindings]
keys = [
# Write `Rio is awesome!` on `Control + r`
{ key = "r", with = "control", text = "Rio is awesome!" },
]
```

### [Overwriting](#overwriting)

Bindings are always filled by default, but will be replaced when a new binding with the same triggers is defined. To unset a default binding, it can be mapped to the `ReceiveChar` action. Alternatively, you can use `None` for a no-op if you do not wish to receive input characters for that binding.
Expand Down
Loading