diff --git a/Built-in Layouts.-.md b/Built-in Layouts.-.md index 261ef36..e448ed8 100644 --- a/Built-in Layouts.-.md +++ b/Built-in Layouts.-.md @@ -5,19 +5,29 @@ The following Layouts are provided by `zterm`: +- `VContainer` - `VStack` +- `HContainer` - `HStack` - `Padding` - `Margin` - `Framing` +# VContainer + +Vertical container for sized elements. + # 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 -Horizontal stacking of contained elements. +Horizontal stacking of contained elements. Essentially a `HContainer` where every element has equivalent size. # Padding @@ -29,4 +39,4 @@ Provide relative (percentual) margins for the contained single element. # Framing -Provide a frame (stylable through configuration parameter) for the contained single element. \ No newline at end of file +Provide a frame (stylable through configuration parameter) for the contained single element. diff --git a/Built-in Widgets.-.md b/Built-in Widgets.-.md index b0ab3ae..9b5c67d 100644 --- a/Built-in Widgets.-.md +++ b/Built-in Widgets.-.md @@ -2,13 +2,18 @@ The following `Widget`'s are provided by `zterm`: +- `Text` - `RawText` - `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 Pager `Widget` for the provided file. Mainly used for Debugging purposes. # Spacer -Empty `Widget` that is supposed to remain empty and serve as a placeholder for corresponding areas of the terminal screen. \ No newline at end of file +Empty `Widget` that is supposed to remain empty and serve as a placeholder for corresponding areas of the terminal screen. diff --git a/Home.md b/Home.md index 0127b07..9cc9528 100644 --- a/Home.md +++ b/Home.md @@ -1,3 +1,7 @@ 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. \ No newline at end of file +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.