Skip to content

Docs: Add documentation for Mirai column widget #143

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.

Sign up for GitHub

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

Merged
divyanshub024 merged 1 commit into from
Jan 22, 2025
Merged

Docs: Add documentation for Mirai column widget #143

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
42 changes: 42 additions & 0 deletions website/docs/widgets/column.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Column

The Mirai Column allows you to build a Flutter column widget using JSON.
To know more about the column widget in Flutter, refer to the [official documentation](https://api.flutter.dev/flutter/widgets/Column-class.html).

## Properties

| Property | Type | Description |
|--------------------|------------------------------|--------------------------------------------------------------------------------------------------|
| mainAxisAlignment | `MainAxisAlignment` | How the children should be placed along the main axis. Defaults to `MainAxisAlignment.start`. |
| crossAxisAlignment | `CrossAxisAlignment` | How the children should be placed along the cross axis. Defaults to `CrossAxisAlignment.center`. |
| mainAxisSize | `MainAxisSize` | How much space should be occupied in the main axis. Defaults to `MainAxisSize.max`. |
| textDirection | `TextDirection?` | The text direction to use for resolving alignment. |
| verticalDirection | `VerticalDirection` | The vertical direction to use for laying out children. Defaults to `VerticalDirection.down`. |
| spacing | `double` | The spacing between children. Defaults to `0`. |
| children | `List<Map<String, dynamic>>` | The list of widgets to display inside the column. Defaults to an empty list. |

## Example JSON

```json
{
"type": "column",
"mainAxisAlignment": "center",
"crossAxisAlignment": "start",
"mainAxisSize": "min",
"textDirection": "ltr",
"verticalDirection": "up",
"spacing": 10,
"children": [
{
"type": "text",
"data": "Hello, World!"
},
{
"type": "container",
"width": 100,
"height": 100,
"color": "#FF0000"
}
]
}
```