flutter_library library

Classes

AppColors
ArabicDateLocale
BackgroundTransformer
The default Transformer for Dio.
Badge
BadgeAnimation
BadgeGradient
BadgePosition
Utility class. Don't try to use it!
BadgePositioned
Utility class. Don't try to use it!
BadgeState
BadgeStyle
BallPulseFooter
球脉冲Footer
BallPulseFooterWidget
球脉冲组件
BallPulseFooterWidgetState
BallPulseHeader
球脉冲Header
BallPulseHeaderWidget
球脉冲组件
BallPulseHeaderWidgetState
BaseOptions
The base config for the Dio instance, used by Dio.options.
BasePainter
BasePickerModel
BezierBounceFooter
BezierBounceFooter
BezierBounceFooterWidget
BezierBounceFooter组件
BezierBounceFooterWidgetState
BezierCircleHeader
弹出圆圈Header
BezierCircleHeaderWidget
弹出小球组件
BezierCircleHeaderWidgetState
BezierHourGlassHeader
BezierHourGlassHeader
BezierHourGlassHeaderWidget
BezierHourGlassHeader组件
BezierHourGlassHeaderWidgetState
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.
CancelToken
Controls cancellation of Dio's requests.
CirclePainter
圆面切割
ClassicalFooter
经典Footer
ClassicalFooterWidget
经典Footer组件
ClassicalFooterWidgetState
ClassicalHeader
经典Header
ClassicalHeaderWidget
经典Header组件
ClassicalHeaderWidgetState
ColorPainter
CommonPickerModel
Connectivity
Discover network connectivity configurations: Distinguish between WI-FI and cellular, check WI-FI status and more.
CustomFooter
通用Footer构造器
CustomHeader
通用Header
CustomLayoutOption
CustomSnackBar
Popup widget that you can use by default to show some information
CustomTransition
DateLocale
DatePicker
DatePickerModel
DatePickerTheme
DateTimePickerModel
DelayTween
DeliveryHeader
气球快递Header
DeliveryHeaderWidget
气球快递组件
DeliveryHeaderWidgetState
Dio
Dio enables you to make HTTP requests easily.
DioMixin
DisposableInterface
DotSwiperPaginationBuilder
DropPainter
EasyLoading
EasyLoadingAnimation
EasyRefresh
EasyRefresh 下拉刷新,上拉加载组件
EasyRefreshController
EasyRefresh控制器
EasyRefreshSliverLoadControl
A sliver widget implementing the iOS-style pull to refresh content control.
EasyRefreshSliverRefreshControl
A sliver widget implementing the iOS-style pull to refresh content control.
EnglishDateLocale
ErrorInterceptorHandler
The handler for interceptors to handle error occurred during the request.
FastList<T>
FirstRefreshHeader
首次刷新Header
FlutterEasyLoading
Fluttertoast
Plugin to show a toast message on screen Only for android, ios and Web platforms
FlutterXUpdate
Android全量更新插件
Header
FormData
A class to create readable "multipart/form-data" streams. It can be used to submit forms and file uploads to http server.
FractionPaginationBuilder
FrenchDateLocale
FToast
Runs on dart side this has no interaction with the Native Side Works with all platforms just in two lines of code final fToast = FToast().init(context) fToast.showToast(child)
FullLifeCycleController
GermanDateLocale
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>
Header
Headers
The headers class for requests and responses.
HeaderValue
HttpClientAdapter
HttpAdapter is a bridge between Dio and HttpClient.
ImagePicker
Provides an easy way to pick an image/video from the image library, or to take a picture/video with the camera.
InstanceInfo
Interceptor
Interceptor helps to deal with RequestOptions, Response, and DioException during the lifecycle of a request before it reaches users.
Interceptors
A Queue-Model list for Interceptors.
InterceptorsWrapper
A helper class to create interceptors in ease.
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.
ItalianDateLocale
KhmerDateLocale
KoreanDateLocale
LightSubscription<T>
LinkFooterNotifier
链接通知器
LinkHeader
链接器Header
LinkHeaderNotifier
链接通知器
ListParam<T>
Indicates a param being used as queries or form data, and how does it gets formatted.
LogInterceptor
LogInterceptor is used to print logs during network requests. It should be the last interceptor added, otherwise modifications by following interceptors will not be logged. This is because the execution of interceptors is in the order of addition.
LostData
The response object of ImagePicker.retrieveLostData.
LostDataResponse
The response object of ImagePicker.getLostData.
Marquee
A widget that repeats text and automatically scrolls it infinitely.
MaterialFooter
质感设计Footer
MaterialFooterWidget
质感设计Footer组件
MaterialFooterWidgetState
MaterialHeader
质感设计Header
MaterialHeaderWidget
质感设计Header组件
MaterialHeaderWidgetState
MiddlewareRunner
MiniStream<T>
MiniSubscription<T>
MixinBuilder<T extends GetxController>
MultipartFile
A file to be uploaded as part of a MultipartRequest. This doesn't need to correspond to a physical file.
Node<T>
NonePainter
NotificationFooter
通知器Footer
NotificationHeader
通知器Header
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
OctoError
Helper class with pre-made OctoErrorBuilders. These can be directly used when creating an image. For example: OctoImage( image: NetworkImage('https://dummyimage.com/600x400/000/fff'), errorBuilder: OctoError.icon(), );
OctoImage
OctoImage can be used as a replacement of Image. It can be used with any ImageProvider, but works best with CachedNetworkImageProvider. OctoImage can show a placeholder or progress and an error. It can also do transformations on the shown image. This all can be simplified by using a complete OctoSet with predefined combinations of OctoPlaceholderBuilder, OctoImageBuilder and OctoErrorBuilder.
OctoImageTransformer
Helper class with pre-made OctoImageBuilders. These can be directly used when creating an image. For example: OctoImage( image: NetworkImage('https://dummyimage.com/600x400/000/fff'), imageBuilder: OctoImageTransformer.circleAvatar(), );
OctoPlaceholder
OctoPlaceholders are predefined OctoPlaceholderBuilders that can easily be used for the OctoImage. For example: OctoImage( image: NetworkImage('https://dummyimage.com/600x400/000/fff'), placeholderBuilder: OctoPlaceholder.circularProgressIndicator(), );
OctoProgressIndicator
Predefined set of OctoProgressIndicatorBuilders. For example: OctoImage( image: NetworkImage('https://dummyimage.com/600x400/000/fff'), progressIndicatorBuilder: OctoProgressIndicator.circularProgressIndicator(), );
OctoSet
OctoSets are predefined combinations of a OctoPlaceholderBuilder, OctoProgressIndicatorBuilder, OctoImageBuilder and/or OctoErrorBuilder. All sets have at least a placeholder or progress indicator and an error builder.
OpacityTransformBuilder
Options
Every request can pass an Options object which will be merged with Dio.options
PackageInfo
Application metadata. Provides application bundle information on iOS and application package information on Android.
PackageInfoPlusLinuxPlugin
The Linux implementation of PackageInfoPlatform.
PackageInfoPlusWindowsPlugin
The Windows implementation of PackageInfoPlatform.
PageIndicator
PageRedirect
PathDecoded
Permission
Defines the permissions which can be checked and requested.
PermissionWithService
A special kind of permission, used to access a service.
PhoenixFooter
金色校园Footer
PhoenixFooterWidget
金色校园组件
PhoenixFooterWidgetState
PhoenixHeader
金色校园Header
PhoenixHeaderWidget
金色校园组件
PhoenixHeaderWidgetState
PickedFile
A PickedFile is a cross-platform, simplified File abstraction.
Pickers
onChanged 选择器发生变动 onConfirm 选择器提交 pickerStyle 样式 suffix 后缀
PortugueseDateLocale
QuestListInfo
QuestRepeatListInfo
QueuedInterceptor
Interceptor in queue.
QueuedInterceptorsWrapper
A helper class to create queued-interceptors in ease.
RectSwiperPaginationBuilder
RedirectRecord
A record that records the redirection happens during requests, including status code, request method, and the location.
RegexConfig
RequestInterceptorHandler
The handler for interceptors to handle before the request has been sent.
RequestOptions
The internal request option class that is the eventual result after BaseOptions and Options are composed.
Response<T>
The Response class contains the payload (could be transformed) that respond from the request, and other information of the response.
ResponseBody
The response wrapper class for adapters.
ResponseInterceptorHandler
The handler for interceptors to handle after respond.
ResponsiveScreen
ResponsiveScreenSettings
RotateTransformBuilder
RouterOutlet<TDelegate extends RouterDelegate<T>, T extends Object>
RouterOutletState<TDelegate extends RouterDelegate<T>, T extends Object>
Routing
RussianDateLocale
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.
ScaleAndFadeTransformer
ScalePainter
ScaleTransformBuilder
ScrollNotificationInterceptor
滚动通知拦截器(用于拦截其他UI组件的滑动事件)
SharedPreferences
Wraps NSUserDefaults (on iOS) and SharedPreferences (on Android), providing a persistent store for simple data.
SharedPreferencesUtils
SimpleBuilder
SimpleBuilderState
SimplifiedChineseDateLocale
SizeUtil
SlidePainter
SlideTween
SnackbarController
SpanishDateLocale
SpinKitHourGlass
HourGlass 来源于flutter_spinkit
SuperController<T>
Svg
A utility class for decoding SVG data to a DrawableRoot or a PictureInfo.
SvgPicture
A widget that will parse SVG data into a Picture using a PictureProvider.
Swiper
SwiperControl
SwiperController
SwiperCustomPagination
SwiperPagination
SwiperPlugin
plugin to display swiper components
SwiperPluginConfig
SwiperPluginView
SyncTransformer
If you want to custom the transformation of request/response data, you can provide a Transformer by your self, and replace the transformer by setting the Dio.transformer.
TaskState
任务状态
TaurusFooter
冲上云霄Footer
TaurusFooterWidget
冲上云霄组件
TaurusFooterWidgetState
TaurusHeader
冲上云霄Header
TaurusHeaderWidget
冲上云霄组件
TaurusHeaderWidgetState
TbAppTheme
TbBaseGlobalization
TbBaseLogic<T extends TbBaseState>
TbBaseState
TbBaseView<T extends TbBaseLogic<TbBaseState>, E extends TbBaseState, S extends StatefulWidget>
TbBottomNavigationLogic
TbBottomNavigationState
TbBottomNavigationWidget
TbClassicalFooter
经典Footer
TbClassicalHeader
经典Header
TbHttpResult<T>
TbHttpUtils
TbSystemConfig
TbTabLayoutWidget
TbTabLayoutWidgetLogic
TbTabLayoutWidgetState
Time12hPickerModel
TimePickerModel
ToastStateFulState
State for _ToastStateFul
TopSnackBar
Widget that controls all animations
TransformBuilder<T>
Transformer
Transformer allows changes to the request/response data before it is sent/received to/from the server.
TranslateTransformBuilder
Translations
TrustedCertificate
TurkishDateLocale
UpdateEntity
版本更新信息,用于显示版本更新弹窗
UpdateInfo
默认网络请求返回的结果格式
Value<T>
ValueBuilder<T>
Manages a local state like ObxValue, but uses a callback instead of a Rx value.
ValueBuilderState<T>
VietnameseDateLocale
Wakelock
Class providing all wakelock functionality using static members.
WarmPainter
WebViewConfiguration
Additional configuration options for LaunchMode.inAppWebView.
Worker
Workers
XFile
A CrossFile is a cross-platform, simplified File abstraction.

Enums

BadgeAnimationType
This is a set of animations that you can use for your badges.Badge widget. Do not use them explicitly, use for example BadgeAnimation.slide() instead.
BadgeShape
Set of shapes that you can use for your badges.Badge widget.
CameraDevice
Which camera to use when picking images/videos while source is ImageSource.camera.
ConnectivityResult
Connection status check result.
DioExceptionType
The exception enumeration indicates what type of exception has happened during requests.
EasyLoadingAnimationStyle
loading animation
EasyLoadingIndicatorType
loading indicator type. see https://github.com/jogboms/flutter_spinkit#-showcase
EasyLoadingMaskType
loading mask type none default mask type, allow user interactions while loading is displayed clear don't allow user interactions while loading is displayed black don't allow user interactions while loading is displayed custom while mask type is custom, maskColor should not be null
EasyLoadingStatus
loading status
EasyLoadingStyle
loading style
EasyLoadingToastPosition
toast position
ImageSource
Specifies the source where the picked image should come from.
LaunchMode
The desired mode to launch a URL.
ListFormat
Specifies the array format (a single parameter with multiple parameter or multiple parameters with the same name). and the separator for array items.
LoadMode
The current state of the refresh control.
LocaleType
MemoryUnit
PageIndicatorLayout
PermissionStatus
Defines the state of a Permission.
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
QuestMethod
QuestStatus
RefreshMode
The current state of the refresh control.
ResponseType
Indicates which transformation should be applied to the response data.
RetrieveType
The type of the retrieved data in a LostDataResponse.
RowStyle
ScreenDirect
ScreenType
ServiceStatus
Defines the different states a service can be in.
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
SwiperLayout
TimeUnit
Toast
Toast Length Only for Android Platform
ToastGravity
ToastGravity Used to define the position of the Toast on the screen
Transition

Mixins

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>
OptionsMixin
The mixin class for options that provides common attributes.
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
ContextExtensionss on BuildContext
customMap on Map<int, String>
DoubleExtension on double
DoubleFit on double
ExtensionBottomSheet on GetInterface
ExtensionDialog on GetInterface
ExtensionSnackbar on GetInterface
FirstWhereExt on List<T>
FuturePermissionStatusGetters on Future<PermissionStatus>
Utility getter extensions for the Future<PermissionStatus> type.
FutureServiceStatusGetters on Future<ServiceStatus>
Utility getter extensions for the Future<ServiceStatus> type.
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
IntFit on int
IterableExtensions on Iterable<T>
ListExtension on List<E>
LocalesIntl on GetInterface
LoopEventsExt on GetInterface
MapExtension on Map<K, V>
OverlayExt on GetInterface
PagesListExt on List<GetPage>
PermissionActions on Permission
Actions that can be executed on a permission.
PermissionCheckShortcuts on Permission
Shortcuts for checking the status of a Permission.
PermissionListActions on List<Permission>
Actions that can be taken on a List of Permissions.
PermissionStatusGetters on PermissionStatus
Utility getter extensions for the PermissionStatus type.
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
ServicePermissionActions on PermissionWithService
Actions that apply only to permissions that have an associated service.
ServiceStatusGetters on ServiceStatus
Utility getter extensions for the ServiceStatus type.
SetExtension on Set<E>
StateExt on StateMixin<T>
StringExtension on String
Trans 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

am → const String
Outputs if hour is AM or PM
d → const String
Outputs day compactly
D → const String
Outputs week day as long name
dd → const String
Outputs day as two digits
DD → const String
Outputs week day as long name
escape → const String
Escape delimiters to be used as normal string.
h → const String
Outputs hour (0 - 11) compactly
H → const String
Outputs hour (0 to 23) compactly
HAVE_NEW_VERSION → const int
1:有版本更新,不需要强制升级
HAVE_NEW_VERSION_FORCED_UPLOAD → const int
2:有版本更新,需要强制升级
hh → const String
Outputs hour (0 - 11) as two digits
HH → const String
Outputs hour (0 to 23) as two digits
kDefaultAutoplayDelayMs → const int
default auto play delay
kDefaultAutoplayTransactionDuration → const int
Default auto play transition duration (in millisecond)
kDefaultBorderRadius → const BorderRadius
kDefaultBoxShadow → const List<BoxShadow>
kMaxValue → const int
kMiddleValue → const int
kTypeImage → const String
Denotes that an image is being picked.
kTypeVideo → const String
Denotes that a video is being picked.
m → const String
Outputs month compactly
M → const String
Outputs month as short name
mm → const String
Outputs month as two digits
MM → const String
Outputs month as long name
n → const String
Outputs minute compactly
nn → const String
Outputs minute as two digits
NO_NEW_VERSION → const int
0:无版本更新
rtlLanguages → const List<String>
S → const String
Outputs millisecond compactly
s → const String
Outputs second compactly
ss → const String
Outputs second as two digits
SSS → const String
Outputs millisecond as three digits
u → const String
Outputs millisecond compactly
uuu → const String
Outputs microsecond as three digits
W → const String
Outputs week in year compactly
w → const String
Outputs week in month
WW → const String
Outputs week in year as two digits
yy → const String
Outputs year as two digits
yyyy → const String
Outputs year as four digits
z → const String
Outputs timezone as time offset
Z → const 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
svg Svg
Instance for Svg's utility methods, which can produce a DrawableRoot or PictureInfo from String or Uint8List.
final
wakelockPlatformInstance ↔ WakelockPlatformInterface
The WakelockPlatformInterface that is used by Wakelock.
getter/setter pair

Functions

ambiguate<T>(T? value) → T?
bodyBytesToString(Stream<List<int>> 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.
canLaunchUrl(Uri url) Future<bool>
Checks whether the specified URL can be handled by some app installed on the device.
closeInAppWebView() Future<void>
Closes the current in-app web view, if one was previously opened by launchUrl.
closeWebView() Future<void>
Closes the current WebView, if one was previously opened via a call to launch.
dayInYear(DateTime date) int
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.
formatDate(DateTime date, List<String> formats, {DateLocale locale = const EnglishDateLocale()}) String
FToastBuilder() TransitionBuilder
Simple builder method to create a TransitionBuilder and for the use in MaterialApp builder method
i18nObjInLocale(LocaleType? localeType) Map<String, Object>
Get international object for localeType
i18nObjInLocaleLookup(LocaleType localeType, String key, int index) String
Get international lookup for a localeType, key and index.
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 = false, bool enableJavaScript = false, bool enableDomStorage = false, bool universalLinksOnly = false, Map<String, String> headers = const <String, String>{}, Brightness? statusBarBrightness, String? webOnlyWindowName}) Future<bool>
Parses the specified URL string and delegates handling of it to the underlying platform.
launchUrl(Uri url, {LaunchMode mode = LaunchMode.platformDefault, WebViewConfiguration webViewConfiguration = const WebViewConfiguration(), String? webOnlyWindowName}) Future<bool>
Passes url to the underlying platform for handling.
log(String str) → dynamic
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().
openAppSettings() Future<bool>
Opens the app settings page.
precachePicture(PictureProvider provider, BuildContext? context, {Rect? viewBox, ColorFilter? colorFilterOverride, Color? color, BlendMode? colorBlendMode, PictureErrorListener? onError}) Future<void>
Prefetches an SVG Picture into the picture cache.
showCustomTopSnackBar(String str) → dynamic
showTopSnackBar(BuildContext context, Widget child, {Duration showOutAnimationDuration = const Duration(milliseconds: 1200), Duration hideOutAnimationDuration = const Duration(milliseconds: 550), Duration displayDuration = const Duration(milliseconds: 3000), double additionalTopPadding = 16.0, VoidCallback? onTap, OverlayState? overlayState, double leftPadding = 16, double rightPadding = 16, bool persistent = false, ControllerCallback? onAnimationControllerInit}) → void
Displays a widget that will be passed to child parameter above the current contents of the app, with transition animation
supportsCloseForLaunchMode(LaunchMode mode) Future<bool>
Returns true if closeInAppWebView is supported for mode in the current platform implementation.
supportsLaunchMode(LaunchMode mode) Future<bool>
Returns true if mode is supported by the current platform implementation.
tbGetBuilder<T extends TbBaseLogic<TbBaseState>>({Key? key, String? tag, Object? id, dynamic assignId = true, GestureTapCallback? onTap, required BackWidget builder}) Widget
tbInitProxy() → void
tbInitScreenDirect({ScreenDirect portrait = ScreenDirect.portrait}) → dynamic
tbRefreshCustomWidget<T extends TbBaseLogic<TbBaseState>>({required T? logic, required List<Widget> slivers, bool enableInfiniteLoad = false, bool openRefresh = true, bool openLoad = true, bool isDark = true}) Widget
tbRefreshWidget<T extends TbBaseLogic<TbBaseState>>({required T? logic, required Widget child, bool enableInfiniteLoad = false, bool openRefresh = true, bool openLoad = true, bool isDark = true}) Widget
tbSetStatusWidget({Widget? child, GestureTapCallback? onTap}) Widget
tbShowToast(String msg, {ToastGravity? gravity, Color? backgroundColor, Color? textColor, double? fontSize}) → dynamic

Typedefs

AddSubscription<T> = FutureOr<void> Function(LightSubscription<T> subs)
AsyncInstanceBuilderCallback<S> = Future<S> Function()
BackWidget = Widget Function()
BindingBuilderCallback = void Function()
BindLoadIndicator = void Function(FinishLoad finishLoad, VoidCallback resetLoadState)
绑定加载指示剂
BindRefreshIndicator = void Function(FinishRefresh finishRefresh, VoidCallback resetRefreshState)
绑定刷新指示剂
Condition = bool Function()
ControllerCallback = void Function(AnimationController)
DateCancelledCallback = dynamic Function()
DateChangedCallback = dynamic Function(DateTime time)
Decoder<T> = T Function(dynamic data)
DefaultTransformer = SyncTransformer
DioError = DioException
DioError describes the exception info when a request failed.
DioErrorType = DioExceptionType
Deprecated in favor of DioExceptionType and will be removed in future major versions.
EasyLoadingStatusCallback = void Function(EasyLoadingStatus status)
EasyRefreshChildBuilder = Widget Function(BuildContext context, ScrollPhysics physics, Widget? header, Widget? footer)
子组件构造器
ErrorHandler = Future Function(Map<String, dynamic>? event)
FinishLoad = void Function({bool noMore, bool success})
结束加载 success 为是否成功(为false时,noMore无效) noMore 为是否有更多数据
FinishRefresh = void Function({bool noMore, bool success})
结束刷新 success 为是否成功(为false时,noMore无效) noMore 为是否有更多数据
GetControllerBuilder<T extends DisposableInterface> = Widget Function(T controller)
GetPageBuilder = Widget Function()
GetXControllerBuilder<T extends DisposableInterface> = Widget Function(T controller)
HeaderForEachCallback = void Function(String name, List<String> values)
The signature that iterates header fields.
InjectorBuilderCallback<S> = S Function(GetInstance)
InstanceBuilderCallback<S> = S Function()
InterceptorErrorCallback = void Function(DioException error, ErrorInterceptorHandler handler)
The signature of Interceptor.onError.
InterceptorSendCallback = void Function(RequestOptions options, RequestInterceptorHandler handler)
The signature of Interceptor.onRequest.
InterceptorSuccessCallback = void Function(Response response, ResponseInterceptorHandler handler)
The signature of Interceptor.onResponse.
JsonDecodeCallback = FutureOr Function(String)
The callback definition for decoding a JSON string.
JsonEncodeCallback = FutureOr<String> Function(Object)
The callback definition for encoding a JSON object.
LoadControlBuilder = Widget Function(BuildContext context, LoadMode loadState, double pulledExtent, double loadTriggerPullDistance, double loadIndicatorExtent, AxisDirection axisDirection, bool float, Duration? completeDuration, bool enableInfiniteLoad, bool success, bool noMore)
Signature for a builder that can create a different widget to show in the refresh indicator space depending on the current state of the refresh control and the space available.
LogWriterCallback = void Function(String text, {bool isError})
VoidCallback from logs
NotifierBuilder<T> = Widget Function(T state)
OctoErrorBuilder = Widget Function(BuildContext context, Object error, StackTrace? stackTrace)
OctoImageBuilder = Widget Function(BuildContext context, Widget child)
OctoPlaceholderBuilder = Widget Function(BuildContext context)
OctoProgressIndicatorBuilder = Widget Function(BuildContext context, ImageChunkEvent? progress)
OnLoadCallback = Future<void> Function()
A callback function that's invoked when the EasyRefreshSliverLoadControl is pulled a loadTriggerPullDistance. Must return a Future. Upon completion of the Future, the EasyRefreshSliverLoadControl enters the LoadMode.done state and will start to go away.
OnRefreshCallback = Future<void> Function()
A callback function that's invoked when the EasyRefreshSliverRefreshControl is pulled a refreshTriggerPullDistance. Must return a Future. Upon completion of the Future, the EasyRefreshSliverRefreshControl enters the RefreshMode.done state and will start to go away.
OnTap = void Function(GetSnackBar snack)
ParseHandler = Future<UpdateEntity> Function(String? json)
PositionedToastBuilder = Widget Function(BuildContext context, Widget child)
Signature for a function to buildCustom Toast
PrintFunctionCallback = void Function(String prefix, dynamic value, String info, {bool? isError})
Progress = dynamic Function(double percent)
ProgressCallback = void Function(int count, int total)
QuestError = dynamic Function(dynamic onError)
QuestFailed = dynamic Function(dynamic code, dynamic msg, int taskId)
QuestSuccess = dynamic Function(dynamic result, int taskId)
RefreshControlBuilder = Widget Function(BuildContext context, RefreshMode refreshState, double pulledExtent, double refreshTriggerPullDistance, double refreshIndicatorExtent, AxisDirection axisDirection, bool float, Duration? completeDuration, bool enableInfiniteRefresh, bool success, bool noMore)
Signature for a builder that can create a different widget to show in the refresh indicator space depending on the current state of the refresh control and the space available.
RefreshFooterClass = Footer Function()
RefreshHeaderClass = Header Function()
RemoveSubscription<T> = FutureOr<bool?> Function(LightSubscription<T> subs)
RequestEncoder = FutureOr<List<int>> Function(String request, RequestOptions options)
The type of a request encoding callback.
ResponseDecoder = FutureOr<String?> Function(List<int> responseBytes, RequestOptions options, ResponseBody responseBody)
The type of a response decoding callback.
SnackbarStatusCallback = void Function(SnackbarStatus? status)
StatusWidget = Widget Function()
StringAtIndexCallBack = String? Function(int index)
SwiperDataBuilder = Widget Function(BuildContext context, dynamic data, int index)
SwiperOnTap = void Function(int index)
SwiperPaginationBuilder = Widget Function(BuildContext context, SwiperPluginConfig config)
ValidateStatus = bool Function(int? status)
The type of a response status code validate callback.
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)

Exceptions / Errors

DioException
DioException describes the exception info when a request failed.
NotNullableError<T>
A TypeError thrown by _checkNotNullable.