playx_core library

Classes

AndroidOptions
AppleOptions
Bindings
Bindings should be extended or implemented. When using GetMaterialApp, all GetPages and navigation methods (like Get.to()) have a binding property that takes an instance of Bindings to manage the dependencies() (via Get.put()) for the Route you are opening.
BindingsBuilder<T>
Simplifies Bindings generation from a single callback. To avoid the creation of a custom Binding instance per route.
CustomTransition
DefaultAppScrollBehavior
Describes how Scrollable widgets behave for MaterialApps. Defaults to use touch, mouse, and trackpad.
DisposableInterface
Equatable
A base class to facilitate operator == and hashCode overrides.
EquatableConfig
The default configurion for all Equatable instances.
FastList<T>
FlutterSecureStorage
FormData
FullLifeCycleController
GetBar
GetBuilder<T extends GetxController>
GetBuilderState<T extends GetxController>
GetConnect
GetConnectInterface
GetCupertinoApp
GetDelegate
GetHttpClient
GetInformationParser
GetInstance
GetInterface
GetInterface allows any auxiliary package to be merged into the "Get" class through extensions
GetLifeCycle
GetMaterialApp
GetMaterialController
GetMicrotask
GetMiddleware
The Page Middlewares. The Functions will be called in this order (( redirect -> onPageCalled -> onBindingsStart -> onPageBuildStart -> onPageBuilt -> onPageDispose ))
GetModalBottomSheetRoute<T>
GetNavConfig
This config enables us to navigate directly to a sub-url
GetNavigator
GetNotifier<T>
GetObserver
GetPage<T>
GetPageRoute<T>
GetPlatform
GetQueue
GetResponsiveView<T>
Extend this widget to build responsive view. this widget contains the screen property that have all information about the screen size and type. You have two options to build it. 1- with builder method you return the widget to build. 2- with methods desktop, tablet,phone, watch. the specific method will be built when the screen type matches the method when the screen is ScreenType.Tablet the tablet method will be exuded and so on. Note if you use this method please set the property alwaysUseBuilder to false With settings property you can set the width limit for the screen types.
GetResponsiveWidget<T extends GetLifeCycleBase?>
GetRouterOutlet
GetSnackBar
GetSnackBarState
GetSocket
GetStream<T>
GetStream is the lightest and most performative way of working with events at Dart. You sintaxe is like StreamController, but it works with simple callbacks. In this way, every event calls only one function. There is no buffering, to very low memory consumption. event add will add a object to stream. addError will add a error to stream. listen is a very light StreamSubscription interface. Is possible take the last value with value property.
GetStreamTransformation<T>
GetUtils
GetView<T>
GetView is a great way of quickly access your Controller without having to call Get.find
GetWidget<S extends GetLifeCycleBase?>
GetWidget is a great way of quickly access your individual Controller without having to call Get.find
GetX<T extends DisposableInterface>
GetxController
GetxService
Unlike GetxController, which serves to control events on each of its pages, GetxService is not automatically disposed (nor can be removed with Get.delete()). It is ideal for situations where, once started, that service will remain in memory, such as Auth control for example. Only way to remove it is Get.reset().
GetXState<T extends DisposableInterface>
GraphQLResponse<T>
HeaderValue
InstanceInfo
InternalFinalCallback<T>
Special callable class to keep the contract of a regular method, and avoid overrides if you extend the class that uses it, as Dart has no final methods. Used in DisposableInterface to avoid the danger of overriding onStart.
IOSOptions
Specific options for iOS platform.
LightSubscription<T>
LinuxOptions
Specific options for Linux platform. Currently there are no specific linux options available.
MacOsOptions
Specific options for macOS platform.
MiddlewareRunner
MiniStream<T>
MiniSubscription<T>
MixinBuilder<T extends GetxController>
MultipartFile
Node<T>
Obx
The simplest reactive widget in GetX.
ObxState
ObxValue<T extends RxInterface>
Similar to Obx, but manages a local state. Pass the initial data in constructor. Useful for simple local states, like toggles, visibility, themes, button states, etc. Sample: ObxValue((data) => Switch( value: data.value, onChanged: (flag) => data.value = flag, ), false.obs, ),
ObxWidget
The ObxWidget is the base for all GetX reactive widgets
PageRedirect
PathDecoded
PlayxCore
Core of playx_core plugin. used setup and disposing required dependencies needed for playx_core.
PlayxEnv
Wrapper for configure any the application with global variables using a .env file.
PlayxEnvSettings
Settings for PlayxEnvSettings.
PlayxPrefs
Wrapper for handling shared preferences to save and get preferences.
PlayxSecurePrefs
Wrapper for handling secure preferences to save and get preferences.
PlayxSecurePrefsSettings
Settings for PlayxSecurePrefsSettings .
Response<T>
ResponsiveScreen
ResponsiveScreenSettings
RouterOutlet<TDelegate extends RouterDelegate<T>, T extends Object>
RouterOutletState<TDelegate extends RouterDelegate<T>, T extends Object>
Routing
Rx<T>
Foundation class used for custom Types outside the common native Dart types. For example, any custom "Model" class, like User().obs will use Rx as wrapper.
RxBool
RxController
RxDouble
RxInt
RxInterface<T>
This class is the foundation for all reactive (Rx) classes that makes Get so powerful. This interface is the contract that _RxImpl]
RxList<E>
Create a list similar to List<T>
RxMap<K, V>
Rxn<T>
RxnBool
RxnDouble
RxnInt
RxnNum
RxNotifier<T>
RxnString
Rx class for String Type.
RxNum
RxSet<E>
RxStatus
RxString
Rx class for String Type.
SharedPreferences
Wraps NSUserDefaults (on iOS) and SharedPreferences (on Android), providing a persistent store for simple data.
SimpleBuilder
SimpleBuilderState
SnackbarController
SuperController<T>
TrustedCertificate
Value<T>
ValueBuilder<T>
Manages a local state like ObxValue, but uses a callback instead of a Rx value.
ValueBuilderState<T>
WebOptions
Specific options for web platform.
WindowsOptions
Specific options for Windows platform.
Worker
Workers

Enums

KeychainAccessibility
KeyChain accessibility attributes as defined here: https://developer.apple.com/documentation/security/ksecattraccessible?language=objc
KeyCipherAlgorithm
Month
PopMode
Enables the user to customize the intended pop behavior
PreventDuplicateHandlingMode
Enables the user to customize the behavior when pushing multiple routes that shouldn't be duplicates
RowStyle
ScreenType
SmartManagement
GetX by default disposes unused controllers from memory, Through different behaviors. SmartManagement.full SmartManagement.full is the default one. Dispose classes that are not being used and were not set to be permanent. In the majority of the cases you will want to keep this config untouched. If you new to GetX then don't change this. SmartManagement.onlyBuilder only controllers started in init: or loaded into a Binding with Get.lazyPut() will be disposed. If you use Get.put() or Get.putAsync() or any other approach, SmartManagement will not have permissions to exclude this dependency. With the default behavior, even widgets instantiated with "Get.put" will be removed, unlike SmartManagement.onlyBuilders. SmartManagement.keepFactoryJust like SmartManagement.full, it will remove it's dependencies when it's not being used anymore. However, it will keep their factory, which means it will recreate the dependency if you need that instance again.
SnackbarStatus
Indicates Status of snackbar SnackbarStatus.OPEN Snack is fully open, SnackbarStatus.CLOSED Snackbar has closed, SnackbarStatus.OPENING Starts with the opening animation and ends with the full snackbar display, SnackbarStatus.CLOSING Starts with the closing animation and ends with the full snackbar dispose
SnackPosition
Indicates if snack is going to start at the TOP or at the BOTTOM
SnackStyle
Indicates if snack will be attached to the edge of the screen or not
StorageCipherAlgorithm
Transition
Weekday

Mixins

EquatableMixin
A mixin that helps implement equality without needing to explicitly override operator == and hashCode.
FullLifeCycleMixin
GetLifeCycleBase
The GetLifeCycle
GetResponsiveMixin
GetSingleTickerProviderStateMixin
Used like SingleTickerProviderMixin but only with Get Controllers. Simplifies AnimationController creation inside GetxController.
GetStateUpdaterMixin<T extends StatefulWidget>
Complies with GetStateUpdater
GetTickerProviderStateMixin
Used like TickerProviderMixin but only with Get Controllers. Simplifies multiple AnimationController creation inside GetxController.
GetxServiceMixin
Allow track difference between GetxServices and GetxControllers
NotifyManager<T>
PageRouteReportMixin<T>
RxObjectMixin<T>
global object that registers against GetX and Obx, and allows the reactivity of those Widgets and Rx values.
ScrollMixin
SingleGetTickerProviderMixin
Used like SingleTickerProviderMixin but only with Get Controllers. Simplifies AnimationController creation inside GetxController.
StateMixin<T>

Extensions

BoolExtension on bool
BoolExtensions on bool
ContextColorsExtensions on BuildContext
ContextLocalizationExtensions on BuildContext
  • Localization shortcuts
  • ContextMediaQueryExtensions on BuildContext
  • MediaQuery shortcuts
  • ContextNavigatorExtensions on BuildContext
  • Navigation shortcuts
  • ContextThemeExtensions on BuildContext
    DateTimeExtensions on DateTime
    Extensions for DateTime
    DoubleExtension on double
    DurationExtensions on Duration
    Extension functions to convert duration to formatted hours, minutes, seconds and milliseconds.
    ExtensionBottomSheet on GetInterface
    ExtensionDialog on GetInterface
    ExtensionSnackbar on GetInterface
    FirstWhereExt on List<T>
    GetDurationUtils on Duration
    Duration utilities.
    GetDynamicUtils on dynamic
    GetNavigation on GetInterface
    GetNumUtils on num
    GetResetExt on GetInterface
    GetStringUtils on String
    Inst on GetInterface
    IntExtension on int
    IterableExtensions on Iterable<T>
    ListExtension on List<E>
    LocaleExtensions on Locale
    extensions on the locale
    LocalesIntl on GetInterface
    LoopEventsExt on GetInterface
    MapExtension on Map<K, V>
    NestedIterablesExtensions on Iterable<Iterable<T>>
    OverlayExt on GetInterface
    PagesListExt on List<GetPage>
    PlayxIterableExtensions on Iterable<T>
    Extensions on Iterable class to make it easier to work with.
    Precision on double
    ReactiveT on T
    RxBoolExt on Rx<bool>
    RxDoubleExt on Rx<double>
    RxIntExt on Rx<int>
    RxnBoolExt on Rx<bool?>
    RxnDoubleExt on Rx<double?>
    RxnIntExt on Rx<int?>
    RxnNumExt on Rx<T?>
    RxnStringExt on Rx<String?>
    RxNumExt on Rx<T>
    RxStringExt on Rx<String>
    RxT on T
    ScopeFunctionExtensions on T
    Extensions that can be used on any type T by using kotlin inspired scope functions.
    SetExtension on Set<E>
    StateExt on StateMixin<T>
    StringExtension on String
    StringExtensions on String
    Extension function on string.
    WidgetMarginX on Widget
    Add margin property to widget
    WidgetPaddingX on Widget
    add Padding Property to widget
    WidgetSliverBoxX on Widget
    Allows you to insert widgets inside a CustomScrollView

    Constants

    rtlLanguages → const List<String>

    Properties

    Get → _GetImpl
    final
    It replaces the Flutter Navigator, but needs no context. You can to use navigator.push(YourRoute()) rather Navigator.push(context, YourRoute());
    no setter

    Functions

    ambiguate<T>(T? value) → T?
    asBool(Map<String, dynamic>? json, String key, {bool fallback = false}) bool
    Convert any map value with key to bool or fallback safely. If fallback is not provided, it defaults to false.
    asBoolOrNull(Map<String, dynamic>? json, String key) bool?
    Convert any map value with key to bool or null safely.
    asDouble(Map<String, dynamic>? json, String key, {double fallback = 0.0}) double
    Convert any map value with key to double or fallback safely. If fallback is not provided, it defaults to 0.0.
    asDoubleOrNull(Map<String, dynamic>? json, String key) double?
    Convert any map value with key to double or null safely.
    asInt(Map<String, dynamic>? json, String key, {int fallback = 0}) int
    Convert any map value with key to int or fallback safely. If fallback is not provided, it defaults to 0.
    asIntOrNull(Map<String, dynamic>? json, String key) int?
    Convert any map value with key to int or null safely.
    asList(Map<String, dynamic>? json, String key, {List fallback = const []}) List
    Convert any map value with key to List or fallback safely. If fallback is not provided, it defaults to an empty list.
    asListFromJson<T>(Map<String, dynamic>? json, String key, T fromJson(dynamic json), {List<T> fallback = const []}) List<T>
    Convert any map value with key to List
    asListInt(Map<String, dynamic>? json, String key, {List<int> fallback = const []}) List<int>
    Convert any map value with key to List
    asListIntOrNull(Map<String, dynamic>? json, String key) List<int>?
    Convert any map value with key to List
    asListOrNull(Map<String, dynamic>? json, String key) List?
    Convert any map value with key to List or null safely.
    asListOrNullFromJson<T>(Map<String, dynamic>? json, String key, {required T fromJson(dynamic json)}) List<T>?
    Convert any map value with key to List
    asListOrNullT<T>(Map<String, dynamic>? json, String key, {required T fromJson(dynamic json)}) List<T>?
    Convert any map value with key to List
    asListString(Map<String, dynamic>? json, String key, {List<String> fallback = const []}) List<String>
    Convert any map value with key to List
    asListStringOrNull(Map<String, dynamic>? json, String key) List<String>?
    Convert any map value with key to List
    asListT<T>(Map<String, dynamic>? json, String key, {List<T> fallback = const []}) List<T>
    Convert any map value with key to List
    asMap(Map<String, dynamic>? json, String key, {Map<String, dynamic> fallback = const <String, dynamic>{}}) Map<String, dynamic>
    Convert any map value with key to Map<String, dynamic> or fallback safely. If fallback is not provided, it defaults to an empty map.
    asMapOrNull(Map<String, dynamic>? json, String key) Map<String, dynamic>?
    Convert any map value with key to Map<String, dynamic> or null safely.
    asString(Map<String, dynamic>? json, String key, {String fallback = ''}) String
    Convert any map value with key to String or fallback safely. If fallback is not provided, it defaults to an empty string.
    asStringOrNull(Map<String, dynamic>? json, String key) String?
    Convert any map value with key to String or null safely.
    asT<T>(Map<String, dynamic>? json, String key, {required T fallback}) → T
    Convert any map value with key to T or fallback safely. If fallback is not provided, it defaults to 0.
    asTOrNull<T>(Map<String, dynamic>? json, String key) → T?
    Convert any map value with key to T or null safely.
    bodyBytesToString(Stream<List<int>> bodyBytes, Map<String, String> headers) Future<String>
    debounce<T>(RxInterface<T> listener, WorkerCallback<T> callback, {Duration? time, Function? onError, void onDone()?, bool? cancelOnError}) Worker
    debounce is similar to interval, but sends the last value. Useful for Anti DDos, every time the user stops typing for 1 second, for instance. When listener emits the last "value", when time hits, it calls callback with the last "value" emitted.
    defaultLogWriterCallback(String value, {bool isError = false}) → void
    default logger from GetX
    ever<T>(RxInterface<T> listener, WorkerCallback<T> callback, {dynamic condition = true, Function? onError, void onDone()?, bool? cancelOnError}) Worker
    Called every time listener changes. As long as the condition returns true.
    everAll(List<RxInterface> listeners, WorkerCallback callback, {dynamic condition = true, Function? onError, void onDone()?, bool? cancelOnError}) Worker
    Similar to ever, but takes a list of listeners, the condition for the callback is common to all listeners, and the callback is executed to each one of them. The Worker is common to all, so worker.dispose() will cancel all streams.
    interval<T>(RxInterface<T> listener, WorkerCallback<T> callback, {Duration time = const Duration(seconds: 1), dynamic condition = true, Function? onError, void onDone()?, bool? cancelOnError}) Worker
    Ignore all changes in listener during time (1 sec by default) or until condition is met (can be a bool expression or a bool Function()), It brings the 1st "value" since the period of time, so if you click a counter button 3 times in 1 sec, it will show you "1" (after 1 sec of the first press) click counter 3 times in 1 sec, it will show you "4" (after 1 sec) click counter 2 times in 1 sec, it will show you "7" (after 1 sec).
    once<T>(RxInterface<T> listener, WorkerCallback<T> callback, {dynamic condition = true, Function? onError, void onDone()?, bool? cancelOnError}) Worker
    once() will execute only 1 time when condition is met and cancel the subscription to the listener stream right after that. condition defines when callback is called, and can be a bool or a bool Function().
    setStatusBarColor({Color color = Colors.transparent, bool isDark = false}) → void
    toBool(dynamic value, {bool fallback = false}) bool
    Convert any dynamic value to bool or fallback safely.
    toBoolOrNull(dynamic value) bool?
    Convert any dynamic value to bool or null safely.
    toDouble(dynamic value, {double fallback = 0.0}) double
    Convert any dynamic value to double or fallback safely.
    toDoubleOrNull(dynamic value) double?
    Convert any dynamic value to double or null safely.
    toInt(dynamic value, {int fallback = 0}) int
    Convert any dynamic value to int or fallback safely.
    toIntOrNull(dynamic value) int?
    Convert any dynamic value to int or null safely.
    toList(dynamic value, {List fallback = const []}) List
    Convert any dynamic value to List or fallback safely. If fallback is not provided, it defaults to an empty list.
    toListFromJson<T>(dynamic value, T fromJson(dynamic json), {List<T> fallback = const []}) List<T>
    Convert any dynamic value to List
    toListOrNull(dynamic value) List?
    Convert any dynamic value to List or null safely.
    toListOrNullFromJson<T>(dynamic value, T fromJson(dynamic json)) List<T>?
    Convert any dynamic value to List
    toListOrNullT<T>(dynamic value) List<T>?
    Convert any dynamic value to List
    toListT<T>(dynamic value, {List<T> fallback = const []}) List<T>
    Convert any dynamic value to List
    toMap(dynamic value, {Map<String, dynamic> fallback = const <String, dynamic>{}}) Map<String, dynamic>
    Convert any dynamic value to Map<String, dynamic> or fallback safely. If fallback is not provided, it defaults to an empty map.
    toMapOrNull(dynamic value) Map<String, dynamic>?
    Convert any dynamic value to Map<String, dynamic> or null safely.
    toString(dynamic value, {String fallback = ''}) String
    Convert any dynamic value to String or fallback safely.
    toStringOrNull(dynamic value) String?
    Convert any dynamic value to String or null safely.
    twoDigits(int n) String

    Typedefs

    AddSubscription<T> = FutureOr<void> Function(LightSubscription<T> subs)
    AsyncInstanceBuilderCallback<S> = Future<S> Function()
    BindingBuilderCallback = void Function()
    Condition = bool Function()
    Decoder<T> = T Function(dynamic data)
    GetControllerBuilder<T extends DisposableInterface> = Widget Function(T controller)
    GetPageBuilder = Widget Function()
    GetXControllerBuilder<T extends DisposableInterface> = Widget Function(T controller)
    InjectorBuilderCallback<S> = S Function(GetInstance)
    InstanceBuilderCallback<S> = S Function()
    LogWriterCallback = void Function(String text, {bool isError})
    VoidCallback from logs
    NotifierBuilder<T> = Widget Function(T state)
    OnTap = void Function(GetSnackBar snack)
    PrintFunctionCallback = void Function(String prefix, dynamic value, String info, {bool? isError})
    Progress = dynamic Function(double percent)
    RemoveSubscription<T> = FutureOr<bool?> Function(LightSubscription<T> subs)
    SnackbarStatusCallback = void Function(SnackbarStatus? status)
    ValueBuilderBuilder<T> = Widget Function(T snapshot, ValueBuilderUpdateCallback<T> updater)
    ValueBuilderUpdateCallback<T> = void Function(T snapshot)
    ValueUpdater<T> = T Function()
    WidgetCallback = Widget Function()
    WorkerCallback<T> = dynamic Function(T callback)