NyBaseState<T extends StatefulWidget> class abstract

Inheritance
Implementers

Constructors

NyBaseState({String? path})
Base NyState

Properties

allowStateUpdates → bool
Check if the state should listen for events via the EventBus.
no setter
context → BuildContext
The location in the tree where this widget builds.
no setterinherited
eventBus → EventBus?
Helper to get the EventBus.
no setter
eventSubscription ↔ StreamSubscription?
The eventSubscription is used to listen for UpdateState events.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
hasInitComplete ↔ bool
Check if the initState has already been loaded.
getter/setter pair
init → dynamic Function()
Initialize your widget in init.
no setter
loadingStyle → LoadingStyle
Define the LoadingStyle for the widget.
no setter
mediaQuery → MediaQueryData
Helper to get the MediaQueryData.
no setter
mounted → bool
Whether this State object is currently in a tree.
no setterinherited
overrideLoading ↔ bool
Override the loading state.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shouldLoadView → bool
Check if the widget should be loaded.
no setter
stateActions → Map<String, Function>
Get the state actions
no setter
stateData ↔ dynamic
The stateData contains the last value set from a updateState() call.
getter/setter pair
stateName ↔ String?
The stateName is used as the ID for the UpdateState class.
getter/setter pair
textTheme → TextTheme
Helper to get the TextTheme.
no setter
widget → T
The current configuration.
no setterinherited

Methods

activate() → void
Called when this object is reinserted into the tree after having been removed via deactivate.
inherited
afterLoad({required dynamic child(), Widget? loading, String? loadingKey}) → Widget
The afterLoad method will check if the state is loading If loading it will display the loading widget. You can also specify the name of the loadingKey.
afterNotLocked(String name, {required dynamic child(), Widget? loading}) → Widget
The afterNotLocked method will check if the state is locked, if the state is locked it will display the loading widget.
afterNotNull(dynamic variable, {required dynamic child(), Widget? loading}) → Widget
The afterNotNull method will check if the variable passed in is null If the variable is not null, it will display the loading widget.
awaitData({String name = 'default', required Function perform, bool shouldSetStateBefore = true, bool shouldSetStateAfter = true}) → Future<void>
Use the awaitData method when initial fetching data for a widget. E.g. When your page first loads and you want to populate your widgets with data.
build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
changeLanguage(String language, {bool restartState = true}) → Future<void>
Update the language in the application
color({Color? light, Color? dark}) → Color
Get the color based on the device mode
confirmAction(dynamic action(), {required String title, String dismissText = "Cancel", String confirmText = "Yes", CupertinoThemeData? cupertinoThemeData, ThemeData? themeData, Color barrierColor = kCupertinoModalBarrierColor, bool barrierDismissible = true, bool useRootNavigator = true, bool semanticsDismissible = false, RouteSettings? routeSettings, Offset? anchorPoint}) → void
Allow the user to confirm an action. Provide a title for the confirm button. You can also provide a dismissText for the cancel button. E.g. confirmAction(() { ... perform action }, title: "Delete account?", dismissText: "Cancel");
data<T>({dynamic defaultValue}) → T?
Get data from the NyStatefulWidget controller.
deactivate() → void
Called when this object is removed from the tree.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
didChangeDependencies() → void
Called when a dependency of this State object changes.
inherited
didUpdateWidget(covariant T oldWidget) → void
Called whenever the widget configuration changes.
inherited
dispose() → void
Called when this object is removed from the tree permanently.
override
hasQueryParameter(String key) → bool
Check if the queryParameters contains a specific key.
initState() → void
Called when this object is inserted into the tree.
inherited
isLoading({String name = 'default'}) → bool
Checks the value from your loading map. Provide the name of the loader.
isLocked(String name) → bool
Checks the value from your lock map. Provide the name of the lock.
listen<E extends NyEvent>(dynamic callback(Map? data)) → NyEventSubscription<NyEvent>
Listen to an event with a callback function Returns a subscription reference that can be used to cancel later
lockRelease(String name, {required Function perform, bool shouldSetState = true}) → Future<void>
The lockRelease method will call the function provided in perform and then block the function from being called again until it has finished.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pop({dynamic result}) → void
Pop the current widget from the stack.
pushTo(Widget page, {dynamic data, dynamic onPop(dynamic value)?}) → void
Push to a new page
queryParameters({String? key}) → dynamic
Get queryParameters from the NyStatefulWidget controller.
reassemble() → void
Called whenever the application is reassembled during debugging, for example during hot reload.
inherited
reboot() → Future<void>
Reboot your widget.
setLoading(bool value, {String name = 'default', bool resetState = true}) → void
Set the value of a loading key by padding a true or false
setState(VoidCallback fn) → void
Notify the framework that the internal state of this object has changed.
inherited
showToast({ToastNotificationStyleType style = ToastNotificationStyleType.success, required String title, required String description, IconData? icon, Duration? duration}) → void
Show a toast notification
showToastCustom({String? title, String? description, ToastNotificationStyleType? style}) → void
Display a custom Toast message.
showToastDanger({String? title, required String description, ToastNotificationStyleType? style}) → void
Displays a Toast message containing "Error" for the title, you only need to provide a description.
showToastInfo({String? title, required String description, ToastNotificationStyleType? style}) → void
Displays a Toast message containing "Info" for the title, you only need to provide a description.
showToastOops({String? title, required String description, ToastNotificationStyleType? style}) → void
Displays a Toast message containing "Oops" for the title, you only need to provide a description.
showToastSorry({String? title, required String description, ToastNotificationStyleType? style}) → void
Displays a Toast message containing "Sorry" for the title, you only need to provide a description.
showToastSuccess({String? title, required String description, ToastNotificationStyleType? style}) → void
Displays a Toast message containing "Success" for the title, you only need to provide a description.
showToastWarning({String? title, required String description, ToastNotificationStyleType? style}) → void
Displays a Toast message containing "Warning" for the title, you only need to provide a description.
stateUpdated(dynamic data) → Future<void>
When you call updateState, this method will be called within your State. The data parameter will contain any data passed from the updateState method.
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringShort() → String
A brief description of this object, usually just the runtimeType and the hashCode.
inherited
validate({required Map<String, dynamic> rules, Map<String, dynamic>? data, Map<String, dynamic>? messages, bool showAlert = true, Duration? alertDuration, ToastNotificationStyleType alertStyle = ToastNotificationStyleType.warning, required dynamic onSuccess()?, dynamic onFailure(Exception exception)?, String? lockRelease}) → void
Validate data from your widget.
view(BuildContext context) → Widget
Display your widget.
whenEnv(String env, {required Function perform, bool shouldSetState = true}) → Future<void>
Perform an action when the application's env is in a certain state
whenStateAction(Map<String, Function> actions) → void
Handle what happens when an action is called actions is a map of actions
whenTheme<T>({required T light(), T dark()?}) → T
When the theme is in light mode, return light function, else return dark function

Operators

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