gogoboom_flutter_common library

Classes

AndroidBuildVersion
Version values of the current Android operating system build derived from android.os.Build.VERSION.
AndroidDeviceInfo
Information derived from android.os.Build.
AndroidEditor
AnsiColor
This class handles colorizing of terminal output.
ApiError
AppInstaller
ArabicTextDelegate
AssetsPickerTextDelegate implements with Arabic. الترجمة العربية
AssetBundlePictureKey
Key for the picture obtained by an AssetPicture or ExactAssetPicture.
AssetBundlePictureProvider
A subclass of PictureProvider that knows about AssetBundles.
AssetEntity
Used to describe an asset.
AssetEntityGridItemBuilder
AssetEntityGridItemWidgetState
AssetEntityImageProvider
AssetPathEntity
asset entity, for entity info.
AssetPicker<Asset, Path>
AssetPickerBuilderDelegate<Asset, Path>
The delegate to build the whole picker's components.
AssetPickerPageRoute<T>
Built a slide page transition for the picker. 为选择器构造一个上下进出的页面过渡动画
AssetPickerProvider<Asset, Path>
ChangeNotifier for assets picker.
AssetPickerState<Asset, Path>
AssetPickerViewer<Asset, Path>
AssetPickerViewerBuilderDelegate<Asset, Path>
AssetPickerViewerProvider<A>
ChangeNotifier for assets picker viewer. 资源选择查看器的 provider model.
AssetPickerViewerState<Asset, Path>
AssetsPickerTextDelegate
Author Alex (https://github.com/Alex525) Date 2020/4/7 10:25
Badge
This widget allows you to add badges to any of your Widget.
BadgePosition
Utility class. Don't try to use it!
BadgePositioned
Utility class. Don't try to use it!
BadgeState
Barcode
The Barcode object holds information about the barcode or qr code.
BaseDeviceInfo
The base class for platform's device info.
BaseDio
BaseError
BaseOptions
The common config for the Dio instance. dio.options is a instance of BaseOptions
BezierCircleHeader
bezier + circle indicator,you can use this directly
BezierHeader
bezier container,if you need to implements indicator with bezier ,you can use consider about use this this will add the bezier container effect
Body
Use this annotation on a service method param when you want to directly control the request body of a POST/PUT request (instead of sending in as request parameters or form-style request body).
Bounce
Class Bounce: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller from from where you want to start the animation infinite loops the animation until the widget is destroyed
BounceInDown
Class BounceInDown: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
BounceInLeft
Class BounceInLeft: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
BounceInRight
Class BounceInRight: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
BounceInUp
Class BounceInUp: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
CacheCompatibilityTester
Tests whether a DrawableRoot should be cache invalidated given old and new external parameter changes.
CacheControl
CachedNetworkImage
Image widget to show NetworkImage with caching functionality.
CachedNetworkImageProvider
IO implementation of the CachedNetworkImageProvider; the ImageProvider to load network images using a cache.
CacheUtil
CameraController
Controls a device camera.
CameraDescription
Properties of a camera device.
CameraImage
A single complete image buffer from the platform camera.
CameraPicker
Create a camera picker integrate with CameraDescription. 通过 CameraDescription 整合的拍照选择
CameraPickerState
CameraPickerTextDelegate
Author Alex (https://github.com/AlexV525) Date 2020/7/16 11:07
CameraPreview
A widget showing a live camera preview.
CameraValue
The state of a CameraController.
CancelRequest
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.
ChRefreshString
Chinese
ClassicFooter
the most common indicator,combine with a text and a icon
ClassicHeader
the most common indicator,combine with a text and a icon
CommonConfig
CommonSortPathDelegate
Common sort path delegate. 常用的路径排序实现
ConsoleOutput
Default implementation of LogOutput.
CoreConfig
CustomFooter
a custom Indicator for footer,the usage I have put in CustomHeader,same with that See also
CustomHeader
a custom Indicator for header
Dance
Class Dance: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller from from where you want to start the animation infinite loops the animation until the widget is destroyed
DateTimeCond
CreateDate
DefaultAssetPickerBuilderDelegate
DefaultAssetPickerProvider
DefaultAssetPickerViewerBuilderDelegate
DefaultCameraPickerTextDelegate
Default text delegate implements with Chinese. 中文文字实现
DefaultCameraPickerTextDelegateWithOnlyRecording
Default text delegate including only recording implements with Chinese. 中文文字实现（仅摄像）
DefaultCameraPickerTextDelegateWithRecording
Default text delegate including recording implements with Chinese. 中文文字实现（包括摄像）
DefaultCameraPickerTextDelegateWithTapRecording
Default text delegate including tap recording implements with Chinese. 中文文字实现（仅轻触摄像）
DefaultSvgTheme
The SVG theme to apply to descendant SvgPicture widgets which don't have explicit theme values.
DefaultTransformer
DELETE
Make a DELETE request
DeRefreshString
German
DevelopmentFilter
Prints all logs with level >= Logger.level while in development mode (eg when asserts are evaluated, Flutter calls this debug mode).
DeviceInfoPlugin
Provides device and operating system information.
DeviceUtil
Dio
A powerful Http client for Dart, which supports Interceptors, Global configuration, FormData, File downloading etc. and Dio is very easy to use.
DioMixin
DioOptions
DioResponseType
DottedScaleXWidget
DownloadProgress
Progress of the file that is being downloaded from the originalUrl.
Drawable
Base interface for vector drawing.
DrawableDefinitionServer
Contains reusable drawing elements that can be referenced by a String ID.
DrawableGradient
Basic information describing a gradient.
DrawableGroup
Represents a group of drawing elements that may share a common transform, stroke, or fill.
DrawableLinearGradient
Represents the data needed to create a Gradient.linear.
DrawablePaint
A wrapper class for Flutter's Paint class.
DrawableParent
A Drawable that can have child Drawables and DrawableStyle.
DrawableRadialGradient
Represents the information needed to create a Gradient.radial.
DrawableRasterImage
A raster image (e.g. PNG, JPEG, or GIF) embedded in the drawable.
DrawableRoot
The root element of a drawable.
DrawableShape
Represents a drawing element that will be rendered to the canvas.
DrawableStyle
Styling information for vector drawing.
DrawableStyleable
A Drawable that can have a DrawableStyle applied to it.
DrawableText
A Drawable for text objects.
DrawableTextStyle
A wrapper class for Flutter's TextStyle class.
DrawableViewport
Contains the viewport size and offset for a Drawable.
DurationConstraint
Constraints of duration.
Editor
ElasticIn
Class ElasticIn: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
ElasticInDown
Class ElasticInDown: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
ElasticInLeft
Class ElasticInLeft: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
ElasticInRight
Class ElasticInRight: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
ElasticInUp
Class ElasticInUp: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
EnglishCameraPickerTextDelegate
Default text delegate implements with English. 英文文字实现
EnglishCameraPickerTextDelegateWithOnlyRecording
Default text delegate including only recording implements with English. 英文文字实现（仅摄像）
EnglishCameraPickerTextDelegateWithRecording
Default text delegate including recording implements with English. 英文文字实现（包括摄像）
EnglishCameraPickerTextDelegateWithTapRecording
Default text delegate including tap recording implements with English. 英文文字实现（仅轻触摄像）
EnglishTextDelegate
AssetsPickerTextDelegate implements with English. English Localization
EnRefreshString
English
Enum<T>
ErrorInterceptorHandler
Handler for error interceptor.
EsRefreshString
Spanish
ExactAssetPicture
Fetches a picture from an AssetBundle, associating it with the given scale.
ExceptionHandler
Extra
Extra data that will be passed to dio's request, response, transformer and interceptors.
FadeIn
Class FadeIn: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do manualTrigger: boolean that indicates if you want to trigger the animation manually with the controller animate: For a State controller property, if you re-render changing it from false to true, the animation will be fired inmediatelly
FadeInDown
Class FadeInDown: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
FadeInDownBig
Class FadeInDownBig: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
FadeInLeft
Class FadeInLeft: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
FadeInLeftBig
Class FadeInLeftBig: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
FadeInRight
Class FadeInRight: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
FadeInRightBig
Class FadeInRightBig: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
FadeInUp
Class FadeInUp: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
FadeInUpBig
Class FadeInUpBig: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
FadeOut
Class FadeOut: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
FadeOutDown
Class FadeOutDown: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
FadeOutDownBig
Class FadeOutDownBig: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
FadeOutLeft
Class FadeOutLeft: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
FadeOutLeftBig
Class FadeOutLeftBig: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
FadeOutRight
Class FadeOutRight: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
FadeOutRightBig
Class FadeOutRightBig: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
FadeOutUp
Class FadeOutUp: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
FadeOutUpBig
Class FadeOutUpBig: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
Field
Named pair for a form request.
FileOutput
FilePicture
Decodes the given File object as a picture, associating it with the given scale.
FilterOption
Filter option 筛选选项的详细情况
FilterOptionGroup
Filter option for get asset.
Flash
Class Flash: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller from from where you want to start the animation infinite loops the animation until the widget is destroyed
FlipInX
Class FlipInX: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
FlipInY
Class FlipInY: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
FlutterImageCompress
Image Compress plugin.
FontSizeResolvers
FormData
A class to create readable "multipart/form-data" streams. It can be used to submit forms and file uploads to http server.
FormUrlEncoded
Denotes that the request body will use form URL encoding. Fields should be declared as parameters and annotated with Field.
FrenchTextDelegate
AssetsPickerTextDelegate implements with French. Délégué texte français
FrRefreshString
French
GermanTextDelegate
AssetsPickerTextDelegate implementiert mit der deutschen Übersetzung. Deutsche Textimplementierung.
GET
Make a GET request
Make a HEAD request
Replaces the header with the value of its target.
Headers
Adds headers specified in the value map.
HebrewTextDelegate
AssetsPickerTextDelegate implements with Hebrew. תרגום בשפה העברית
HttpClientAdapter
HttpAdapter is a bridge between Dio and HttpClient.
HttpMethod
A holder that includes all http methods which are supported by retrofit.
HttpResponse<T>
HybridPrinter
A decorator for a LogPrinter that allows for the composition of different printers to handle different log messages. Provide it's constructor with a base printer, but include named parameters for any levels that have a different printer:
ImageFormat
Describes how pixels are represented in an image.
ImageGallerySaver
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:
IosDeviceInfo
Information derived from UIDevice.
IosEditor
For iOS
IosUtsname
Information derived from utsname. See http://pubs.opengroup.org/onlinepubs/7908799/xsh/sysutsname.h.html for details.
ItRefreshString
Italian
IVideoCompress
JapaneseTextDelegate
AssetsPickerTextDelegate implements with Japanese. 日本語の TextDelegate
JelloIn
Class JelloIn: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
JpRefreshString
Japanese
KeepAliveState
KeepAliveWidget
KrRefreshString
Korean
LatLng
Longitude and latitude
LinkFooter
enable footer link other footer place outside the viewport
LinkHeader
enable header link other header place outside the viewport
LinuxDeviceInfo
Device information for a Linux system.
ListParam<T>
LoadIndicator
a widget implements pull up load
LoadIndicatorState<T extends LoadIndicator>
LoadingProcessor
footer Indicator exposure interface
Lock
Add lock/unlock API for interceptors.
LogEvent
LogFilter
An abstract filter of log messages.
LogfmtPrinter
Outputs a logfmt message:
Logger
Use instances of logger to send log messages to the LogPrinter.
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.
LogOutput
Log output receives a OutputEvent from LogPrinter and sends it to the desired destination.
LogPrinter
An abstract handler of log events.
MacOsDeviceInfo
Object encapsulating MACOS device information.
MaterialClassicHeader
mostly use flutter inner's RefreshIndicator
MediaInfo
MediaMetadataRetriever<int>
MemoryOutput
Buffers OutputEvents.
MemoryPicture
Decodes the given String buffer as a picture, associating it with the given scale.
Method
MimeMultipart
A Mime Multipart class representing each part parsed by MimeMultipartTransformer. The data is streamed in as it become available.
MimeMultipartTransformer
Parser for MIME multipart types of data as described in RFC 2046 section 5.1.1. The data is transformed into MimeMultipart objects, each of them streaming the multipart data.
MimeTypeResolver
MIME-type resolver class, used to customize the lookup of mime-types.
MultiImageStreamCompleter
An ImageStreamCompleter with support for loading multiple images.
MultiOutput
Logs simultaneously to multiple LogOutput outputs.
MultiPart
Denotes that the request body is multi-part. Parts should be declared as parameters and annotated with Part.
MultipartFile
A file to be uploaded as part of a MultipartRequest. This doesn't need to correspond to a physical file.
NeedAuth
NeedLogin
NetworkError
NetworkPicture
Fetches the given URL from the network, associating it with the given scale.
NetworkPictureKeyData
The PictureKey.keyData for a NetworkPicture.
NlRefreshString
Dutch
NoBody
Use this annotation on a service method param when you want to indicate that no body should be generated for POST/PUT/DELETE requests.
ObservableBuilder<T>
OneFramePictureStreamCompleter
Manages the loading of dart:ui.Picture objects for static PictureStreams (those with only one frame).
OpenFile
OpenResult
Options
Every request can pass an Options object which will be merged with Dio.options
OPTIONS
Make a OPTIONS request
OrderOption
OtherError
OutputEvent
PackageInfo
Application metadata. Provides application bundle information on iOS and application package information on Android.
Part
Denotes a single part of a multi-part request. Part parameters may not be null.
PATCH
Make a PATCH request
Path
Named replacement in a URL path segment.
PermisstionRequestOption
PhotoCachingManager
Cached thumbnails for album management.
PhotoManager
use the class method to help user load asset list and asset info.
PictureConfiguration
Configuration information passed to the PictureProvider.resolve method to select a specific picture.
PictureInfo
Represents information about a ui.Picture to be drawn on a canvas.
PictureKey<T>
An immutable key representing the current state of a PictureProvider.
PictureProvider<T, U>
Identifies a picture without committing to the precise final asset. This allows a set of pictures to be identified and for the precise picture to later be resolved based on the environment, e.g. the device pixel ratio.
PictureStream
A handle to an image resource.
PictureStreamCompleter
Base class for those that manage the loading of dart:ui.Picture objects for PictureStreams.
Plane
A single color plane of image data.
PMProgressHandler
Only works in iOS.
PMProgressState
Status of progress for PMProgressHandler.
POST
Make a POST request
PrefixPrinter
A decorator for a LogPrinter that allows for the prepending of every line in the log output with a string for the level of that log. For example:
PrettyPrinter
Default implementation of LogPrinter.
ProductionFilter
Prints all logs with level >= Logger.level even in production.
PtRefreshString
Pulse
Class Pulse: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller from from where you want to start the animation infinite loops the animation until the widget is destroyed
PUT
Make a PUT request
PwdEmpty
PwdNotMatch
QrBitBuffer
QrCode
QrDataModuleStyle
Styling options for data module.
QrEmbeddedImageStyle
Styling options for any embedded image overlay
QrErrorCorrectLevel
QrEyeStyle
Styling options for finder pattern eye.
QrImage
Renders the encoded data from a QrCode in a portable format.
QrImageView
A widget that shows a QR code.
QrPainter
A CustomPainter object that you can use to paint a QR code.
QrScannerOverlayShape
QrValidationResult
Captures the status or a QR code validation operations, as well as the rendered and validated data / object so that it can be used in any secondary operations (to avoid re-rendering). It also keeps any exception that was thrown.
QrValidator
A utility class for validating and pre-rendering QR code data.
QrVersions
This class only contains special version codes. QR codes support version numbers from 1-40 and you should just use the numeric version directly.
QRView
The QRView is the view where the camera and the barcode scanner gets displayed.
QRViewController
Queries
Query parameter keys and values appended to the URL.
Query
Query parameter appended to the URL.
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
ReceiveProgress
REdgeInsets
REdgeInsetsDirectional
RedirectRecord
RefreshConfiguration
Controls how SmartRefresher widgets behave in a subtree.the usage just like ScrollConfiguration
RefreshController
A controller controll header and footer state, it can trigger driving request Refresh ,set the initalRefresh,status if needed
RefreshIndicator
a widget implements ios pull down refresh effect and Android material RefreshIndicator overScroll effect
RefreshIndicatorState<T extends RefreshIndicator>
Internal Implementation of Head Indicator
RefreshLocalizations
Implementation of localized strings for the ClassicHeader,ClassicFooter,TwoLevelHeader
RefreshLocalizationsDelegate
RefreshNotifier<T>
RefreshPhysics
a scrollPhysics for config refresh scroll effect,enable viewport out of edge whatever physics it is in ClampingScrollPhysics, it doesn't allow to flip out of edge,but in RefreshPhysics,it will allow to do that, by parent physics passing,it also can attach the different of iOS and Android different scroll effect it also handles interception scrolling when refreshed, or when the second floor is open and closed. with SpringDescription passing,you can custom spring back animate,the more paramter can be setting in RefreshConfiguration
RefreshProcessor
head Indicator exposure interface
RefreshString
interface implements different language
RequestInterceptorHandler
Handler for request interceptor.
RequestOptions
RequestType
Response<T>
Response describes the http Response info.
ResponseBody
ResponseInterceptorHandler
Handler for response interceptor.
RestApi
Define an API.
RingPainter
Roulette
Class Roulette: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller from from where you want to start the animation infinite loops the animation until the widget is destroyed
RPadding
RSizedBox
RuRefreshString
Russian
RussianTextDelegate
AssetsPickerTextDelegate implements with Russian. Локализация на русский язык.
ScaleYWidget
ScreenUtil
ScreenUtilInit
SendProgress
SimplePrinter
Outputs simple log messages:
SizeConstraint
Constraints of asset pixel width and height.
SlideInDown
Class SlideInDown: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
SlideInLeft
Class SlideInLeft: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
SlideInRight
Class SlideInRight: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
SlideInUp
Class SlideInUp: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
SmartRefresher
This is the most important component that provides drop-down refresh and up loading. RefreshController must not be null,Only one controller to one SmartRefresher
SmartRefresherState
SortPathDelegate<Path>
Delegate to sort asset path entities. 用于资源路径排序的实现
Spin
Class Spin: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller from from where you want to start the animation infinite loops the animation until the widget is destroyed spins number of spins that you want
SpinKitChasingDots
SpinKitCircle
SpinKitCubeGrid
SpinKitDancingSquare
SpinKitDoubleBounce
SpinKitDualRing
SpinKitFadingCircle
SpinKitFadingCube
SpinKitFadingFour
SpinKitFadingGrid
SpinKitFoldingCube
SpinKitHourGlass
SpinKitPianoWave
SpinKitPouringHourGlass
SpinKitPouringHourGlassRefined
SpinKitPulse
SpinKitPulsingGrid
SpinKitPumpCurve
SpinKitPumpingHeart
SpinKitRing
SpinKitRingCurve
SpinKitRipple
SpinKitRotatingCircle
SpinKitRotatingPlain
SpinKitSpinningCircle
SpinKitSpinningLines
SpinKitSquareCircle
SpinKitThreeBounce
SpinKitThreeInOut
SpinKitWanderingCubes
SpinKitWave
SpinkitWaveCustomPaint
SpinKitWaveSpinner
SpinningLinesPainter
SpinPerfect
Class SpinPerfect: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller from from where you want to start the animation infinite loops the animation until the widget is destroyed
StreamOutput
StringPicture
Decodes the given String as a picture, associating it with the given scale.
StringUtils
Subscription
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.
SvgTheme
A theme used when decoding an SVG picture.
SvRefreshString
Swedish
Swing
Class Swing: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller from from where you want to start the animation infinite loops the animation until the widget is destroyed
SystemFeatures
SystemUtil
ThumbOption
ToastUtil
Transformer
Transformer allows changes to the request/response data before it is sent/received to/from the server.
TwoLevelHeader
this header help you implements twoLevel function easyily, the behaviour just like TaoBao,XieCheng(携程) App TwoLevel
UkRefreshString
UserNameEmpty
UserNotExist
Utils
WaterDropHeader
QQ ios refresh header effect
WaterDropMaterialHeader
attach the waterdrop effect to MaterialClassicHeader
WebBrowserInfo
Information derived from navigator.
WindowsDeviceInfo
Object encapsulating WINDOWS device information.
XFile
A CrossFile is a cross-platform, simplified File abstraction.
ZoomIn
Class ZoomIn: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller
ZoomOut
Class ZoomOut: key: optional widget key reference child: mandatory, widget to animate duration: how much time the animation should take delay: delay before the animation starts controller: optional/mandatory, exposes the animation controller created by Animate_do the controller can be use to repeat, reverse and anything you want, its just an animation controller

Enums

AssetType
asset type
BadgeAnimationType
This is a set of animations that you can use for your Badge widget.
BadgeShape
This is a set of shapes that you can use for your Badge widget.
BarcodeFormat
BezierCircleType
BezierDismissType
BrowserName
List of supported browsers
CacheManagerLogLevel
Log levels of the cache manager. Debug shows failed downloads and verbose also shows successful downloads and cache retrievals.
CameraFacing
CameraLensDirection
The direction the camera is facing.
CompressFormat
DeliveryMode
DeviceType
DioErrorType
DrawableTextAnchorPosition
How to anchor text.
ExposureMode
The possible exposure modes that can be set for a camera.
FinderPatternPosition
Enumeration representing the three finder pattern (square 'eye') locations.
FlashMode
The possible flash modes that can be set for a camera
FocusMode
The possible focus modes that can be set for a camera.
GradientUnitMode
Determines how to transform the points given for a gradient.
IconPosition
direction that icon should place to the text
ImageFileType
ImageFormatGroup
Group of image formats that are comparable across Android and iOS platforms.
IosAccessLevel
Level
Levels to control logging output. Logging can be enabled to include all levels above certain Level.
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.
LoadStatus
footer state
LoadStyle
footer indicator display style
OrderOptionType
Parser
Define how to parse response json If you want to support more, PR is welcome
PermissionState
Android: The effective values are authorized or denied.
PMRequestState
Current asset loading status
Profiles
QrCodeElement
Represents a specific element / part of a QR code. This is used to isolate the different parts so that we can style and modify specific parts independently.
QrDataModuleShape
Enumeration representing the shape of Data modules inside QR.
QrEyeShape
Enumeration representing the finder pattern eye's shape.
QrValidationStatus
The status of the QR code data you requested to be validated.
RefreshStatus
header state
RefreshStyle
header indicator display style
ResizeContentMode
Resize content mode
ResizeMode
Resize strategy, useful when need exact image size. It's must be used only for iOS Apple resize mode documentation
ResolutionPreset
Affect the quality of video recording and image capture:
ResponseType
ResponseType indicates which transformation should be automatically applied to the response data by Dio.
ResultType
SpecialImageType
SpecialItemPosition
Provide an item slot for custom widget insertion. 提供一个自定义位置供特殊item放入资源列表中。
SpecialPickerType
Author Alex (https://github.com/Alex525) Date 2020/7/8 12:32
SpinKitPianoWaveType
SpinKitWaveType
StorageDirectory
Corresponds to constants defined in Androids android.os.Environment class.
ThumbFormat
For generality, only support jpg and png.
TwoLevelDisplayAlignment
VideoQuality

Mixins

IndicatorStateMixin<T extends StatefulWidget, V>
mixin in IndicatorState,it will get position and remove when dispose,init mode state
OptionsMixin
SU

Properties

commonConfig ↔ CommonConfig
getter/setter pair
coreConfig ↔ CoreConfig
getter/setter pair
defaultMagicNumbersMaxLength → int
The maximum number of bytes needed, to match all default magic-numbers.
no setter
dio → Dio
final
disablePathProviderPlatformOverride ← bool
no getter
logger ↔ Logger
getter/setter pair
svg → Svg
Instance for Svg's utility methods, which can produce a DrawableRoot or PictureInfo from String or Uint8List.
final
timeDilation → double
Slows down animations by this factor to help in development.
no setter
uuid ↔ Uuid
getter/setter pair
VideoCompress → IVideoCompress
no setter

Functions

availableCameras() → Future<List<CameraDescription>>
Completes with a list of available cameras.
cancelLoading() → void
createLocalPictureConfiguration(BuildContext? context, {Rect? viewBox, ColorFilter? colorFilterOverride, Color? color, BlendMode? colorBlendMode}) → PictureConfiguration
Creates an PictureConfiguration based on the given BuildContext (and optionally size).
extensionFromMime(String mime) → String
Returns the extension for the given MIME type.
fetchAssetsImage(String path, {double width = 48, double height = 48}) → Widget
fetchAvatar(String? url, {double size = 60, String? defaultImagePath}) → Widget
fetchImage(String url, {double width = 48, double height = 48, Color? color, String? defaultImagePath}) → Widget
fetchLocalImage(File? file, {double width = 48, double height = 48}) → Widget
getApplicationDocumentsDirectory() → Future<Directory>
Path to a directory where the application may place data that is user-generated, or that cannot otherwise be recreated by your application.
getApplicationSupportDirectory() → Future<Directory>
Path to a directory where the application may place application support files.
getDownloadsDirectory() → Future<Directory?>
Path to the directory where downloaded files can be stored.
getExternalCacheDirectories() → Future<List<Directory>?>
Paths to directories where application specific cache data can be stored externally.
getExternalStorageDirectories({StorageDirectory? type}) → Future<List<Directory>?>
Paths to directories where application specific data can be stored externally.
getExternalStorageDirectory() → Future<Directory?>
Path to a directory where the application may access top level storage.
getLibraryDirectory() → Future<Directory>
Path to the directory where application can store files that are persistent, backed up, and not visible to the user, such as sqlite.db.
getTemporaryDirectory() → Future<Directory>
Path to the temporary directory on the device that is not backed up and is suitable for storing caches of downloaded files.
keepAliveWrapper(Widget child) → Widget
lookupMimeType(String path, {List<int>? headerBytes}) → String?
Extract the extension from path and use that for MIME-type lookup, using the default extension map.
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.
toastLoading() → CancelFunc

Typedefs

AssetSelectPredicate<Asset> = FutureOr<bool> Function(BuildContext context, Asset asset, bool isSelected)
Predicate whether an asset can be selected or unselected. 判断资源可否被选择
FontSizeResolver = double Function(num fontSize, ScreenUtil instance)
FooterBuilder = Widget Function(BuildContext context, LoadStatus? mode)
custom footer builder,you can use second paramter to know what footerr state is
HeaderBuilder = Widget Function(BuildContext context, RefreshStatus? mode)
custom header builder,you can use second paramter to know what header state is
HeaderForEachCallback = void Function(String name, List<String> values)
ImageWidgetBuilder = Widget Function(BuildContext context, ImageProvider<Object> imageProvider)
Builder function to create an image widget. The function is called after the ImageProvider completes the image loading.
IndicatorBuilder = Widget Function()
global default indicator builder
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.
LoadingErrorWidgetBuilder = Widget Function(BuildContext context, String url, Object error)
Builder function to create an error widget. This builder is called when the image failed loading, for example due to a 404 NotFound exception.
LogCallback = void Function(LogEvent event)
ModeChangeCallBack<T> = void Function(T? mode)
OffsetCallBack = void Function(double offset)
onLatestImageAvailable = dynamic Function(CameraImage image)
Signature for a callback receiving the a camera image.
OnTwoLevel = void Function(bool isOpen)
when viewport not full one page, for different state,whether it should follow the content
OuterBuilder = Widget Function(Widget child)
wrap child in outside,mostly use in add background color and padding
OutputCallback = void Function(OutputEvent event)
PermissionSetCallback = void Function(QRViewController, bool)
PictureErrorListener = void Function(Object exception, StackTrace stackTrace)
The signature of a method that listens for errors on picture stream resolution.
PictureInfoDecoder<T> = Future<PictureInfo> Function(T data, ColorFilter? colorFilter, String key)
The signature of a function that can decode raw SVG data into a Picture.
PictureInfoDecoderBuilder<T> = PictureInfoDecoder<T> Function(SvgTheme theme)
The signature of a builder that returns a PictureInfoDecoder based on the provided theme.
PictureListener = dynamic Function(PictureInfo? image, bool synchronousCall)
Signature for callbacks reporting that an image is available.
PlaceholderWidgetBuilder = Widget Function(BuildContext context, String url)
Builder function to create a placeholder widget. The function is called once while the ImageProvider is loading the image.
ProgressCallback = void Function(int count, int total)
Callback to listen the progress for sending/receiving data.
ProgressIndicatorBuilder = Widget Function(BuildContext context, String url, DownloadProgress progress)
Builder function to create a progress indicator widget. The function is called every time a chuck of the image is downloaded from the web, but at least once during image loading.
QrErrorBuilder = Widget Function(BuildContext context, Object? error)
A function type to be called when any form of error occurs while painting a QrImageView.
QRViewCreatedCallback = void Function(QRViewController)
RebuildFactor = bool Function(MediaQueryData old, MediaQueryData data)
RefresherBuilder = Widget Function(BuildContext context, RefreshPhysics physics)
a builder for attaching refresh function with the physics
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)
ShouldFollowContent = bool Function(LoadStatus? status)
when viewport not full one page, for different state,whether it should follow the content
ValidateStatus = bool Function(int? status)
VoidFutureCallBack = Future<void> Function()

Exceptions / Errors

CameraException
This is thrown when the plugin reports an error.
DioError
DioError describes the error info when request failed.
InputTooLongException
MimeMultipartException
MissingPlatformDirectoryException
An exception thrown when a directory that should always be available on the current platform cannot be obtained.
QrEmbeddedImageException
An exception that is thrown when something goes wrong with the ImageProvider for the embedded image of a QrImageView or QrPainter.
QrUnsupportedVersionException
An exception that is thrown when an invalid QR code version / type is requested.