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.

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

feat: Add documentation for GetBuilder widget #3006

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: Add documentation for GetBuilder widget #3006

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
24 changes: 24 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@
- [Local State Widgets](#local-state-widgets)
- [ValueBuilder](#valuebuilder)
- [ObxValue](#obxvalue)
- [GetBuilder](#getbuilder)
- [Useful tips](#useful-tips)
- [GetView](#getview)
- [GetResponsiveView](#getresponsiveview)
Expand Down Expand Up @@ -834,6 +835,29 @@ ObxValue((data) => Switch(
),
```

#### GetBuilder

The `GetBuilder` widget is used to control and update the UI based on changes in the state managed by a specific controller. Any changes to
the state of the controller will trigger a rebuild of the UI within the `GetBuilder` widget, ensuring that the UI stays reactive and in sync
with the controller's state.

```dart
GetBuilder<Controller>(
init: Controller(),
builder: (controller) {
return Column(
children: [
Text('Value: ${controller.value}'),
ElevatedButton(
onPressed: () => controller.increment(),
child: Text('Increment'),
),
],
);
},
),
```

## Useful tips

`.obs`ervables (also known as _Rx_ Types) have a wide variety of internal methods and operators.
Expand Down