get_smart library

Classes

AppLifecycle
States that an application can be in. [...]
AppLineSeparator
AppTile
AppTileData
AppTileHeader
AppTileRow
AppTileSeparator
AutoCompleteTextField<T>
AutoCompleteTextFieldState<T>
AutoSizeGroup
Controller to synchronize the fontSize of multiple AutoSizeTexts.
AutoSizeText
Flutter widget that automatically resizes text to fit perfectly within its bounds. [...]
BaseGetController
Contains ViewModel functionality for busy state management
Bidi
This provides utility methods for working with bidirectional text. All of the methods are static, and are organized into a class primarily to group them together for documentation and discoverability.
BidiFormatter
Bidi stands for Bi-directional text. According to Wikipedia: Bi-directional text is text containing text in both text directionalities, both right-to-left (RTL) and left-to-right (LTR). It generally involves text containing different types of alphabets, but may also refer to boustrophedon, which is changing text directionality in each row. [...]
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. [...]
BoolTransform
BottomBar
CircularProgress
Clickable
CrossFade
CustomTransition
DateFormat
DateFormat is for formatting and parsing dates in a locale-sensitive manner. [...]
DateTransform
DateUnit
Density
DismissibleX
DisposableInterface
Div
DotsDecorator
DotsIndicator
DottedPageView
DynamicSourceGetController<T>
Enumerable<T>
EnumTransform<Object extends Enumerable, JSON>
FastList<T>
FloatFormatter
Formatter
FormData
FullLifeCycleController
FutureGetController<T>
Provides functionality for a ViewModel that's sole purpose it is to fetch data using a Future
GET
GetBar<T extends Object>
GetBuilder<T extends GetxController>
GetButton
The factory class class for buttons whose style are defined by a ButtonStyle object. Buttons included are: [...]
GetCipher
GetColors
GetConnect
GetConnectInterface
GetController
Multi purpose ViewModel implementation of GetxController
GetCupertinoApp
GetHttpClient
GetInstance
GetInterface
GetInterface allows any auxiliary package to be merged into the "Get" class through extensions
GetLifeCycle
GetLocalizations
Platform localization to add multi-language support [...]
GetLocalizationsDelegate
Platform localization delegate to trigger language change in the device
GetMaterialApp
GetMaterialController
GetMicrotask
GetMiddleware
The Page Middlewares. The Functions will be called in this order (( redirect -> onPageCalled -> onBindingsStart -> onPageBuildStart -> onPageBuilt -> onPageDispose ))
GetModalBottomSheetRoute<T>
GetNotifier<T>
GetObserver
GetPage
GetPageRoute<T>
GetPlatform
GetPlatformChannel
GetPrefs
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.
GetRouteObserver
Route observer for listening any changes happening in the navigation.
GetScaffold
A smart scaffold. All individual pages should be wrapped in it.
GetShimmer
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>
GetTheme
All app themes to be used in the app should be defined here
GetUtils
GetView<T>
GetView is a great way of quickly access your Controller without having to call Get.find() yourself. [...]
GetWebAPI
GetWidget<S extends GetLifeCycleBase>
GetWidget is a great way of quickly access your individual Controller without having to call Get.find() yourself. Get save you controller on cache, so, you can to use Get.create() safely GetWidget is perfect to multiples instance of a same controller. Each GetWidget will have your own controller, and will be call events as onInit and onClose when the controller get in/get out on memory.
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
IconBox
IndexTrackingGetController
Initialisable
Interface: Additional actions that should be implemented by spcialised ViewModels
InstanceInfo
IntFormatter
Intl
The Intl class provides a common entry point for internationalization related tasks. An Intl instance can be created for a particular locale and used to create a date format via anIntl.date(). Static methods on this class are also used in message formatting. [...]
LightSubscription<T>
LinearProgress
Mappable
Mapper
MessageView
MicroMoney
Used primarily for currency formatting, this number-like class stores millionths of a currency unit, typically as an Int64. [...]
MiddlewareRunner
MiniStream<T>
MiniSubscription<T>
MixinBuilder<T extends GetxController>
MultipartFile
MultipleFutureGetController
Provides functionality for a ViewModel to run and fetch data using multiple future
MultipleStreamGetController
Provides functionality for a ViewModel to run and fetch data using multiple streams
Node<T>
NumberFormat
Provides the ability to format a number in a locale-specific way. [...]
Obx
The simplest reactive widget in GetX. [...]
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
PrintFormat
ProgressButton
ProgressSnackBar
RawRepresentable<RawValue>
Response<T>
Responsive
ResponsiveScreen
ResponsiveScreenSettings
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
Rx class for bool Type.
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<T> uses in all it's subclass.
RxList<E>
Create a list similar to List<T>
RxMap<K, V>
RxNotifier<T>
RxNum
RxSet<E>
RxStatus
RxString
Rx class for String Type.
RxValue<T>
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, ),
Shimmer
A widget renders shimmer effect over child widget tree. [...]
SimpleAutoCompleteTextField
SimpleBuilder
SnackBarX
SnackRoute<T>
StreamData<T>
StreamGetController<T>
StringFormatter
SuperController<T>
SwipeRefresh
TextDirection
Bidi stands for Bi-directional text. According to http://en.wikipedia.org/wiki/Bi-directional_text: Bi-directional text is text containing text in both text directionalities, both right-to-left (RTL) and left-to-right (LTR). It generally involves text containing different types of alphabets, but may also refer to boustrophedon, which is changing text directionality in each row. [...]
TextFormFieldX
Transformable<Object, JSON>
Translations
TrustedCertificate
Value<T>
ValueBuilder<T>
Manages a local state like ObxValue, but uses a callback instead of a Rx value. [...]
WebMappable
WebResponse<T>
Worker
Workers

Mixins

FullLifeCycle
GetLifeCycleBase
The GetLifeCycle [...]
GetStateUpdaterMixin<T extends StatefulWidget>
Complies with GetStateUpdater [...]
GetxServiceMixin
Allow track difference between GetxServices and GetxControllers
NotifyManager<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

AssetX
Asset directories mapping for easy access. [...]
Bool
BoolExtension
ColorX
ContextExtensionss
ContextX
Date
Double
DoubleExtension
ExtensionBottomSheet
ExtensionDialog
ExtensionSnackbar
FocusNodeX
GetBoxDecoration
GetDurationUtils
Duration utilities.
GetDynamicUtils
GetNavigation
GetNumUtils
GetStringUtils
GetTextX
Extending GetText for localization support
GlobalKeyX
Inst
Int
IntExtension
ListExtension
ListX
LocalesIntl
LoopEventsExt
MapExtension
MapperX
MediaQueryX
ObjectX
Precision
ReactiveT
RxT
SetExtension
StateExt
StringExtension
StringX
TextInputFilter
TextInputTypeX
TextStyleX
Trans
UrlExt
WidgetMarginX
Add margin property to widget
WidgetPaddingX
add Padding Property to widget
WidgetSliverBoxX
Allows you to insert widgets inside a CustomScrollView
WidgetX

Constants

rtlLanguages → const List<String>
const <String>['ar', 'fa', 'he', 'ps', 'ur']

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());
read-only
sprintf PrintFormat
read / write

Functions

bodyBytesToString(BodyBytesStream bodyBytes, Map<String, String> headers) Future<String>
canLaunch(String urlString) Future<bool>
Checks whether the specified URL can be handled by some app installed on the device. [...]
closeWebView() Future<void>
Closes the current WebView, if one was previously opened via a call to launch. [...]
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). [...]
launch(String urlString, {bool forceSafariVC, bool forceWebView, bool enableJavaScript, bool enableDomStorage, bool universalLinksOnly, Map<String, String> headers, Brightness statusBarBrightness, String webOnlyWindowName}) Future<bool>
Parses the specified URL string and delegates handling of it to the underlying platform. [...]
nameOf(Type type) String
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(). [...]
openTimePicker(BuildContext context, {DateTime withTime, TimePickerEntryMode entryMode, String cancelText, String confirmText, String helpText, dynamic onPick(DateTime time)}) Future<void>
ordinalDayFromMarchFirst(int month, int day) int
Return the day of the year counting March 1st as 1, after which the number of days per month is constant, so it's easier to calculate. Formula from http://en.wikipedia.org/wiki/Ordinal_date
profileTask<T>(Future<T> task()) Future<T>
routeOf(Type type) String
scheduleTask<T>(T task()) Future<T>
toBeginningOfSentenceCase(String input, [String locale]) String
Convert a string to beginning of sentence case, in a way appropriate to the locale. [...]

Enums

GetText
Get text keys
MappingType
ScreenType
SeparatorStyle
ShimmerDirection
An enum defines all supported directions of shimmer effect [...]
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.onlyBuilders 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
SnackDismissDirection
Indicates the direction in which it is possible to dismiss If vertical, dismiss up will be allowed if SnackPosition.TOP If vertical, dismiss down will be allowed if SnackPosition.BOTTOM
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
Transition
ValueType
WebMethod
WebStatus

Typedefs

AddSubscription<T>(LightSubscription<T> subs) FutureOr<void>
AsyncInstanceBuilderCallback<S>() Future<S>
AutoCompleteOverlayItemBuilder<T>(BuildContext context, T suggestion, Function onTap) Widget
BindingBuilderCallback() → void
Condition() bool
Decoder<T>(dynamic data) → T
Filter<T>(T suggestion, String query) bool
GetControllerBuilder<T extends DisposableInterface>(T controller) Widget
GetPageBuilder() Widget
GetXControllerBuilder<T extends DisposableInterface>(T controller) Widget
InjectorBuilderCallback<S>(GetInstance) → S
InputEventCallback<T>(T data) → dynamic
InstanceBuilderCallback<S>() → S
LogWriterCallback(String text, {bool isError}) → void
Voidcallback from logs
MappingSetter(dynamic value) → void
NotifierBuilder<T>(T state) Widget
OnTap(GetBar<Object> snack) → void
PrintFormatFormatter(dynamic arg, dynamic options) Formatter
PrintFunctionCallback(String prefix, dynamic value, String info, {bool isError}) → void
Progress(double percent) → dynamic
RemoveSubscription<T>(LightSubscription<T> subs) FutureOr<bool>
SnackbarStatusCallback(SnackbarStatus status) → void
StringCallback(String data) → dynamic
ValueBuilderBuilder<T>(T snapshot, ValueBuilderUpdateCallback<T> updater) Widget
ValueBuilderUpdateCallback<T>(T snapshot) → void
ValueUpdater<T>() → T
WidgetCallback() Widget
WorkerCallback<T>(T callback) → dynamic