hgg_view library Null safety

Classes

ApiInterceptor
API拦截器
ApiOnError
API拦截器
ApiOnRequest
API拦截器
ApiOnResponse
API拦截器
BaseOptions
The common config for the Dio instance. dio.options is a instance of BaseOptions
BigImagePage
大图浏览
BigImagePageState
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.
BotToast
ToastBuilder方法生成widget时,请确保生成的Widget背景不会吸收点击事件 例如Scaffold,Material都会默认占满整个父空间, 并且会吸收事件(就算透明也是这种情况),具体例子可看material.dart->_RenderInkFeatures class->hitTestSelf method 如果真的要生成,可以考虑使用IgnorePointer. 如果没有遵守规则,将会时某些功能失效例如allowClick功能就会失效
BotToastNavigatorObserver
如果你项目有多个Navigator,请将该BotToastNavigatorObserver添加到Navigator.observers
BotToastNavigatorObserverProxy
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.
ConsoleOutput
控制输出
CustomTransition
D
距离
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
DefaultTransformer
DelayTween
延迟补间
Dio
A powerful Http client for Dart, which supports Interceptors, Global configuration, FormData, File downloading etc. and Dio is very easy to use.
DioMixin
DisposableInterface
ErrorInterceptorHandler
Handler for error interceptor.
Expression
表情对象
ExpressionData
数据类
FastList<T>
FormData
A class to create readable "multipart/form-data" streams. It can be used to submit forms and file uploads to http server.
FullLifeCycleController
G
间隔
GetBar
GetBuilder<T extends GetxController>
GetBuilderState<T extends GetxController>
GetCupertinoApp
GetDelegate
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
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>
HConfig
主题配置
Headers
HttpClientAdapter
HttpAdapter is a bridge between Dio and HttpClient.
Indicator
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.
LightSubscription<T>
ListParam<T>
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.
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>
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
Options
Every request can pass an Options object which will be merged with Dio.options
P
Padding
PageRedirect
PathDecoded
PrettyPrinter
美化显示
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:
RebuildFactors
REdgeInsets
REdgeInsetsDirectional
RedirectRecord
RequestInterceptorHandler
Handler for request interceptor.
RequestOptions
RespData
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
RPadding
RSizedBox
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
ScreenUtilInit
SimpleBuilder
SMClipper
SnackbarController
SuperController<T>
TickerProviderImpl
Transformer
Transformer allows changes to the request/response data before it is sent/received to/from the server.
Translations
U
Value<T>
ValueBuilder<T>
Manages a local state like ObxValue, but uses a callback instead of a Rx value.
Worker
Workers
XAppBar
XBanner
轮播图
XBaseBean
基础 bean
XBaseModel
基础 model
XButton
应用 Button
XCard
应用 Card
XCircleLoading
XContainer
容器
XCustomAppBar
XDashLine
应用 虚线
XDataModel<T>
初始请求数据的 Model
XDateUtil
Date Util.
XEmojiText
显示表情的 Span
XExpression
表情组件
XExpressionText
带有表情的文本 --- 表情好为[]中带 key, 如微笑
XFloat
浮动按钮
XFloatButton
自定义 可拖动悬浮按钮
XFloatContent
通用悬浮控件
XFontWeight
XGetBind
GetBindWidget can bind GetxController, and when the page is disposed, it can automatically destroy the bound related GetXController
XGetState<T extends StatefulWidget, M extends XBaseModel>
保持页面状态的 state ,可以添加 model
XGetView<T>
可以添加 model 的 StatelessWidget
XGridViewBuilder
包含滚动动画的 grid
XGridViewBuilderState
XHggInit
XIconButton
XImageNetwork
加载网络图片
XImagePickerDialog
选择图片对话框: 拍照/相册
XImagePickUtil
图片选择工具
XInkWell
可点击的控件,带波纹
XIosLoading
Ios 加载动画
XListModel<T>
初始请求List的 Model
XListViewBuilder
包含滚动动画的list
XListViewBuilderState
XLoading
便捷的创建 loading,支持设置全局样式,也支持设置单次样式。能够自动消失。
XLog
Log Util.
XMarquee
跑马灯
XMarqueeController
XMock
XOutlineButton
应用 Button
XRadio<T>
单选组件
XRadioCorner
XRadio 设置圆角。详见 XRadio 默认构造函数中的 corner 参数
XRadioWithTip<T>
XRadius
边界半径
XRefresherFooter
通用的 footer
XRefreshHeader
通用的 header
XScoreWidget
显示评分控件
XSelectButton
选择按钮
XSingleExpression
单个表情
XSp
XSpecialTextSpanBuilder
显示标签的输入框(使用ExtendedTextField--传入specialTextSpanBuilder)
XState<T extends StatefulWidget>
保持页面状态的 state
XSwitch
一个有趣的、实用的开关组件。支持设置提示、滑块装饰、阴影以及良好的交互。
XTabBar
tabbar 点击无阴影
XText
text
XTextField
输入框
XUnderlineTabIndicator
tabbar 指示线圆角
XWidthText
限制宽度,分散分布的 txt

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>

Extensions

BoolExtension
BorderRaduisExtension
BoxConstraintsExtension
ContextExtensionss
DoubleExtension
EdgeInsetsExtension
ExDouble
ExMap
ExString
ExtensionBottomSheet
ExtensionDialog
ExtensionSnackbar
FirstWhereExt
GetDurationUtils
Duration utilities.
GetDynamicUtils
GetNavigation
GetNumUtils
GetStringUtils
Inst
IntExtension
IterableExtensions
ListExtension
LocalesIntl
LoopEventsExt
MapExtension
OverlayExt
PagesListExt
Precision
RaduisExtension
ReactiveT
RxBoolExt
RxDoubleExt
RxIntExt
RxnBoolExt
RxnDoubleExt
RxnIntExt
RxnNumExt
RxnStringExt
RxNumExt
RxStringExt
RxT
SetExtension
SizeExtension
StateExt
StringExtension
Trans
WidgetColorX
将 color 属性添加到小部件
WidgetPaddingX
将 Padding 属性添加到小部件
WidgetSliverBoxX
Allows you to insert widgets inside a CustomScrollView

Constants

rtlLanguages → const List<String>
<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

Functions

ambiguate<T>(T? value) → T?
BotToastInit() TransitionBuilder
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().

Enums

BackButtonBehavior
此枚举会决定Toast对于物理返回键的处理方式
DioErrorType
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.
PageState
页面状态
PopMode
Enables the user to customize the intended pop behavior
PreferDirection
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

Typedefs

AddSubscription<T> = FutureOr<void> Function(LightSubscription<T> subs)
AsyncInstanceBuilderCallback<S> = Future<S> Function()
BindingBuilderCallback = void Function()
CallClick = void Function(Expression expression)
点击之后
CancelFunc = void Function()
Toast的关闭函数,调用将会提前关闭对应的Toast
Condition = bool Function()
FutureFunc = Future<void> Function()
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)
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)
OnCodeError = void Function(int code)
OnTap = void Function(GetSnackBar snack)
OnUnLogin = void Function()
PopTestFunc = bool Function()
PrintFunctionCallback = void Function(String prefix, dynamic value, String info, {bool? isError})
ProgressCallback = void Function(int count, int total)
Callback to listen the progress for sending/receiving data.
RebuildFactor = bool Function(MediaQueryData old, MediaQueryData data)
RemoveSubscription<T> = FutureOr<bool?> Function(LightSubscription<T> subs)
RequestEncoder = List<int> Function(String request, RequestOptions options)
ResponseDecoder = String Function(List<int> responseBytes, RequestOptions options, ResponseBody responseBody)
ScreenUtilInitBuilder = Widget Function(BuildContext context, Widget? child)
SnackbarStatusCallback = void Function(SnackbarStatus? status)
ToastBuilder = Widget Function(CancelFunc cancelFunc)
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)
WrapAnimation = Widget Function(AnimationController controller, CancelFunc cancelFunc, Widget widget)
WrapWidget = Widget Function(CancelFunc cancelFunc, Widget widget)
XBoolRadio = XRadioWithTip<bool>
XIntRadio = XRadioWithTip<int>
XStringRadio = XRadioWithTip<String>

Exceptions / Errors

DioError
DioError describes the error info when request failed.