Updated Layouts (markdown)

BlackyHawky 2024-10-09 10:05:17 +02:00
parent 5776e6e7c0
commit d8c01d904f

@ -197,8 +197,29 @@ Usually the label is what is displayed on the key. However, there are some speci
</details> </details>
* In case a label clashes with the text you want to add, put a `\\` in front of the text you want, e.g. `{ "label": "\\space" }` will write the label `space` instead of adding a space bar. * In case a label clashes with the text you want to add, put `\\` in front of the text you want, e.g. `{ "label": "\\space" }` will write the label `space` instead of adding a space bar.
* Note that you need to escape the `\` in json files by adding a second `\`. * Note that you need to escape the `\` in json files by adding a second `\`. <br>
This means:
* If you wish to add `\` character, you must add a second `\` in json files
* The same applies to the `"` character: you must add a `\` in json files
<br><br>
<details>
<summary><b><i>Click to see example with `\` character</i></b></summary>
<br>
```json
// The `\` character is displayed on the key
{ "label": "\\", "width": 0.1, "type": "normal", "popup": { "relevant":
[
// The `"` character is displayed in the popup
{ "label": "\"" }
] }
},
// The word `space` is displayed on the key
{ "label": "\\space", "width": 0.1 }
```
</details>
* If you want different key label and input text, set the label to [label]|[text], e.g. `{ "label": "aa|bb" }` will show `aa` on the key, but pressing it will input `bb`. * If you want different key label and input text, set the label to [label]|[text], e.g. `{ "label": "aa|bb" }` will show `aa` on the key, but pressing it will input `bb`.
* You can also specify special key codes like `{ "label": "a|!code/key_shift" }` * You can also specify special key codes like `{ "label": "a|!code/key_shift" }`
@ -403,6 +424,25 @@ Here are the different classes:
</details> </details>
* Reminder: <br>
If you wish to add `\` character, you must add a second `\` in json files <br>
The same applies to the `"` character: you must add a `\` in json files
<details>
<summary><b><i>Click to see example with `\` character</i></b></summary>
<br>
```json
// The `\` character is displayed on the key
{ "label": "\\", "width": 0.1, "type": "normal", "popup": { "relevant":
[
// The `"` character is displayed in the popup
{ "label": "\"" }
] }
}
```
</details>
# Examples of JSON files # Examples of JSON files
[Here](https://github.com/Helium314/HeliBoard/discussions/1132#discussion-7260853) are some sample JSON files that customize all the keyboard views. [Here](https://github.com/Helium314/HeliBoard/discussions/1132#discussion-7260853) are some sample JSON files that customize all the keyboard views.