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.

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

Add basic layout system documentation. #1739

Merged
merged 6 commits into from
Dec 13, 2023
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
85 changes: 85 additions & 0 deletions redwood-layout-schema/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# Redwood Layout

Redwood's layout system provides common layout primitives to support arranging and laying out widgets. It provides widgets for:

- `Row`: Lays wigets out along the X axis (horizontally).
- `Column`: Lays widgets out along the Y axis (vertically).
- `Box`: Lays widgets out along the Z axis (on top of eachother).
- `Spacer`: Adds space between widgets.

Internally the layout system uses a common layout engine written in Kotlin Multiplatform to support consistent rendering across platforms. The system provides widget bindings for for Android Views (`redwood-layout-view`), iOS UiKit (`redwood-layout-uiview`), and Compose UI (`redwood-layout-composeui`).
colinrtwhite marked this conversation as resolved.
Show resolved Hide resolved

## Widgets

### Row

Lays widgets out along the X axis (horizontally).

```kotlin
Row {
Text("One")
Text("Two")
Text("Three")
}
```

<p style="text-align: center;">
<img src="docs_images/row1.png">
</p>

### Column

Lays widgets out along the Y axis (vertically).

```kotlin
Column {
Text("One")
Text("Two")
Text("Three")
}
```

<p style="text-align: center;">
<img src="docs_images/column1.png">
</p>

### Box

Lays widgets out along the Z axis (on top of eachother).

```kotlin
Box {
Color(
color = Red,
modifier = Modifier.size(24.dp),
)
Color(
color = Green,
modifier = Modifier.size(16.dp),
)
Color(
color = Blue,
modifier = Modifier.size(8.dp),
)
}
```

<p style="text-align: center;">
<img src="docs_images/box1.png" width="250" height="250">
</p>

### Spacer

Adds space between widgets.

```kotlin
Column {
Text("Top")
Spacer(height = 24.dp)
colinrtwhite marked this conversation as resolved.
Show resolved Hide resolved
Text("Bottom")
}
```

<p style="text-align: center;">
<img src="docs_images/spacer1.png">
</p>
3 changes: 3 additions & 0 deletions redwood-layout-schema/docs_images/box1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions redwood-layout-schema/docs_images/column1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions redwood-layout-schema/docs_images/row1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions redwood-layout-schema/docs_images/spacer1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading