docs: add page about modifiers

This commit is contained in:
Okke Formsma 2020-11-06 21:34:36 +01:00
parent 5d04110a58
commit 44fc770468
4 changed files with 37 additions and 7 deletions

View file

@ -22,10 +22,6 @@ import Table from "@site/src/components/codes/Table";
<Table group="keyboard-navigation" /> <Table group="keyboard-navigation" />
### Modifiers
<Table group="keyboard-modifiers" />
### Locks ### Locks
<Table group="keyboard-locks" /> <Table group="keyboard-locks" />

View file

@ -0,0 +1,33 @@
---
title: Modifiers
sidebar_label: Modifiers
---
import Table from "@site/src/components/codes/Table";
To add a modifier key like 'Control' to your board, use one of the codes from the following table.
If you want to send a modified key like ctrl+a, see the Modified keys section below.
### Modifier keys
<Table group="keyboard-modifiers" />
### Modified keys
To send a shifted key such as capital A (`LEFT_SHIFT` + `A`) use the `LS` macro: `&kp LS(A)`. You can also use the "right-hand" version of this macro, `RS`.
Control (`LC`, `RC`), Alt (`LA`,`RA`) and GUI (`LG`,`RG`) can be used in the same way. For example, to send ctrl+c, use `&kp LC(C)` or `&kp RC(C)`.
It's possible to combine modifiers: `&kp LC(RA(A))` will result in `LEFT_CONTROL` + `RIGHT_ALT` + `A` being pressed.
| Macro | Corresponding keycode |
| ----- | --------------------- |
| `LS` | `LEFT_SHIFT` |
| `RS` | `RIGHT_SHIFT` |
| `LC` | `LEFT_CONTROL` |
| `RC` | `RIGHT_CONTROL` |
| `LA` | `LEFT_ALT` |
| `RA` | `RIGHT_ALT` |
| `LG` | `LEFT_GUI` |
| `RG` | `RIGHT_GUI` |

View file

@ -135,7 +135,7 @@ that defines just one layer for this keymap:
bindings = < bindings = <
&kp ESC &kp Q &kp W &kp E &kp R &kp T &kp Y &kp U &kp I &kp O &kp P &kp BSLH &kp ESC &kp Q &kp W &kp E &kp R &kp T &kp Y &kp U &kp I &kp O &kp P &kp BSLH
&kp TAB &kp A &kp S &kp D &kp F &kp G &kp H &kp J &kp K &kp L &kp SEMI &kp QUOTE &kp TAB &kp A &kp S &kp D &kp F &kp G &kp H &kp J &kp K &kp L &kp SEMI &kp QUOTE
&kp LSHFT &kp Z &kp X &kp C &kp V &kp B &kp LSHFT &kp LSHFT &kp LSHFT &kp LSHFT &kp N &kp M &kp COMMA &kp DOT &kp FSLH &kp RCTRL &kp LSHFT &kp Z &kp X &kp C &kp V &kp B &kp LC(A) &kp LC(C) &kp LC(V) &kp LC(X) &kp N &kp M &kp COMMA &kp DOT &kp FSLH &kp RCTRL
&kp LGUI &kp DEL &kp RET &kp SPACE &kp ESC &kp RET &kp SPACE &kp TAB &kp BSPC &kp RALT &kp LGUI &kp DEL &kp RET &kp SPACE &kp ESC &kp RET &kp SPACE &kp TAB &kp BSPC &kp RALT
>; >;
@ -167,12 +167,12 @@ Putting this all together, a complete [`kyria.keymap`](https://github.com/zmkfir
// -------------------------------------------------------------------------------------------------------------------------------------------------------------------- // --------------------------------------------------------------------------------------------------------------------------------------------------------------------
// | ESC | Q | W | E | R | T | | Y | U | I | O | P | \ | // | ESC | Q | W | E | R | T | | Y | U | I | O | P | \ |
// | TAB | A | S | D | F | G | | H | J | K | L | ; | ' | // | TAB | A | S | D | F | G | | H | J | K | L | ; | ' |
// | SHIFT | Z | X | C | V | B | L SHIFT | L SHIFT | | L SHIFT | L SHIFT | N | M | , | . | / | R CTRL | // | SHIFT | Z | X | C | V | B | CTRL+A | CTRL+C | | CTRL+V | CTRL+X | N | M | , | . | / | R CTRL |
// | GUI | DEL | RETURN | SPACE | ESCAPE | | RETURN | SPACE | TAB | BSPC | R ALT | // | GUI | DEL | RETURN | SPACE | ESCAPE | | RETURN | SPACE | TAB | BSPC | R ALT |
bindings = < bindings = <
&kp ESC &kp Q &kp W &kp E &kp R &kp T &kp Y &kp U &kp I &kp O &kp P &kp BSLH &kp ESC &kp Q &kp W &kp E &kp R &kp T &kp Y &kp U &kp I &kp O &kp P &kp BSLH
&kp TAB &kp A &kp S &kp D &kp F &kp G &kp H &kp J &kp K &kp L &kp SEMI &kp QUOTE &kp TAB &kp A &kp S &kp D &kp F &kp G &kp H &kp J &kp K &kp L &kp SEMI &kp QUOTE
&kp LSHFT &kp Z &kp X &kp C &kp V &kp B &kp LSHFT &kp LSHFT &kp LSHFT &kp LSHFT &kp N &kp M &kp COMMA &kp DOT &kp FSLH &kp RCTRL &kp LSHFT &kp Z &kp X &kp C &kp V &kp B &kp LC(A) &kp LC(C) &kp LC(V) &kp LC(X) &kp N &kp M &kp COMMA &kp DOT &kp FSLH &kp RCTRL
&kp LGUI &kp DEL &kp RET &kp SPACE &kp ESC &kp RET &kp SPACE &kp TAB &kp BSPC &kp RALT &kp LGUI &kp DEL &kp RET &kp SPACE &kp ESC &kp RET &kp SPACE &kp TAB &kp BSPC &kp RALT
>; >;

View file

@ -29,6 +29,7 @@ module.exports = {
Codes: [ Codes: [
"codes/index", "codes/index",
"codes/keyboard-keypad", "codes/keyboard-keypad",
"codes/modifiers",
"codes/editing", "codes/editing",
"codes/media", "codes/media",
"codes/applications", "codes/applications",