Skip to content

Docs: Add documentation for SingleChildScrollView widget #155

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 23, 2025
Merged

Docs: Add documentation for SingleChildScrollView widget #155

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
48 changes: 48 additions & 0 deletions website/docs/widgets/single_child_scroll_view.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# SingleChildScrollView

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

## Properties

| Property | Type | Description |
|-------------------------|-------------------------------------|---------------------------------------------------------------------------------------------------------------------|
| scrollDirection | `Axis` | The axis along which the scroll view scrolls. Defaults to `Axis.vertical`. |
| reverse | `bool` | Whether the scroll view scrolls in the reverse direction. Defaults to `false`. |
| padding | `MiraiEdgeInsets?` | The amount of space by which to inset the child. |
| primary | `bool?` | Whether this is the primary scroll view associated with the parent. |
| physics | `MiraiScrollPhysics?` | How the scroll view should respond to user input. |
| child | `Map<String, dynamic>?` | The widget below this widget in the tree. |
| dragStartBehavior | `DragStartBehavior` | Determines the way that drag start behavior is handled. Defaults to `DragStartBehavior.start`. |
| clipBehavior | `Clip` | The content will be clipped (or not) according to this option. Defaults to `Clip.hardEdge`. |
| restorationId | `String?` | The restoration ID to save and restore the state of the scroll view. |
| keyboardDismissBehavior | `ScrollViewKeyboardDismissBehavior` | Configures how the scroll view should dismiss the keyboard. Defaults to `ScrollViewKeyboardDismissBehavior.manual`. |

## Example JSON

```json
{
"type": "singleChildScrollView",
"child": {
"type": "column",
"children": [
{
"type": "text",
"data": "Hello World!"
},
{
"type": "text",
"data": "This is a SingleChildScrollView widget."
},
{
"type": "text",
"data": "You can scroll vertically."
},
{
"type": "text",
"data": "You can also scroll horizontally."
}
]
}
}
```