flutter_meedu library
Classes
-
BaseNotifier<
T> - Define a base notifier for SimpleNotifier and StateNotifier
-
BaseProvider<
T> - BuilderRef
- A interface that must be implemented in the ConsumerWidget
- Consumer
- A widget to listen the events in a SimpleNotifier or StateNotifier
- ConsumerWidget
- A base-class for widgets that wants to listen to providers
- Debouncer
- this class is an implementenacion of a debounce functionallity
- Get
- Singleton to save dependencies
- MultiProviderListener
- this class allows you listen the changes in multiples providers
-
MultiProviderListenerItem<
T extends BaseNotifier> - this class is used to define onChange callback for one Notifier
- PageWithArguments
- A simple Widget with a callback useful to set arguments for one SimpleProvider or a StateProvider
- PageWithArgumentsWidget
- uses this class to create a page and define the arguments for a SimpleProvider or a StateProvider
-
Provider<
T> -
ProviderListener<
T extends BaseNotifier> - A widget to listen events in a SimpleProvider or a StateProvider
- ProviderReference
- ProviderScope
-
Rx<
T> - Rx class to work with observables
- RxBuilder
- A widget to be used with Observables (instances of Rx)
-
RxNotifier<
T> - class to add dynamic updates into a RxBuilder widget
- RxWorker
- this class allow us to cancel schedules tasks and subscriptions
- SimpleNotifier
-
SimpleProvider<
T> -
SimpleTagProvider<
T extends SimpleNotifier> -
Singleton<
T> - A dependency will be create immediately when an instance of this class is created
-
StateNotifier<
State> -
StateProvider<
T extends StateNotifier< S> , S> -
StateTagProvider<
T extends StateNotifier< S> , S> -
TagProvider<
P> -
Target<
Notifier, R> - class to save a Notifier, the listener and the rebuild function
Enums
- Filter
- enum used to identifier filters used in a provider
- Transition
- all posible transition animation for the router module
Extensions
- ContextExtensionss on BuildContext
- BuildContext extension with some ui utils methods and getters
- RxBool on bool
- creates a bool observable using for example false.obs
- RxDouble on double
- creates a double observable using for example 0.0.obs
-
RxExtensions
on Rx<
T> - RxInt on int
- creates an int observable using for example 0.obs
- RxString on String
- creates a String observable using for example "".obs
-
SimpleProviderExt
on SimpleProvider<
Notifier> - extension for SimpleProvider
-
StateProviderExt
on StateProvider<
Notifier, S> - extension for StateProvider
Properties
-
appKey
→ GlobalKey<
State< StatefulWidget> > -
GlobalKey to detenrminate if a MaterialApp or CupertinoApp
is using the
onGenerateRoute
paremeter or for custom transitions using named routes we need to now the value ofroutes
parameterno setter - arguments → Object?
-
return the arguments of the current page
no setter
- context → BuildContext?
-
return the current context linked to the global navigatorKey
no setter
-
a GlobalKey
no setter
- observer → NavigatorObserver
-
the observer to listen the changes in the stack route
no setter
- settings → RouteSettings
-
return the current route settings
no setter
Functions
-
canPop(
) → bool - return true if we can do pop
-
createSimpleSelectListener(
Target target) → void - create the listener for provider.select filter (SimpleProvider)
-
createStateSelectListener(
Target target) → void - create the listener for provider.select filter (StateProvider)
-
createWhenListener(
Target target) → void - create the listener for provider.when filter
-
dispose(
) → void - use this method to destroy the current navigatorKey attached to the app
-
getRoute<
T> (Widget page, {Object? arguments, bool maintainState = true, bool fullscreenDialog = false, bool backGestureEnabled = true, Transition? transition, Duration? transitionDuration}) → Route< T> - get the transition
-
maybePop<
T> ([T? result]) → Future< bool> - Consults the current route's Route.willPop method, and acts accordingly, potentially popping the route as a result;
-
pop<
T> ([T? result]) → void -
remove the current page or dialog from the stack until
predicate
-
popAndPushNamed<
T extends Object?, TO extends Object?> (String routeName, {Object? arguments, bool backGestureEnabled = true, Transition? transition, Duration? transitionDuration, TO? result}) → Future< T?> - Pop the current route off the navigator and push a named route in its place
-
popUntil(
[bool predicate(Route)?]) → void -
remove all pages in the stack until
predicate
-
push<
T> (Widget page, {Object? arguments, bool maintainState = true, bool fullscreenDialog = false, Transition? transition, Duration? transitionDuration, bool backGestureEnabled = false}) → Future< T?> -
Push the given
page
onto the navigator. -
pushNamed<
T> (String routeName, {Object? arguments, bool backGestureEnabled = true, Transition? transition, Duration? transitionDuration}) → Future< T?> - Push a named route onto the navigator.
-
pushNamedAndRemoveUntil<
T> (String routeName, {bool predicate(Route)?, Object? arguments, bool backGestureEnabled = true, Transition? transition, Duration? transitionDuration}) → Future< T?> - navigates to a new pages and remove until
-
pushReplacement<
T extends Object?, TO extends Object?> (Widget page, {Object? arguments, bool maintainState = true, bool fullscreenDialog = false, Transition? transition, Duration transitionDuration = const Duration(milliseconds: 300), bool backGestureEnabled = false, TO? result}) → Future< T?> -
Replace the current
page
of the navigator by pushing the givenpage
and then disposing the previous route once the new route has finished animating in. -
pushReplacementNamed<
T extends Object?, TO extends Object?> (String routeName, {Object? arguments, bool backGestureEnabled = true, Transition? transition, Duration? transitionDuration, TO? result}) → Future< T?> - replace the current page with a new route name
-
setDefaultTransition(
Transition transition, {Duration? duration}) → void - set the default transition for all pages
Typedefs
- ConsumerBuilder = Widget Function(BuildContext context, BuilderRef ref, Widget? child)
- A function that can also listen to providers
-
ListenerCallback<
T> = void Function(T)