SintInterface class abstract

SintInterface allows any auxiliary package to be merged into the "SINT" class through extensions

Available extensions

• BottomSheetExtension
• DialogExtension
• InjectionExtension
• LocalesIntl
• LoopEventsExtension
• NavigationExtension
• OverlayExtension
• SintReset
• SnackbarExtension

Constructors

SintInterface()

Properties

arguments → dynamic

Available on SintInterface, provided by the NavigationExtension extension

give current arguments

no setter

bottomBarHeight → double

Available on SintInterface, provided by the NavigationExtension extension

The distance from the bottom edge to the first unpadded pixel, in physical pixels.

no setter

context → BuildContext?

Available on SintInterface, provided by the NavigationExtension extension

give access to currentContext

no setter

currentRoute → String

Available on SintInterface, provided by the NavigationExtension extension

give name from current route

no setter

defaultDialogTransitionCurve → Curve

Available on SintInterface, provided by the NavigationExtension extension

no setter

defaultDialogTransitionDuration → Duration

Available on SintInterface, provided by the NavigationExtension extension

no setter

defaultOpaqueRoute → bool

Available on SintInterface, provided by the NavigationExtension extension

no setter

defaultPopGesture → bool?

Available on SintInterface, provided by the NavigationExtension extension

no setter

defaultTransition → Transition?

Available on SintInterface, provided by the NavigationExtension extension

no setter

defaultTransitionCurve → Curve

Available on SintInterface, provided by the NavigationExtension extension

no setter

defaultTransitionDuration → Duration

Available on SintInterface, provided by the NavigationExtension extension

no setter

deviceLocale → Locale?

Available on SintInterface, provided by the NavigationExtension extension

no setter

engine → WidgetsBinding

Available on SintInterface, provided by the NavigationExtension extension

The current null safe WidgetsBinding

no setter

fallbackLocale ↔ Locale?

Available on SintInterface, provided by the LocalesIntl extension

getter/setter pair

focusScope → FocusNode?

Available on SintInterface, provided by the NavigationExtension extension

give access to FocusScope.of(context)

no setter

hashCode → int

The hash code for this object.

no setter, inherited

height → double

Available on SintInterface, provided by the NavigationExtension extension

The vertical extent of this size

no setter

iconColor → Color?

Available on SintInterface, provided by the NavigationExtension extension

give access to Theme.of(context).iconTheme.color

no setter

isBottomSheetOpen → bool?

Available on SintInterface, provided by the NavigationExtension extension

check if bottomsheet is open

no setter

isDarkMode → bool

Available on SintInterface, provided by the NavigationExtension extension

Check if dark mode theme is enable

no setter

isDialogOpen → bool?

Available on SintInterface, provided by the NavigationExtension extension

check if dialog is open

no setter

isLogEnable ↔ bool

getter/setter pair

isOpaqueRouteDefault → bool

Available on SintInterface, provided by the NavigationExtension extension

check if default opaque route is enable

no setter

isOverlaysClosed → bool

Available on SintInterface, provided by the NavigationExtension extension

Returns true if there is no Snackbar, Dialog or BottomSheet open

no setter

isOverlaysOpen → bool

Available on SintInterface, provided by the NavigationExtension extension

Returns true if a Snackbar, Dialog or BottomSheet is currently OPEN

no setter

isPlatformDarkMode → bool

Available on SintInterface, provided by the NavigationExtension extension

Check if dark mode theme is enable on platform on android Q+

no setter

isSnackbarOpen → bool

Available on SintInterface, provided by the NavigationExtension extension

check if snackbar is open

no setter

key → GlobalKey<NavigatorState>

Available on SintInterface, provided by the NavigationExtension extension

no setter

keys → Map<String, SintDelegate>

Available on SintInterface, provided by the NavigationExtension extension

no setter

locale ↔ Locale?

Available on SintInterface, provided by the LocalesIntl extension

getter/setter pair

log ↔ LogWriterCallback

getter/setter pair

mediaQuery → MediaQueryData

Available on SintInterface, provided by the NavigationExtension extension

give access to Mediaquery.of(context)

no setter

overlayContext → BuildContext?

Available on SintInterface, provided by the NavigationExtension extension

give access to current Overlay Context

no setter

parameters → Map<String, String?>

Available on SintInterface, provided by the NavigationExtension extension

no setter

pixelRatio → double

Available on SintInterface, provided by the NavigationExtension extension

The number of device pixels for each logical pixel.

no setter

previousRoute → String

Available on SintInterface, provided by the NavigationExtension extension

give name from previous route

no setter

rawRoute → Route?

Available on SintInterface, provided by the NavigationExtension extension

check a raw current route

no setter

rootController → SintRootState

Available on SintInterface, provided by the NavigationExtension extension

no setter

routing → Routing

Available on SintInterface, provided by the NavigationExtension extension

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

size → Size

Available on SintInterface, provided by the NavigationExtension extension

no setter

smartManagement ↔ SmartManagement

getter/setter pair

statusBarHeight → double

Available on SintInterface, provided by the NavigationExtension extension

The distance from the top edge to the first unpadded pixel, in physical pixels.

no setter

testMode ↔ bool

Available on SintInterface, provided by the NavigationExtension extension

getter/setter pair

textScaleFactor → double

Available on SintInterface, provided by the NavigationExtension extension

The system-reported text scale.

no setter

textTheme → TextTheme

Available on SintInterface, provided by the NavigationExtension extension

give access to TextTheme.of(context)

no setter

theme → ThemeData

Available on SintInterface, provided by the NavigationExtension extension

give access to Theme.of(context)

no setter

translations → Map<String, Map<String, String>>

Available on SintInterface, provided by the LocalesIntl extension

no setter

width → double

Available on SintInterface, provided by the NavigationExtension extension

The horizontal extent of this size.

no setter

window → PlatformDispatcher

Available on SintInterface, provided by the NavigationExtension extension

The window to which this binding is bound.

no setter

Methods

addKey(GlobalKey<NavigatorState> newKey) → GlobalKey<NavigatorState>?

Available on SintInterface, provided by the NavigationExtension extension

addTranslations(Map<String, Map<String, String>> tr) → void

Available on SintInterface, provided by the LocalesIntl extension

appendTranslations(Map<String, Map<String, String>> tr) → void

Available on SintInterface, provided by the LocalesIntl extension

appUpdate() → void

Available on SintInterface, provided by the NavigationExtension extension

args<T>() → T

Available on SintInterface, provided by the NavigationExtension extension

asap<T>(T computation(), {bool condition()?}) → FutureOr<T>

Available on SintInterface, provided by the LoopEventsExtension extension

back<T>({T? result, bool canPop = true, int times = 1, String? id}) → void

Available on SintInterface, provided by the NavigationExtension extension

Navigation.popUntil() shortcut.

backLegacy<T>({T? result, bool closeOverlays = false, bool canPop = true, int times = 1, String? id}) → void

Available on SintInterface, provided by the NavigationExtension extension

Pop the current page, snackbar, dialog or bottomsheet in the stack

bottomSheet<T>(Widget bottomsheet, {Color? backgroundColor, double? elevation, bool persistent = true, ShapeBorder? shape, Clip? clipBehavior, Color? barrierColor, bool? ignoreSafeArea, bool isScrollControlled = false, bool useRootNavigator = false, bool isDismissible = true, bool enableDrag = true, RouteSettings? settings, Duration? enterBottomSheetDuration, Duration? exitBottomSheetDuration, Curve? curve}) → Future<T?>

Available on SintInterface, provided by the BottomSheetExtension extension

call<T>() → T

Available on SintInterface, provided by the InjectionExtension extension

changeTheme(ThemeData theme) → void

Available on SintInterface, provided by the NavigationExtension extension

changeThemeMode(ThemeMode themeMode) → void

Available on SintInterface, provided by the NavigationExtension extension

clearTranslations() → void

Available on SintInterface, provided by the LocalesIntl extension

close<T extends Object>({bool closeAll = true, bool closeSnackbar = true, bool closeDialog = true, bool closeBottomSheet = true, String? id, T? result}) → void

Available on SintInterface, provided by the NavigationExtension extension

Navigation.popUntil() (with predicate) shortcut .

closeAllBottomSheets({String? id}) → void

Available on SintInterface, provided by the NavigationExtension extension

closeAllDialogs({String? id}) → void

Available on SintInterface, provided by the NavigationExtension extension

closeAllDialogsAndBottomSheets(String? id) → void

Available on SintInterface, provided by the NavigationExtension extension

closeAllOverlays() → void

Available on SintInterface, provided by the NavigationExtension extension

closeAllSnackbars() → void

Available on SintInterface, provided by the NavigationExtension extension

closeBottomSheet<T>({String? id, T? result}) → void

Available on SintInterface, provided by the NavigationExtension extension

closeCurrentSnackbar() → Future<void>

Available on SintInterface, provided by the NavigationExtension extension

closeDialog<T>({String? id, T? result}) → void

Available on SintInterface, provided by the NavigationExtension extension

Close the currently open dialog, returning a result, if provided

closeOverlay<T>({String? id, T? result}) → void

Available on SintInterface, provided by the NavigationExtension extension

Close the current overlay returning the result, if provided

defaultDialog<T>({String title = "Alert", EdgeInsetsGeometry? titlePadding, TextStyle? titleStyle, Widget? content, String? id, EdgeInsetsGeometry? contentPadding, VoidCallback? onConfirm, VoidCallback? onCancel, VoidCallback? onCustom, Color? cancelTextColor, Color? confirmTextColor, String? textConfirm, String? textCancel, String? textCustom, Widget? confirm, Widget? cancel, Widget? custom, Color? backgroundColor, bool barrierDismissible = true, Color? buttonColor, String middleText = "\n", TextStyle? middleTextStyle, double radius = 20.0, List<Widget>? actions, PopInvokedWithResultCallback<T>? onWillPop, GlobalKey<NavigatorState>? navigatorKey}) → Future<T?>

Available on SintInterface, provided by the DialogExtension extension

Custom UI Dialog.

delegate<TDelegate extends RouterDelegate<TPage>, TPage>() → TDelegate?

Available on SintInterface, provided by the NavigationExtension extension

Casts the stored router delegate to a desired type

delete<S>({String? tag, String? key, bool force = false}) → bool

Available on SintInterface, provided by the InjectionExtension extension

Delete registered Class Instance S (or tag) and, closes any open controllers DisposableInterface, cleans up the memory

deleteAll({bool force = false}) → void

Available on SintInterface, provided by the InjectionExtension extension

Delete all registered Class Instances and, closes any open controllers DisposableInterface, cleans up the memory

dialog<T>(Widget widget, {bool barrierDismissible = true, Color? barrierColor, bool useSafeArea = true, GlobalKey<NavigatorState>? navigatorKey, Object? arguments, Duration? transitionDuration, Curve? transitionCurve, String? name, RouteSettings? routeSettings, String? id}) → Future<T?>

Available on SintInterface, provided by the DialogExtension extension

Show a dialog. You can pass a transitionDuration and/or transitionCurve, overriding the defaults when the dialog shows up and closes. When the dialog closes, uses those animations in reverse.

find<S>({String? tag}) → S

Available on SintInterface, provided by the InjectionExtension extension

Finds the registered type <S> (or tag) In case of using Sint.create to register a type <S> or tag, it will create an instance each time you call find. If the registered type <S> (or tag) is a Controller, it will initialize it's lifecycle.

findOrNull<S>({String? tag}) → S?

Available on SintInterface, provided by the InjectionExtension extension

The findOrNull method will return the instance if it is registered; otherwise, it will return null.

forceAppUpdate() → Future<void>

Available on SintInterface, provided by the NavigationExtension extension

As a rule, Flutter knows which widget to update, so this command is rarely needed. We can mention situations where you use const so that ui are not updated with setState, but you want it to be forcefully updated when an event like language change happens. using context to make the widget dirty for performRebuild() is a viable solution. However, in situations where this is not possible, or at least, is not desired by the developer, the only solution for updating ui that Flutter does not want to update is to use reassemble to forcibly rebuild all ui. Attention: calling this function will reconstruct the application from the sketch, use this with caution. Your entire application will be rebuilt, and touch events will not work until the end of rendering.

generalDialog<T>({required RoutePageBuilder pageBuilder, bool barrierDismissible = false, String? barrierLabel, Color barrierColor = const Color(0x80000000), Duration transitionDuration = const Duration(milliseconds: 200), RouteTransitionsBuilder? transitionBuilder, GlobalKey<NavigatorState>? navigatorKey, RouteSettings? routeSettings, String? id}) → Future<T?>

Available on SintInterface, provided by the DialogExtension extension

Api from showGeneralDialog with no context

getInstanceInfo<S>({String? tag}) → InstanceInfo

Available on SintInterface, provided by the InjectionExtension extension

isPrepared<S>({String? tag}) → bool

Available on SintInterface, provided by the InjectionExtension extension

Checks if a lazy factory callback Sint.lazyPut() that returns an Instance<S> is registered in memory.

isRegistered<S>({String? tag}) → bool

Available on SintInterface, provided by the InjectionExtension extension

Check if a Class Instance<S> (or tag) is registered in memory.

lazyPut<S>(InstanceBuilderCallback<S> builder, {String? tag, bool fenix = false, bool permanent = false}) → void

Available on SintInterface, provided by the InjectionExtension extension

Creates a new Instance lazily from the <S>builder() callback.

lazyReplace<P>(InstanceBuilderCallback<P> builder, {String? tag, bool? fenix}) → void

Available on SintInterface, provided by the InjectionExtension extension

Replaces a parent instance with a new Instance

markAsDirty<S>({String? tag, String? key}) → void

Available on SintInterface, provided by the InjectionExtension extension

nestedKey(String? key) → SintDelegate?

Available on SintInterface, provided by the NavigationExtension extension

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

off<T>(Widget page(), {bool? opaque, Transition? transition, Curve? curve, bool? popGesture, String? id, String? routeName, dynamic arguments, List<BindingsInterface> bindings = const [], bool fullscreenDialog = false, bool preventDuplicates = true, Duration? duration, double gestureWidth(BuildContext context)?}) → Future<T?>?

Available on SintInterface, provided by the NavigationExtension extension

Navigation.pushReplacement() shortcut .

offAll<T>(Widget page(), {bool predicate(SintPage)?, bool? opaque, bool? popGesture, String? id, String? routeName, dynamic arguments, List<BindingsInterface> bindings = const [], bool fullscreenDialog = false, Transition? transition, Curve? curve, Duration? duration, double gestureWidth(BuildContext context)?}) → Future<T?>?

Available on SintInterface, provided by the NavigationExtension extension

Push a page and pop several pages in the stack until predicate returns true. predicate is optional

offAllNamed<T>(String newRouteName, {dynamic arguments, String? id, Map<String, String>? parameters}) → Future<T?>?

Available on SintInterface, provided by the NavigationExtension extension

Navigation.pushNamedAndRemoveUntil() shortcut.

offAndToNamed<T>(String page, {dynamic arguments, String? id, dynamic result, Map<String, String>? parameters}) → Future<T?>?

Available on SintInterface, provided by the NavigationExtension extension

Navigation.popAndPushNamed() shortcut.

offNamed<T>(String page, {dynamic arguments, String? id, Map<String, String>? parameters}) → Future<T?>?

Available on SintInterface, provided by the NavigationExtension extension

Navigation.pushReplacementNamed() shortcut.

offNamedUntil<T>(String page, bool predicate(SintPage)?, {String? id, dynamic arguments, Map<String, String>? parameters}) → Future<T?>?

Available on SintInterface, provided by the NavigationExtension extension

Navigation.pushNamedAndRemoveUntil() shortcut.

offUntil<T>(Widget page(), bool predicate(SintPage), [Object? arguments, String? id]) → Future<T?>

Available on SintInterface, provided by the NavigationExtension extension

put<S>(S dependency, {String? tag, bool permanent = false}) → S

Available on SintInterface, provided by the InjectionExtension extension

putOrFind<S>(InstanceBuilderCallback<S> dep, {String? tag}) → S

Available on SintInterface, provided by the InjectionExtension extension

rawSnackbar({String? title, String? message, Widget? titleText, Widget? messageText, Widget? icon, bool instantInit = true, bool shouldIconPulse = true, double? maxWidth, EdgeInsets margin = const EdgeInsets.all(0.0), EdgeInsets padding = const EdgeInsets.all(16), double borderRadius = 0.0, Color? borderColor, double borderWidth = 1.0, Color backgroundColor = const Color(0xFF303030), Color? leftBarIndicatorColor, List<BoxShadow>? boxShadows, Gradient? backgroundGradient, Widget? mainButton, OnTap? onTap, Duration? duration = const Duration(seconds: 3), bool isDismissible = true, DismissDirection? dismissDirection, bool showProgressIndicator = false, AnimationController? progressIndicatorController, Color? progressIndicatorBackgroundColor, Animation<Color>? progressIndicatorValueColor, SnackPosition snackPosition = SnackPosition.bottom, SnackStyle snackStyle = SnackStyle.floating, Curve forwardAnimationCurve = Curves.easeOutCirc, Curve reverseAnimationCurve = Curves.easeOutCirc, Duration animationDuration = const Duration(seconds: 1), SnackbarStatusCallback? snackbarStatus, double barBlur = 0.0, double overlayBlur = 0.0, Color? overlayColor, Form? userInputForm}) → SnackbarController

Available on SintInterface, provided by the SnackbarExtension extension

reload<S>({String? tag, String? key, bool force = false}) → void

Available on SintInterface, provided by the InjectionExtension extension

reloadAll({bool force = false}) → void

Available on SintInterface, provided by the InjectionExtension extension

removeRoute(String name, {String? id}) → void

Available on SintInterface, provided by the NavigationExtension extension

Navigation.removeRoute() shortcut.

replace<P>(P child, {String? tag}) → void

Available on SintInterface, provided by the InjectionExtension extension

Replace a parent instance of a class in dependency management with a child instance

reset({bool clearRouteBindings = true}) → void

Available on SintInterface, provided by the SintReset extension

resetInstance({bool clearRouteBindings = true}) → bool

Available on SintInterface, provided by the InjectionExtension extension

Clears all registered instances (and/or tags). Even the persistent ones. This should be used at the end or tearDown of unit tests.

searchDelegate(String? k) → SintDelegate

Available on SintInterface, provided by the NavigationExtension extension

showOverlay<T>({required Future<T> asyncFunction(), Color opacityColor = Colors.black, Widget? loadingWidget, double opacity = .5}) → Future<T>

Available on SintInterface, provided by the OverlayExtension extension

showSnackbar(SintSnackBar snackbar) → SnackbarController

Available on SintInterface, provided by the SnackbarExtension extension

snackbar(String title, String message, {Color? colorText, Duration? duration = const Duration(seconds: 3), bool instantInit = true, SnackPosition? snackPosition, Widget? titleText, Widget? messageText, Widget? icon, bool? shouldIconPulse, double? maxWidth, EdgeInsets? margin, EdgeInsets? padding, double? borderRadius, Color? borderColor, double? borderWidth, Color? backgroundColor, Color? leftBarIndicatorColor, List<BoxShadow>? boxShadows, Gradient? backgroundGradient, TextButton? mainButton, OnTap? onTap, OnHover? onHover, bool? isDismissible, bool? showProgressIndicator, DismissDirection? dismissDirection, AnimationController? progressIndicatorController, Color? progressIndicatorBackgroundColor, Animation<Color>? progressIndicatorValueColor, SnackStyle? snackStyle, Curve? forwardAnimationCurve, Curve? reverseAnimationCurve, Duration? animationDuration, double? barBlur, double? overlayBlur, SnackbarStatusCallback? snackbarStatus, Color? overlayColor, Form? userInputForm}) → SnackbarController

Available on SintInterface, provided by the SnackbarExtension extension

spawn<S>(InstanceBuilderCallback<S> builder, {String? tag, bool permanent = true}) → void

Available on SintInterface, provided by the InjectionExtension extension

Creates a new Class Instance S from the builder callbackS. Every time find<S>() is used, it calls the builder method to generate a new Instance S. It also registers each instance.onClose() with the current Route Sint.reference to keep the lifecycle active. Is important to know that the instances created are only stored per Route. So, if you call Sint.delete<T>() the "instance factory" used in this method (Sint.spawn<T>()) will be removed, but NOT the instances already created by it.

to<T extends Object?>(Widget page(), {bool? opaque, Transition? transition, Curve? curve, Duration? duration, String? id, String? routeName, bool fullscreenDialog = false, dynamic arguments, List<BindingsInterface> bindings = const [], bool preventDuplicates = true, bool? popGesture, bool showCupertinoParallax = true, double gestureWidth(BuildContext context)?, bool rebuildStack = true, PreventDuplicateHandlingMode preventDuplicateHandlingMode = PreventDuplicateHandlingMode.reorderRoutes}) → Future<T?>?

Available on SintInterface, provided by the NavigationExtension extension

Navigation.push() shortcut.

toNamed<T>(String page, {dynamic arguments, dynamic id, bool preventDuplicates = true, Map<String, String>? parameters}) → Future<T?>?

Available on SintInterface, provided by the NavigationExtension extension

Navigation.pushNamed() shortcut.

toString() → String

A string representation of this object.

inherited

until(bool predicate(SintPage), {String? id}) → void

Available on SintInterface, provided by the NavigationExtension extension

Navigation.popUntil() shortcut.

updateLocale(Locale l) → Future<void>

Available on SintInterface, provided by the NavigationExtension extension

Operators

operator ==(Object other) → bool

The equality operator.

inherited