OnboardingScreenController class

A controller for managing the state and behavior of an onboarding screen with multiple pages.

This controller manages the page view and tab controller for an onboarding flow, and handles page navigation and updates.

The selectedIndex, pageViewController, and tabController parameters manage the current page index, the page view scrolling, and tab navigation respectively.

Example usage:

class OnboardingScreen extends GetView<OnboardingScreenController> {
  @override
  Widget build(BuildContext context) {
    final controller = Get.put(OnboardingScreenController());
    // ... rest of the code
  }
}
Inheritance
  • Object
  • GetLifeCycle
  • DisposableInterface
  • GetxController
  • OnboardingScreenController
Implemented types
Mixed-in types
  • GetSingleTickerProviderStateMixin

Properties

hashCode → int
The hash code for this object.
no setterinherited
hasListeners → bool
no setterinherited
initialized → bool
Checks whether the controller has already been initialized.
no setterinherited
isClosed → bool
Checks whether the controller has already been closed.
no setterinherited
isOnDesktopAndWeb → bool
Determines whether the current platform is desktop or web.
no setter
listeners → int
no setterinherited
onDelete → InternalFinalCallback<void>
Internal callback that starts the cycle of this controller.
finalinherited
onStart → InternalFinalCallback<void>
Called at the exact moment the widget is allocated in memory. It uses an internal "callable" type, to avoid any @overrides in subclases. This method should be internal and is required to define the lifetime cycle of the subclass.
finalinherited
pageViewController ↔ PageController
The controller for the PageView widget used to swipe between pages.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selectedIndex → RxInt
The currently selected page index in the onboarding flow.
final
tabController ↔ TabController
The controller for the TabBar widget used for displaying page indicators.
getter/setter pair

Methods

$configureLifeCycle() → void
inherited
addListener(GetStateUpdate listener) → Disposer
Register a closure to be called when the object notifies its listeners.
inherited
addListenerId(Object? key, GetStateUpdate listener) → Disposer
inherited
createTicker(TickerCallback onTick) → Ticker
Creates a ticker with the given callback.
inherited
didChangeDependencies(BuildContext context) → void
inherited
dispose() → void
inherited
disposeId(Object id) → void
To dispose an id from future updates(), this ids are registered by GetBuilder() or similar, so is a way to unlink the state change with the Widget from the Controller.
inherited
handlePageViewChanged(int currentPageIndex) → void
Handles the page view change event and updates the tab index and selected index.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyChildrens() → void
inherited
onClose() → void
Called before onDelete method. onClose might be used to dispose resources used by the controller. Like closing events, or streams before the controller is destroyed. Or dispose objects that can potentially create some memory leaks, like TextEditingControllers, AnimationControllers. Might be useful as well to persist some data on disk.
override
onInit() → void
Called immediately after the widget is allocated in memory. You might use this to initialize something for the controller.
override
onReady() → void
Called 1 frame after onInit(). It is the perfect place to enter navigation events, like snackbar, dialogs, or a new route, or async request.
inherited
refresh() → void
inherited
refreshGroup(Object id) → void
inherited
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that the object notifies.
inherited
removeListenerId(Object id, VoidCallback listener) → void
inherited
toString() → String
A string representation of this object.
inherited
update([List<Object>? ids, bool condition = true]) → void
Rebuilds GetBuilder each time you call update(); Can take a List of ids, that will only update the matching GetBuilder( id: ), ids can be reused among GetBuilders like group tags. The update will only notify the Widgets, if condition is true.
inherited
updateCurrentPageIndex(int index) → void
Updates the current page index and animates the PageView to the specified page.

Operators

operator ==(Object other) → bool
The equality operator.
inherited