add: layouts H/VContainer and Text widget descriptions

2024-11-15 21:09:11 +01:00
parent 5bab829b3a
commit ab8798806e
3 changed files with 24 additions and 5 deletions

@@ -5,19 +5,29 @@
The following Layouts are provided by `zterm`: The following Layouts are provided by `zterm`:
- `VContainer`
- `VStack` - `VStack`
- `HContainer`
- `HStack` - `HStack`
- `Padding` - `Padding`
- `Margin` - `Margin`
- `Framing` - `Framing`
# VContainer
Vertical container for sized elements.
# VStack # VStack
Vertical stacking of contained elements. Vertical stacking of contained elements. Essentially a `VContainer` where every element has equivalent size.
# HContainer
Horizontal container for sized elements.
# HStack # HStack
Horizontal stacking of contained elements. Horizontal stacking of contained elements. Essentially a `HContainer` where every element has equivalent size.
# Padding # Padding

@@ -2,9 +2,14 @@
The following `Widget`'s are provided by `zterm`: The following `Widget`'s are provided by `zterm`:
- `Text`
- `RawText` - `RawText`
- `Spacer` - `Spacer`
# Text
Static display of provided `Cell` array, which allows for styling (e.g. coloring of text, decoration of text, etc.) of displayed contents.
# RawText # RawText
Pager `Widget` for the provided file. Mainly used for Debugging purposes. Pager `Widget` for the provided file. Mainly used for Debugging purposes.

@@ -1,3 +1,7 @@
Welcome to the Wiki Documentation for **zterm**. Welcome to the Wiki Documentation for **zterm**.
This wiki contains documentation about the built-in `App.Layout`'s and `App.Widget`'s and how to write own `Layout` and `Widget` types. This wiki contains documentation about the built-in `App.Layout`'s and `App.Widget`'s and how to write own `Layout` and `Widget` types.
For example implementations see [examples](https://gitea.yves-biener.de/yves-biener/zterm/src/branch/main/examples).
You can clone this repository and run `zig build --release=fast` to build the example applications in release mode and run them to test them out on your machine.