flutter_clx_base library

Classes

AppScrollBehavior
How we can use this For swipe with mouse, we need to change default scroll behavior of app. Pass an AppScrollBehavior instance to scrollBehavior property of MaterialApp: MaterialApp( scrollBehavior: AppScrollBehavior(), );
BaseOptions
The common config for the Dio instance. dio.options is a instance of BaseOptions
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
You can cancel a request by using a cancel token. One token can be shared with different requests. when a token's cancel method invoked, all requests with this token will be cancelled.
CheckboxData
ChipData
CirclePainter
CustomTransition
DateFormats
一些常用格式参照。可以自定义格式,例如:'yyyy/MM/dd HH:mm:ss','yyyy/M/d HH:mm:ss'。 格式要求 year -> yyyy/yy month -> MM/M day -> dd/d hour -> HH/H minute -> mm/m second -> ss/s
DateUtil
Date Util.
DefaultTransformer
Dio
A powerful Http client for Dart, which supports Interceptors, Global configuration, FormData, File downloading etc. and Dio is very easy to use.
DioMixin
DirectoryUtil
DirectoryUtil。
DisposableInterface
EasyLoading
EasyLoadingAnimation
EncryptUtil
Encrypt Util.
EnInfo
EnNormalInfo
ErrorInterceptorHandler
Handler for error interceptor.
FastList<T>
FlutterEasyLoading
FormData
A class to create readable "multipart/form-data" streams. It can be used to submit forms and file uploads to http server.
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>
GFAccordion
GFAlert
GFAnimation
GFAppBar
An app bar consists of a toolbar and potentially other widgets, such as a TabBar and a FlexibleSpaceBar. The GFAppBar displays the toolbar widgets, leading, title, and actions, above the bottom (if any). The bottom is usually used for a TabBar.
GFAppBarTitleBar
GFAvatar
GFBadge
GFBadgePosition
GFBadgePosition is used to position the badges to top start, top bottom, bottom start or bottom end of the icon button See GFIconBadge
GFBorder
GFBottomSheet
GFBottomSheetController
GFButton
GFButtonBadge
GFButtonBar
GFCard
A material design card. A card has slightly rounded corners and a shadow.
GFCarousel
GFCheckbox
GFCheckboxListTile
GFColors
GfDatePicker
GFDrawer
A material design panel that slides in horizontally from the edge of a Scaffold to show navigation links in an application.
GFDrawerHeader
A material design Drawer header that identifies the app's user. Requires one of its ancestors to be a Material widget.
GFDrawerHeaderPictures
GFDropdown<T>
GFFloatingWidget
GfForm
GfFormDropDown
GfFormField
GfFormGenderbutton
GfFormQuestionWidget
GfFormValidators
GFIconBadge
GFIconButton
GFImageOverlay
Creates a image widget with shaded overlay.
GFIntroScreen
GFIntroScreenBottomNavigationBar
GFItemsCarousel
GFListTile
GFLoader
GfMultiCheckbox
GfMultiCheckboxData
GfMultiChipSelectData
GfMultiChoiceChip
GFMultiSelect<T>
GFProgressBar
GFRadio<T>
GFRadioListTile<T>
GFRating
GFSearchBar<T>
GFSegmentTabs
Creates pills like structured tab bar. See GFTabBar GFSegmentTabs are best used as an alternative for GFTabBar.
GFShimmer
GFShimmerFilter
GFSize
GFSize is used to change the size of the widget.
GFSocialButton
GFStickyHeader
GFStickyHeaderBuilder
GFTabBar
A material design widget that displays a horizontal row of tabs.
GFTabBarView
A page view that displays the widget which corresponds to the currently selected tab. This widget is typically used in conjunction with a GFTabBar or GFSegmentTabs.
GFTabs
GFTextField
GFTextFieldPill
GFTextFieldRounded
GFTextFieldSquared
GfTimePicker
GFToast
GFToggle
A toggle button allows the user to change a setting between two states.
GFTypography
GraphQLResponse<T>
Headers
HeaderValue
HttpClientAdapter
HttpAdapter is a bridge between Dio and HttpClient.
ImageUtil
Image Util.
ImageUtils
ImageWidget
InstanceInfo
Interceptor
Dio instance may have interceptor(s) by which you can intercept requests/responses/errors before they are handled by then or catchError. See also:
Interceptors
Interceptors are a queue, and you can add any number of interceptors, All interceptors will be executed in first in first out order.
InterceptorsWrapper
InterceptorsWrapper is a helper class, which is used to conveniently create interceptor(s). See also:
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.
JsonUtil
Json Util.
KeyBoardUtils
LightSubscription<T>
LinearPainter
ListParam<T>
Loader
LoadingUtils
Lock
Add lock/unlock API for interceptors.
LogInterceptor
LogInterceptor is used to print logs during network requests. It's better to add LogInterceptor to the tail of the interceptor queue, otherwise the changes made in the interceptor behind A will not be printed out. This is because the execution of interceptors is in the order of addition.
LogUtil
Log Util.
MiddlewareRunner
MiniStream<T>
MiniSubscription<T>
MixinBuilder<T extends GetxController>
MoneyUtil
Money Util.
MultipartFile
A file to be uploaded as part of a MultipartRequest. This doesn't need to correspond to a physical file.
MyOctoImageTransformer
MyPageAppBar
MyScaffold
MyScrollView
本项目通用的布局(SingleChildScrollView) 1.底部存在按钮 2.底部没有按钮
MySingleChoiceSearchState<T>
Node<T>
NumUtil
Num Util.
ObjectUtil
Object Util.
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
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.
PageRedirect
PathDecoded
QueuedInterceptor
Serialize the request/response/error before they enter the interceptor.
QueuedInterceptorsWrapper
QueuedInterceptorsWrapper is a helper class, which is used to conveniently create QueuedInterceptor(s). See also:
RedirectRecord
RegexUtil
Regex Util.
RenderGFAppBarTitleBar
RenderGFStickyHeader
RequestInterceptorHandler
Handler for request interceptor.
RequestOptions
Response<T>
Response describes the http Response info.
ResponseBody
ResponseInterceptorHandler
Handler for response interceptor.
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.
ScreenUtil
Screen Util.
SearchAppBar
SimpleBuilder
SimpleBuilderState
SnackbarController
SpUtil
SharedPreferences Util.
SuperController<T>
TextUtil
Text Util.
TimelineInfo
Timeline information configuration. Timeline信息配置.
TimelineUtil
TimelineUtil
TimerUtil
TimerUtil.
ToastCard
ToastStateFulState
ToastUtil
ToastView
Transformer
Transformer allows changes to the request/response data before it is sent/received to/from the server.
Translations
TrustedCertificate
Value<T>
ValueBuilder<T>
Manages a local state like ObxValue, but uses a callback instead of a Rx value.
ValueBuilderState<T>
WidgetUtil
Widget Util.
Worker
Workers
ZhInfo
ZhNormalInfo

Enums

DayFormat
(xx)Configurable output. (xx)为可配置输出.
DioErrorType
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
GFAlertType
GFAnimationType
GFAvatarShape
GFAvatarShape is used to shape the GFAvatar widget.
GFBadgeShape
GFBadgeShape is used to shape the GFBadge widget.
GFBorderType
GFButtonShape
GFButtonShape is used to shape the GFButton widget.
GFButtonType
GFButtonType is used to change the type of widgets
GFCheckboxType
GFDrawerAlignment
The possible alignments of a GFDrawer.
GfFormFieldType
GFIconButtonShape
GFIconButtonShape is used to shape the GFIconButton widget.
GFLoaderType
GFPosition
GFPosition is used to position the icon, badges to start or end of the button See GFButton and GFButtonBadge
GFProgressHeadType
GFProgressType
GFRadioType
GFShimmerDirection
GFShimmerDirection controls the direction of the shimmer effect
GFToastPosition
ToastPosition Used to define the position of the Toast on the screen See GFToast
GFToastType
GFToggleType
GFToggleType is used to change the shape of
GFTypographyType
GFTypographyType is used to change the type of GFTypography title widget.
ImageTransformerType
ListFormat
ListFormat specifies the array format (a single parameter with multiple parameter or multiple parameters with the same name) and the separator for array items.
MoneyFormat
MoneyUnit
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
ResponseType
ResponseType indicates which transformation should be automatically applied to the response data by Dio.
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
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
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>

Constants

empty → const Widget
hGap10 → const Widget
hGap110 → const Widget
hGap12 → const Widget
hGap14 → const Widget
hGap15 → const Widget
hGap16 → const Widget
hGap2 → const Widget
水平间隔
hGap20 → const Widget
hGap32 → const Widget
hGap4 → const Widget
hGap40 → const Widget
hGap5 → const Widget
hGap50 → const Widget
hGap60 → const Widget
hGap65 → const Widget
hGap8 → const Widget
rtlLanguages → const List<String>
vGap1 → const Widget
垂直间隔
vGap10 → const Widget
vGap12 → const Widget
vGap15 → const Widget
vGap150 → const Widget
vGap16 → const Widget
vGap2 → const Widget
vGap20 → const Widget
vGap24 → const Widget
vGap25 → const Widget
vGap3 → const Widget
vGap30 → const Widget
vGap32 → const Widget
vGap4 → const Widget
vGap5 → const Widget
vGap50 → const Widget
vGap60 → const Widget
vGap70 → const Widget
vGap8 → const Widget
vGap80 → const Widget

Properties

Get → _GetImpl
final
ID_CARD_PROVINCE_DICT List<String>
id card province dict.
getter/setter pair
logger ↔ Logger
getter/setter pair
loggerNoStack ↔ Logger
getter/setter pair
MONTH_DAY Map<int, int>
month->days.
getter/setter pair
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?
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.
findOtherLogic<S>() → S?
formatDouble(dynamic number, {dynamic nullTxt = "-"}) String
formatDoubleZero(dynamic number) String
formatInt(dynamic number, {dynamic nullTxt = "-"}) String
formatIntZero(dynamic number) String
getTXTString(dynamic data) String
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).
line({dynamic height = 1.0, Color? color}) Widget
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().
setDesignWHD(double? w, double? h, {double? density = 3.0}) → void
配置设计稿尺寸 屏幕 宽,高,密度。 Configuration design draft size screen width, height, density.
setInitDir({bool? initTempDir, bool? initAppDocDir, bool? initAppSupportDir, bool? initStorageDir}) → void
配置初始化Directory。
setLocaleInfo(String locale, TimelineInfo timelineInfo) → void
add custom configuration.
vLine({double? width, double? height, Color? color}) Widget

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)
EasyLoadingStatusCallback = void Function(EasyLoadingStatus status)
GetControllerBuilder<T extends DisposableInterface> = Widget Function(T controller)
GetPageBuilder = Widget Function()
GetXControllerBuilder<T extends DisposableInterface> = Widget Function(T controller)
GFItemsCarouselSlideCallback = void Function(DragUpdateDetails details)
When a pointer that is in contact with the screen and moving has moved again.
GFItemsCarouselSlideEndCallback = void Function(DragEndDetails details)
When a pointer that was previously in contact with the screen and moving is no longer in contact with the screen.
GFItemsCarouselSlideStartCallback = void Function(DragStartDetails details)
When a pointer has come to contact with screen and has begun to move.
HeaderForEachCallback = void Function(String name, List<String> values)
InjectorBuilderCallback<S> = S Function(GetInstance)
InstanceBuilderCallback<S> = S Function()
InterceptorErrorCallback = void Function(DioError e, ErrorInterceptorHandler handler)
InterceptorSendCallback = void Function(RequestOptions options, RequestInterceptorHandler handler)
InterceptorSuccessCallback = void Function(Response e, ResponseInterceptorHandler handler)
JsonDecodeCallback = dynamic Function(String)
The default Transformer for Dio. If you want to custom the transformation of request/response data, you can provide a Transformer by your self, and replace the DefaultTransformer by setting the dio.Transformer.
LogWriterCallback = void Function(String text, {bool isError})
VoidCallback from logs
NotifierBuilder<T> = Widget Function(T state)
OnItemSelected<T> = void Function(T item)
OnTap = void Function(GetSnackBar snack)
OnTimerTickCallback = void Function(int millisUntilFinished)
timer callback.(millisUntilFinished 毫秒).
PrintFunctionCallback = void Function(String prefix, dynamic value, String info, {bool? isError})
Progress = dynamic Function(double percent)
ProgressCallback = void Function(int count, int total)
Callback to listen the progress for sending/receiving data.
QueryBuilder<T> = FutureOr<List<T>> Function(String query, List<T> list)
QueryListItemBuilder<T> = Widget Function(T item)
RatingChangeCallback = void Function(double rating)
RemoveSubscription<T> = FutureOr<bool?> Function(LightSubscription<T> subs)
RenderGFStickyHeaderCallback = void Function(double stuckValue)
RequestEncoder = List<int> Function(String request, RequestOptions options)
ResponseDecoder = String Function(List<int> responseBytes, RequestOptions options, ResponseBody responseBody)
SnackbarStatusCallback = void Function(SnackbarStatus? status)
StickyHeaderWidgetBuilder = Widget Function(BuildContext context, double stuckValue)
ValidateStatus = bool Function(int? 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)

Exceptions / Errors

DioError
DioError describes the error info when request failed.