stormy_ui
library
Classes
AdapterSpec <T >
Configuration that specifies the generation of a TypeAdapter
AgreeItemModel
协议项模型，包含协议名称和URL
AgreementCheckbox
协议复选框组件
AgreementSegment
协议分段基础类
AgreementWidget
协议同意组件
Allow
Allows the navigation to proceed.
AnimationParam
advanced usage:
AnsiPen
Pen attributes for foreground and background colors.
AnyNotifier <StateT , ValueT > Notifiers
A base class for all "notifiers".
AppInitializer
应用基础初始化器
负责 Flutter 框架层面的基础初始化
这些初始化逻辑是通用的，可以在不同项目中复用
AppLifecycleManager
App 生命周期管理器 - 单例模式
AppLifecycleStateListener
App 生命周期状态监听器
AppModel
AppUtils
AsyncData <ValueT > Core
Creates an AsyncValue with a data.
AsyncError <ValueT > Core
Creates an AsyncValue in the error state.
AsyncLoading <ValueT > Core
Creates an AsyncValue in loading state.
AsyncNotifier <StateT > Notifiers
A Notifier implementation that is asynchronously initialized.
AsyncNotifierProvider <NotifierT extends AsyncNotifier <ValueT > , ValueT > Providers
A provider which creates and listen to an AsyncNotifier .
AsyncResult <ValueT >
A variant of AsyncValue that excludes AsyncLoading .
AsyncValue <ValueT > Core
A utility for safely manipulating asynchronous data.
AttachAdjustParam
AttachParam
AuthInterceptor
鉴权与动态头拦截器
负责全局的 Token 和 Header 分发管理，支持异步等待直至配置完成才发起请求
BackgroundTransformer
The default Transformer for Dio .
BarBottomSheet
BaseAppBar
BaseBottomPadding
底部填充区域(自动计算)
BaseBottomSheet
基础底部弹窗组件
BaseButton
BaseConfirm
BaseImage
BaseInput
BaseLoad
BaseOptions
A set of base settings for each Dio().
BaseOptions and Options will be merged into one RequestOptions before
sending the requests. See Options.compose .
BasePage
基础页面壳体，统一封装页面的返回拦截、滚动控制与 EasyRefresh 集成逻辑。
BaseParent
BaseTabBar
自定义 TabBar 组件
BeforeAfter
An interactive widget that allows comparing two images using a before and after view.
BeforeAfterTheme
A theme extension class that defines custom styling and behavior for the
BeforeAfter widget.
BezierBackground
Bezier curve background.
Bezier circle footer.
https://dribbble.com/shots/1797373-Pull-Down-To-Refresh
Bezier footer.
Bezier header.
BinaryReader
The BinaryReader is used to bring data back from the binary format on the
disk.
BinaryWriter
The BinaryWriter is used to encode data to the binary format.
Block
Blocks the navigation from proceeding.
Box <E >
Boxes contain all of your data. In the browser, each box has its own
IndexedDB database. On all other platforms, each Box is stored in a
separate file in the Hive home directory.
BoxBase <E >
Boxes contain all of your data. In the browser, each box has its own
IndexedDB database. On all other platforms, each Box is stored in a
seperate file in the Hive home directory.
BoxCollection
TODO: Document this!
BoxEvent
A event representing a change in a box.
BrowserConfiguration
Additional configuration options for LaunchMode.inAppBrowserView
Build footer widget use IndicatorBuilder .
Build header widget use IndicatorBuilder .
CancelToken
Controls cancellation of Dio 's requests.
Classic footer.
Classic header.
CollectionBox <V >
represents a Box being part of a BoxCollection
ColoredLoggerFormatter
This formatter makes messages colorful
if this setting is enabled in the settings TalkerLoggerSettings
ConsoleUtils
Class that contains methods for working with console output
Consumer Core
Build a widget tree while listening to providers.
ConsumerState <WidgetT extends ConsumerStatefulWidget > Core
The State for a ConsumerStatefulWidget .
ConsumerStatefulWidget Core
A StatefulWidget that has a State capable of reading providers.
ConsumerWidget Core
The equivalent of a StatelessWidget that can listen to providers.
CornerFiller
圆角填充器 - 用于创建凹角效果
Cupertino footer.
https://github.com/THEONE10211024/WaterDropListView
Cupertino header.
https://github.com/THEONE10211024/WaterDropListView
CupertinoModalBottomSheetRoute <T >
CupertinoScaffold
CupertinoScaffoldInheirted
CustomLoading
CustomParameterCodec
annotation to define a custom parameter decoder/encoder
this is useful when the is encoded/decoded in a non-standard way like base64Url
this must be used as an annotation on a field
CustomToast
CustomTransitionPage <T >
Page with custom transition functionality.
DataParser <T >
数据解析器抽象基础协议
专门用于处理经过 ResponseParser 基础脱壳后（即抛弃了最外层 code、message 后）的纯净业务 Data。
DefaultTalkerHistory
Base implementation of TalkerHistory
to save the history locally
Delivery footer.
https://dribbble.com/shots/2753803-Refresh-your-delivery
Delivery footer.
https://dribbble.com/shots/2753803-Refresh-your-delivery
DependencyGraph
依赖分析器 — 封装拓扑排序和循环依赖检测
Dio
Dio enables you to make HTTP requests easily.
DioMixin
DirectParser <T >
直接透传解析器
不进行任何映射，直接泛型强转。适用于外部不需要模型转换的快速开发场景。
EasyRefresh
A flutter widget that provides pull-down refresh and pull-up load.
EasyRefreshConfig
EasyRefresh 的参数封装，便于按需开启刷新能力。
EasyRefreshController
Controls a EasyRefresh widget.
Control refresh, loading and indicator states.
EasyRefreshData
EasyRefresh needs to share data
ErrorApp
错误应用组件
当应用初始化失败时显示的降级页面
ErrorHandler
全局错误处理器
ErrorInterceptorHandler
The handler for interceptors to handle error occurred during the request.
ERScrollBehavior
Define ScrollBehavior in the scope of EasyRefresh.
Add support for web and PC.
EVDottedLineBorder
ExtendedLoggerFormatter
This formatter makes messages colorful
if this setting is enabled in the settings TalkerLoggerSettings
FlexibleSpaceLayout
使用 flexibleSpace 实现的灵活布局
优点：
FlutterSmartDialog
FlutterSmartNotifyStyle
FontSizeResolvers
Footer indicator.
Find Footer's Location
Put the last item in the list
it will smartly show Footer
Footer notifier
Footer status and Notifications
FormData
A class to create readable "multipart/form-data" streams.
It can be used to submit forms and file uploads to http server.
FuncUtils
函数工具类
FusedTransformer
A Transformer that has a fast path for decoding UTF8-encoded JSON.
If the response is utf8-encoded JSON and no custom decoder is specified in the RequestOptions , this transformer
is significantly faster than the default SyncTransformer and the BackgroundTransformer .
This improvement is achieved by using a fused Utf8Decoder and JsonDecoder to decode the response,
which is faster than decoding the utf8-encoded JSON in two separate steps, since
Dart uses a special fast decoder for this case.
See https://github.com/dart-lang/sdk/blob/5b2ea0c7a227d91c691d2ff8cbbeb5f7f86afdb9/sdk/lib/_internal/vm/lib/convert_patch.dart#L40
FutureProvider <ValueT > Providers
A provider that asynchronously creates a value.
Gal
Main class of gal.
GenerateAdapters
Annotation to generate TypeAdapters for the given specs
GoRoute Get started
Configuration
Redirection
Transition animations
Named routes
A route that is displayed visually above the matching parent route using the
Navigator .
GoRouteData Type-safe routes
A class to represent a GoRoute in
Type-safe routing .
GoRouteInformationParser
Converts between incoming URLs and a RouteMatchList using RouteMatcher.
GoRouteInformationProvider
The RouteInformationProvider created by go_router.
GoRouter Get started
Upgrading
Configuration
Navigation
Redirection
Web
Deep linking
Named routes
Error handling
State restoration
The route configuration for the app.
GoRouterDelegate
GoRouter implementation of RouterDelegate .
GoRouterState
The route state during routing.
GrowTransition
H5
Header indicator.
Find Header's Location
Put the first item in the list
it will smartly show Header
Header notifier
Header status and Notifications
The headers class for requests and responses.
Hide
A widget that hides its child widget from being visible.
HiveAesCipher
Default encryption algorithm. Uses AES256 CBC with PKCS7 padding.
HiveCipher
Abstract cipher can be implemented to customize encryption.
HiveCollection <E extends HiveObjectMixin >
List containing HiveObjectMixin s.
HiveField
Annotate all fields you want to persist with HiveField .
HiveInterface
The main API interface of Hive. Available through the Hive constant.
HiveList <E extends HiveObjectMixin >
Allows defining references to other HiveObjectMixin s.
HiveObject
TODO: Document this!
HiveType
Annotate classes with HiveType to generate a TypeAdapter.
Hook <R >
Hook is similar to a StatelessWidget , but is not associated
to an Element .
HookBuilder
A HookWidget that delegates its build to a callback.
HookConsumer
A widget that can both use hooks and listen to providers.
HookConsumerWidget
A widget that can both use hooks and listen to providers.
HookState <R , T extends Hook <R > >
The logic and internal state for a HookWidget
HookWidget
A Widget that can use a Hook .
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.
ImageResult <T >
统一的图片操作结果包装器
ImageSize
图片尺寸信息
ImageUtils
图片处理器
ImperativeRouteMatch
The route match that represent route pushed through GoRouter.push .
Indicator
Refresh and loading indicator.
Indicator configuration and widget builder.
IndicatorNotifier
Indicator data and trigger notification.
IndicatorState
Indicator properties and state.
IndicatorStateListenable
Indicator state listenable.
InheritedGoRouter
GoRouter implementation of InheritedWidget.
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 Interceptor s.
InterceptorsWrapper
A helper class to create interceptors in ease.
IsolatedBox <E >
Isolated version of Box
IsolatedBoxBase <E >
Isolated version of BoxBase
IsolatedCompactionStrategy
A sendable description of a CompactionStrategy
IsolatedHiveInterface
Interface for IsolatedHive
IsolatedLazyBox <E >
Isolated version of LazyBox
IsolateNameServer
An abstraction of the IsolateNameServer
IStorageEngine
存储引擎规范，定义底层具体实现的存储驱动（如 Hive、SharedPreferences）行为
JsonListParser <T >
标准 JSON 列表解析器
用于解析 [ { "id": 1 }, { "id": 2 } ] 格式的列表。
JsonPageParser <T >
标准分页列表解析器
用于解析结构如：
{ "list": [{...}, {...}], "page": 1, "total": 100 }
或
{ "content": [{...}], "page": { "number": 1, "totalElements": 100 } }
JsonParser <T >
标准 JSON 对象解析器
用于解析 { "id": 1, "name": "foo" } 格式的对象。
LazyBox <E >
LazyBox es don't keep the values in memory like normal boxes. Each time a
value is read, it is loaded from the backend.
LevelLogFilter
日志等级过滤器
ListenedListSelectInherited <T >
监听 controller 状态变化的 InheritedWidget
Listener footer.
Listen to the indicator state and respond anywhere.
Listener header.
Listen to the indicator state and respond anywhere.
ListParam <T >
Indicates a param being used as queries or form data,
and how does it gets formatted.
ListSelectController <T >
选择控制器（供父组件使用）
ListSelectInherited <T >
InheritedWidget 封装
ListSelectScope <T >
父容器组件
ListSelectState <T >
选择状态管理器
LogDetails
A class for transporting data
about an log message
LogFilter
日志过滤器接口
LoggerFilter
Abstract filter for messages logging.
LoggerFormatter
Responsible for formatting message before output
LoggingInterceptor
日志拦截器工厂类
封装 TalkerDioLogger 以便提供高颜值且符合项目规范的日志
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.
LogLevelFilter
This filter checks that current message level
is above certain LogLevel setting in TalkerLoggerSettings
LogSettings
日志配置类
LostData
The response object of ImagePicker.retrieveLostData .
LostDataResponse
The response object of ImagePicker.getLostData.
Material footer.
Material header.
ModalBottomSheet
A custom bottom sheet.
ModalBottomSheetState
ModalScrollController
Associates a ScrollController with a subtree.
ModalSheetRoute <T >
MoneyFormat
MultipartFile
An upload content that is a part of MultipartRequest.
This doesn't need to correspond to a physical file.
Notifier <ValueT > Notifiers
A class which exposes a state that can change over time.
NotifierProvider <NotifierT extends Notifier <ValueT > , ValueT > Providers
A provider that exposes a synchronous Notifier .
Parameters when EasyRefresh.onLoad is null.
Overscroll behavior of ScrollView .
NoTransitionPage <T >
Custom transition page with no transition.
Parameters when EasyRefresh.onRefresh is null.
Overscroll behavior of ScrollView .
ObjectRef <T >
A class that stores a single value.
OnEnterResult
The result of an onEnter callback.
Options
The configuration for a single request.
BaseOptions and Options will be merged into one RequestOptions before
sending the requests. See Options.compose .
Override the Footer parameter.
First of all you have to make it clear that this is feasible,
otherwise please don't use it.
Override the Header parameter.
First of all you have to make it clear that this is feasible,
otherwise please don't use it.
PaginatedResult <T >
分页包装结果
分页元数据信息
PathUtils
Name: Path工具类
基于 path_provider
Created by Fitem on 2023/6/8
Permission
Defines the permissions which can be checked and requested.
PermissionUtils
PermissionWithService
A special kind of permission, used to access a service.
PermissonTips
Phoenix footer.
https://github.com/Yalantis/Phoenix
Phoenix header.
https://github.com/Yalantis/Phoenix
PickedFile
A PickedFile is a cross-platform, simplified File abstraction.
PrefixLogFilter
日志前缀过滤器
PreloadConfig
预加载全局配置
PreloadEngine
预加载执行引擎 — 封装任务验证、依赖解析、执行、重试逻辑
PreloadExecutionResult
预加载执行结果
PreloadManager
预加载管理器 — Facade 模式，负责任务注册、状态流转、对外 API
PreloadProgress
预加载进度信息
PreloadSemaphore
并发控制信号量 — 实现真正的并发数限制
修复原设计中 maxConcurrentTasks 定义但从未生效的问题
PreloadTask <T >
预加载任务 — 通用任务模型
PreloadTracker
进度追踪器 — 监听任务状态变更，计算并推送进度更新
PrivacyBodyConfig
主体配置
PrivacyDialogConfig
弹窗整体外层配置
PrivacyExitConfirmConfig
确认退出弹窗配置
底部配置
头部配置
PrivacyPolicyDialog
ProtocolSegment
协议链接分段
Provider <ValueT > Providers
A provider that exposes a read-only value.
ProviderContainer Core
An object that stores the state of the providers and allows overriding the
behavior of a specific provider.
ProviderObserver Core
An object that listens to the changes of a ProviderContainer .
ProviderObserverContext Core
Information about the ProviderObserver event.
ProviderReference
The response of ProviderContainer.allProviders .
ProviderScope Core
A widget that stores the state of providers.
ProviderSubscription <OutT > Core
Represents the subscription to a ProviderListenable.
QueuedInterceptor
Interceptor in queue.
QueuedInterceptorsWrapper
A helper class to create QueuedInterceptor in ease.
RebuildFactors
REdgeInsets
REdgeInsetsDirectional
RedirectRecord
A record that records the redirection happens during requests,
including status code, request method, and the location.
Ref Core
An object used by providers to interact with other providers and the life-cycles
of the application.
RelativeGoRouteData Type-safe routes
A class to represent a relative GoRoute in
Type-safe routing .
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.
ResponseParser
响应字段解析器
用于根据配置拆包外层格式，提取真实 data，或报错抛出业务异常。
ResponseParsingConfig
响应字段解析配置
RetryInterceptor
请求重试拦截器
当发生网络层错误进行有限策略重试
RouteBase
The base class for GoRoute and ShellRoute .
RouteBuilder
Builds the top-level Navigator for GoRouter.
RouteConfiguration
The route configuration for GoRouter configured by the app.
RouteData
Baseclass for supporting
Type-safe routing .
RouteInformationState <T >
The data class to be stored in RouteInformation.state to be used by
GoRouteInformationParser .
RouteMatch
An matched result by matching a GoRoute against a location.
RouteMatchBase
The base class for various route matches.
RouteMatchList
The list of RouteMatchBase objects.
RoutingConfig Configuration
A set of parameters that defines routing in GoRouter.
RPadding
RSizedBox
ScreenUtil
ScreenUtilInit
Secondary builder footer.
Secondary builder header.
Secondary footer.
Combine existing Footer with secondary.
Secondary header.
Combine existing Header with secondary.
ShellRoute Configuration
A route that displays a UI shell around the matching child route.
ShellRouteBase
Base class for classes that act as shells for sub-routes, such
as ShellRoute and StatefulShellRoute .
ShellRouteContext
Context object used when building the shell and Navigator for a shell route.
ShellRouteData
A class to represent a ShellRoute in
Type-safe routing .
ShellRouteMatch
An matched result by matching a ShellRoute against a location.
SmartConfigAttach
showAttach() global config
SmartConfigCustom
show() global config
SmartConfigLoading
showLoading() global config
SmartConfigNotify
show() global config
SmartConfigToast
showToast() global config
SmartDialog
SmartDialogController
SmartDialog Controller
StatefulHookConsumerWidget
A StatefulWidget that is both a ConsumerWidget and a HookWidget .
StatefulHookWidget
A StatefulWidget that can use a Hook .
StatefulNavigationShell
Widget for managing the state of a StatefulShellRoute .
StatefulNavigationShellState
State for StatefulNavigationShell.
StatefulShellBranch
Representation of a separate branch in a stateful navigation tree, used to
configure StatefulShellRoute .
StatefulShellBranchData
Base class for supporting
StatefulShellRoute
StatefulShellRoute Configuration
A route that displays a UI shell with separate Navigator s for its
sub-routes.
StatefulShellRouteData
Base class for supporting
StatefulShellRoute
StorageBucket
StorageBucketAccessor
分区访问控制器代理类
StorageEntry <T >
存储条目 - 用于封装带过期时间的数据
Store <StateT , ActionT >
A store of mutable state that allows mutations by dispatching actions.
StormyAlertDialog
统一样式的 Alert（提示）对话框 UI 组件 - 纯 UI 的 stateless
StormyApp
应用根组件
负责应用的 UI 配置和构建
StormyAssetsConfig
Dialog Config - 弹窗配置
用于配置对话框、Toast、Loading 等弹窗样式
StormyConfirmDialog
统一样式的 Confirm（确认）对话框 UI 组件 - 纯 UI 的 stateless
StormyDarkThemeVariant
Stormy 默认深色主题变体
可继承此类以创建自定义深色主题
StormyDialog
StormyDialog - 统一弹窗入口
负责全局的配置化弹窗调度（支持 bottom、center、top）
StormyDialogConfig
全局 Dialog Config
区分 Alert 和 Confirm 类型的默认配置，同时指定默认弹出位置
StormyDialogUIConfig
弹窗 UI 配置 (统一支持各类弹窗样式重写)
StormyI18n
Stormy 多语言核心调度与状态管理器
StormyI18nConfig
多语言配置模型
StormyLightThemeVariant
Stormy 默认浅色主题变体
可继承此类以创建自定义浅色主题
StormyListStorage <T >
专门用于处理列表数据的存储封装
StormyLog
日志工具类
StormyNetworkClient
Stormy 统一业务底层网络请求客户端
StormyNetworkConfig
网络配置类
StormyPlatform
Native operations without UI prompts.
StormyPrivacyConfig
隐私协议全局配置防腐层
StormyRefresh
Stormy 刷新模块管理器
用于管理刷新配置
StormyRefreshConfig
Refresh Config - 刷新配置
用于配置下拉刷新和上拉加载的相关参数
StormyRefreshStateTexts
具体状态下的文本配置
用于指定不同刷新状态下的显示文本，优先级高于 StormyRefreshTextConfig
StormyRefreshTextConfig
刷新文本配置
用于配置下拉刷新和上拉加载的相关文本内容
StormyServices
Optional default services; applications can also own independent clients.
StormyStorage
StormyStorage - 统一存储总控入口
采用面相对象模型与 Accessor 返回隔离实例执行工作。
StormyStorage 本身混入了 StorageOperations ，可以直接对设定的 Default Bucket 操作键值对。
StormyStorageConfig
Storage Config - 存储配置
用于配置本地存储的相关参数
StormyTheme
Stormy Theme - 主题管理器
提供主题切换功能，整合 adaptive_theme
使用方式：通过 stormy() 配置器配置，主题在 apply 时自动应用
StormyThemeConfig
Stormy Theme Config - 主题配置
用于配置 Stormy 主题，支持主题色和自定义主题变体
StormyUiConfig
StreamNotifier <ValueT > Notifiers
A variant of AsyncNotifier which has build creating a Stream .
StreamNotifierProvider <NotifierT extends StreamNotifier <ValueT > , ValueT > Providers
A provider which creates and listen to an StreamNotifier .
StreamProvider <ValueT > Providers
Creates a stream and exposes its latest event.
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 .
Talker
Talker - advanced exception handling and logging
for dart/flutter applications
TalkerData
Base Talker Data transfer object
Objects of this type are passed through
handlers observer and stream
TalkerDateTimeFormatter
Utility class for DateTime formatting.
TalkerError
Base implementation of TalkerData
to handle ONLY Error s
TalkerErrorHandler
TalkerException
Base implementation of TalkerData
to handle ONLY Exceptionss
TalkerFilter
TalkerHistory
Base class for create your own implementation of history
TalkerJsonFormatter
Formatter for converting data to pretty JSON strings.
TalkerKey
TalkerKey - String key of log type (After 5.0.0)
TalkerLogType (Before 5.0.0)
TalkerLog
Base implementation of TalkerData
to create Logs
TalkerLogger
TalkerLoggerSettings
Logger customization settings
TalkerObserver
Base observer class for
to create your own observers
TalkerSettings
This class used for setup Talker configuration
TaskConfig
TaskExecutionContext
任务执行上下文 — 管理单个任务的执行状态
替代原 PreloadTask 的可变内部状态
Taurus footer.
https://github.com/Yalantis/Taurus
Taurus header.
https://github.com/Yalantis/Taurus
TextSegment
纯文本分段
Transformer
Transformer allows changes to the request/response data before
it is sent/received to/from the server.
TwoDirectionalSlider
A widget that allows interactive two-directional sliding gestures.
TypeAdapter <T >
Type adapters can be implemented to support non primitive values.
TypedGoRoute <T extends GoRouteData >
A superclass for each typed go route descendant
TypedQueryParameter <T >
Annotation to override the URI name for a route parameter.
TypedRelativeGoRoute <T extends RelativeGoRouteData >
A superclass for each typed relative go route descendant
TypedRoute <T extends RouteData >
A superclass for each typed route descendant
TypedShellRoute <T extends ShellRouteData >
A superclass for each typed shell route descendant
TypedStatefulShellBranch <T extends StatefulShellBranchData >
A superclass for each typed shell route descendant
TypedStatefulShellRoute <T extends StatefulShellRouteData >
A superclass for each typed shell route descendant
TypeLogFilter
日志类型过滤器
TypeRegistry
TypeRegistries contain the TypeAdapter s associated with a typeId.
UncontrolledProviderScope Core
Expose a ProviderContainer to the widget tree.
Uuid
uuid for Dart
Author: Yulian Kuncheff
Released under MIT License.
UuidUtils
UuidValue
WatchBoxBuilder
A general-purpose widget which rebuilds itself when the box or a specific
key change.
WebViewConfiguration
Additional configuration options for LaunchMode.inAppWebView .
WidgetRef Core
An object that allows widgets to interact with providers.
XFile
A CrossFile is a cross-platform, simplified File abstraction.
Functions
baseShowConfirm (String title , String content , dynamic onCancel ()?, dynamic onConfirm ()?→ Future <bool
创建默认的上拉加载底部组件
创建默认的下拉刷新头部组件
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 .
defaultDioExceptionReadableStringBuilder (DioException e → String
The default implementation of building a readable string of DioException .
defaultPointerDeviceKind (BuildContext context → PointerDeviceKind
isChineseName (String value → bool
isEmail (String value → bool
isIDCard (String idCard → bool
isNumber (String value → bool
isPhoneNumber (String phoneNumber → bool
kBezierFrictionFactor (double overscrollFraction → double
Friction factor used by bezier curves.
kBezierHorizontalFrictionFactor (double overscrollFraction → double
Horizontal friction factor used by bezier curves.
kBezierSpringBuilder ({required IndicatorMode mode , required double offset , required double actualTriggerOffset , required double velocity → SpringDescription
Spring used by bezier curves.
Creates a rubber band-like bouncing effect with gradual damping.
kBezierSpringBuilderBelow3_32 ({required IndicatorMode mode , required double offset , required double actualTriggerOffset , required double velocity → SpringDescription
Spring used by bezier curves.
Below Flutter 3.32.0
https://github.com/flutter/flutter/issues/163858
kCupertinoFrictionFactor (double overscrollFraction → double
kCupertinoHorizontalFrictionFactor (double overscrollFraction → double
kMaterialFrictionFactor (double overscrollFraction → double
Friction factor used by material.
kMaterialHorizontalFrictionFactor (double overscrollFraction → double
Friction factor used by material horizontal.
kMaterialReadySpringBuilder ({required IndicatorMode mode , required double offset , required double actualTriggerOffset , required double velocity → SpringDescription
Spring description used by material.
launch (String urlString , {bool ?forceSafariVC , bool forceWebView = false , bool enableJavaScript = false , bool enableDomStorage = false , bool universalLinksOnly = false , 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() , BrowserConfiguration browserConfiguration = const BrowserConfiguration() , String ?webOnlyWindowName → Future <bool
Passes url to the underlying platform for handling.
openAppSettings ()
→ Future <bool
Opens the app settings page.
overlayStyleFromColor (Color color → SystemUiOverlayStyle
recursiveCall <T > ({required Future <T > fn (), required bool condition (T int maxRetry = 3 , Duration retryDelay = const Duration(seconds: 1) , Duration timeout = const Duration(seconds: 10) , RetryDelayStrategy delayStrategy = RetryDelayStrategy.fixed , double delayFactor = 0.5 , List <Duration linearDelays = defaultLinearDelays → Future <T >
执行工厂函数 fn，重复创建新实例直到 condition 满足
fn 返回 Future 的工厂函数，每次重试都会重新调用
condition 满足条件，返回 true 时结束重试
maxRetry 最大重试次数
retryDelay 重试延迟（用于 RetryDelayStrategy.fixed 和 RetryDelayStrategy.exponential 的初始值）
timeout 超时时间
delayStrategy 延迟策略，默认为 RetryDelayStrategy.fixed
delayFactor 指数衰减的倍率因子（仅 RetryDelayStrategy.decay 生效），默认 0.5（每次减半）
linearDelays 线性递增策略使用的延迟数组（仅 RetryDelayStrategy.linear 生效）
返回满足 condition 的结果
resetBackground ()
→ String
resetForeground ()
→ String
setRefresh ()
→ Future <void >
showBarModalBottomSheet <T > ({required BuildContext context , required WidgetBuilder builder , Color ?backgroundColor , double ?elevation , ShapeBorder ?shape , Clip ?clipBehavior , Color barrierColor = Colors.black87 , bool bounce = true , bool expand = false , AnimationController ?secondAnimation , Curve ?animationCurve , bool useRootNavigator = false , bool isDismissible = true , bool enableDrag = true , Widget ?topControl , Duration ?duration , RouteSettings ?settings , SystemUiOverlayStyle ?overlayStyle , double ?closeProgressThreshold → Future <T? >
showBaseBottomSheet (BuildContext context , {required Widget child , double minHeight = 0.5 , double maxHeight = 0.8 , Color ?maskColor , bool isDismissible = true , bool enableDrag = true , VoidCallback ?onDismiss → Future <bool ?
显示底部弹窗的便捷方法
showCupertinoModalBottomSheet <T > ({required BuildContext context , required WidgetBuilder builder , Color ?backgroundColor , double ?elevation , ShapeBorder ?shape , Clip ?clipBehavior , Color ?barrierColor , bool expand = false , AnimationController ?secondAnimation , Curve ?animationCurve , Curve ?previousRouteAnimationCurve , bool useRootNavigator = false , bool bounce = true , bool ?isDismissible , bool enableDrag = true , Radius topRadius = _kDefaultTopRadius , Duration ?duration , RouteSettings ?settings , Color ?transitionBackgroundColor , BoxShadow ?shadow , SystemUiOverlayStyle ?overlayStyle , double ?closeProgressThreshold → Future <T? >
showCustomModalBottomSheet <T > ({required BuildContext context , required WidgetBuilder builder , required WidgetWithChildBuilder containerWidget , Color ?backgroundColor , double ?elevation , ShapeBorder ?shape , Clip ?clipBehavior , Color ?barrierColor , bool bounce = false , bool expand = false , AnimationController ?secondAnimation , Curve ?animationCurve , bool useRootNavigator = false , bool isDismissible = true , bool enableDrag = true , Duration ?duration , RouteSettings ?settings , double ?closeProgressThreshold → Future <T? >
Shows a modal material design bottom sheet.
showMaterialModalBottomSheet <T > ({required BuildContext context , required WidgetBuilder builder , Color ?backgroundColor , double ?elevation , ShapeBorder ?shape , Clip ?clipBehavior , Color ?barrierColor , bool bounce = false , bool expand = false , AnimationController ?secondAnimation , Curve ?animationCurve , bool useRootNavigator = false , bool isDismissible = true , bool enableDrag = true , Duration ?duration , RouteSettings ?settings , double ?closeProgressThreshold → Future <T? >
Shows a modal material design bottom sheet.
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.
use <R > (Hook <R > hook → R
Registers a Hook and returns its value.
useAnimation <T > (Animation <T > animation → T
Subscribes to an Animation and returns its value.
useAnimationController ({Duration ?duration , Duration ?reverseDuration , String ?debugLabel , double initialValue = 0 , double lowerBound = 0 , double upperBound = 1 , TickerProvider ?vsync , AnimationBehavior animationBehavior = AnimationBehavior.normal , List <Object ? ?keys → AnimationController
Creates an AnimationController and automatically disposes it when necessary.
useAppLifecycleState ()
→ AppLifecycleState ?
Returns the current AppLifecycleState value and rebuilds the widget when it changes.
useAutomaticKeepAlive ({bool wantKeepAlive = true → void
Mark a widget using this hook as needing to stay alive even when it's in a
lazy list that would otherwise remove it.
useCallback <T extends Function > (T callback , [List <Object ? keys = const <Object>[] → T
Cache a function across rebuilds based on a list of keys.
useCarouselController ({int initialItem = 0 , List <Object ? ?keys → CarouselController
Creates a CarouselController that will be disposed automatically.
useContext ()
→ BuildContext
Obtains the BuildContext of the building HookWidget .
useCupertinoTabController ({int initialIndex = 0 , List <Object ? ?keys → CupertinoTabController
Creates a CupertinoTabController that will be disposed automatically.
useDebounced <T > (T toDebounce , Duration timeout → T?
Returns a debounced version of the provided value toDebounce, triggering
widget updates accordingly after a specified timeout duration.
useDraggableScrollableController ({List <Object ? ?keys → DraggableScrollableController
Creates a DraggableScrollableController that will be disposed automatically.
useEffect (Dispose ?effect (), [List <Object ? ?keys → void
Useful for side-effects and optionally canceling them.
useExpansibleController ({List <Object ? ?keys → ExpansibleController
Creates a ExpansibleController that will be disposed automatically.
useExpansionTileController ({List <Object ? ?keys → ExpansionTileController
Creates a ExpansionTileController that will be disposed automatically.
useFixedExtentScrollController ({int initialItem = 0 , ScrollControllerCallback ?onAttach , ScrollControllerCallback ?onDetach , List <Object ? ?keys → FixedExtentScrollController
Creates FixedExtentScrollController that will be disposed automatically.
useFocusNode ({String ?debugLabel , FocusOnKeyEventCallback ?onKeyEvent , bool skipTraversal = false , bool canRequestFocus = true , bool descendantsAreFocusable = true , bool descendantsAreTraversable = true → FocusNode
Creates an automatically disposed FocusNode .
useFocusScopeNode ({String ?debugLabel , FocusOnKeyEventCallback ?onKeyEvent , bool skipTraversal = false , bool canRequestFocus = true → FocusScopeNode
Creates an automatically disposed FocusScopeNode .
useFuture <T > (Future <T > ?future , {T? initialData , bool preserveState = true → AsyncSnapshot <T >
Subscribes to a Future and returns its current state as an AsyncSnapshot .
useIsMounted ()
→ IsMounted
Returns an IsMounted object that you can use
to check if the State is mounted.
useListenable <T extends Listenable ? > (T listenable → T
Subscribes to a Listenable and marks the widget as needing build
whenever the listener is called.
useListenableSelector <R > (Listenable ?listenable , R selector ()→ R
Rebuild only when there is a change in the selector result.
useMemoized <T > (T valueBuilder (), [List <Object ? keys = const <Object>[] → T
Caches the instance of a complex object.
useOnAppLifecycleStateChange (LifecycleCallback ?onStateChanged → void
Listens to the AppLifecycleState .
useOnListenableChange (Listenable ?listenable , VoidCallback listener → void
Adds a given listener to a Listenable and removes it when the hook is
disposed.
useOnPlatformBrightnessChange (BrightnessCallback onBrightnessChange → void
Listens to the platform Brightness .
useOnStreamChange <T > (Stream <T > ?stream , {void onData (T event void onError (Object error , StackTrace stackTrace void onDone ()?, bool ?cancelOnError → StreamSubscription <T > ?
Subscribes to a Stream and calls the Stream.listen to register the onData,
onError, and onDone.
useOverlayPortalController ({List <Object ? ?keys → OverlayPortalController
Creates a OverlayPortalController that will be disposed automatically.
usePageController ({int initialPage = 0 , bool keepPage = true , double viewportFraction = 1.0 , ScrollControllerCallback ?onAttach , ScrollControllerCallback ?onDetach , List <Object ? ?keys → PageController
Creates a PageController that will be disposed automatically.
usePlatformBrightness ()
→ Brightness
Returns the current platform Brightness value and rebuilds the widget when it changes.
usePrevious <T > (T val → T?
Returns the previous value passed to usePrevious (from the previous widget build).
useReassemble (VoidCallback callback → void
Runs the callback on every hot reload,
similar to reassemble in the stateful widgets.
useReducer <StateT , ActionT > (Reducer <StateT , ActionT > reducer , {required StateT initialState , required ActionT initialAction → Store <StateT , ActionT >
An alternative to useState for more complex states.
useRef <T > (T initialValue → ObjectRef <T >
Creates an object that contains a single mutable property.
useScrollController ({double initialScrollOffset = 0.0 , bool keepScrollOffset = true , String ?debugLabel , ScrollControllerCallback ?onAttach , ScrollControllerCallback ?onDetach , List <Object ? ?keys → ScrollController
Creates ScrollController that will be disposed automatically.
useSearchController ({List <Object ? ?keys → SearchController
Creates a SearchController that will be disposed automatically.
useSingleTickerProvider ({List <Object ? ?keys → TickerProvider
Creates a single usage TickerProvider .
useSnapshotController ({bool allowSnapshotting = false → SnapshotController
Creates and disposes a SnapshotController .
useState <T > (T initialData → ValueNotifier <T >
Creates a variable and subscribes to it.
useStream <T > (Stream <T > ?stream , {T? initialData , bool preserveState = true → AsyncSnapshot <T >
Subscribes to a Stream and returns its current state as an AsyncSnapshot .
useStreamController <T > ({bool sync = false , VoidCallback ?onListen , VoidCallback ?onCancel , List <Object ? ?keys → StreamController <T >
Creates a StreamController which is automatically disposed when necessary.
useTabController ({required int initialLength , Duration ?animationDuration = kTabScrollDuration , TickerProvider ?vsync , int initialIndex = 0 , List <Object ? ?keys → TabController
Creates a TabController that will be disposed automatically.
useTransformationController ({Matrix4 ?initialValue , List <Object ? ?keys → TransformationController
Creates and disposes a TransformationController .
useTreeSliverController ()
→ TreeSliverController
Creates a TreeSliverController that will be disposed automatically.
useValueChanged <T , R > (T value , R? valueChange (T oldValue , R? oldResult → R?
Watches a value and triggers a callback whenever the value changed.
useValueListenable <T > (ValueListenable <T > valueListenable → T
Subscribes to a ValueListenable and returns its value.
useValueNotifier <T > (T initialData , [List <Object ? ?keys → ValueNotifier <T >
Creates a ValueNotifier that is automatically disposed.
useWidgetStatesController ({Set <WidgetState ?values , List <Object ? ?keys → WidgetStatesController
Creates a WidgetStatesController that will be disposed automatically.
validateStorageKey (Object key → void
Hive keys are strings or integers; their types must survive enumeration.
Typedefs
BezierSpinBuilder
= Widget Function(BuildContext context , double value
A builder that builds a spin widget.
context BuildContext.
value Animation value.
BoxWidgetBuilder T >
= Widget Function(BuildContext context , Box <T > box
Signature for a function that builds a widget given a Box .
BrightnessCallback
= FutureOr <void > Function(Brightness previous , Brightness current
A callback triggered when the platform brightness changes.
CanProcessCallBack
= bool Function()
Indicator widget builder.
CIMessageBuilder
= Widget Function(BuildContext context , IndicatorState state , String text , DateTime dateTime
Message widget builder.
CIPullIconBuilder
= Widget Function(BuildContext context , IndicatorState state , double animation
Pull icon widget builder.
CITextBuilder
= Widget Function(BuildContext context , IndicatorState state , String text
Text widget builder.
CompactionStrategy
= bool Function(int entries , int deletedEntries
A function which decides when to compact a box.
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.
DioExceptionReadableStringBuilder
= String Function(DioException e
The readable string builder's signature of
DioException.readableStringBuilder .
DioMediaType
The type (alias) for specifying the content-type of the MultipartFile.
Dispose
= void Function()
A function called when the state of a widget is destroyed.
ERChildBuilder
= Widget Function(BuildContext context , ScrollPhysics physics
EasyRefresh child builder.
Provide ScrollPhysics , and use it in your ScrollView .
ScrollPhysics will not be scoped.
ERScrollBehaviorBuilder
= ScrollBehavior Function(ScrollPhysics ?physics
ExitCallback
= FutureOr <bool Function(BuildContext context , GoRouterState state
Signature for function used in RouteBase.onExit.
FlutterSmartLoadingBuilder
= Widget Function(String msg
FlutterSmartStyleBuilder
= Widget Function(Widget child
FlutterSmartToastBuilder
= Widget Function(String msg
FontSizeResolver
= double Function(num fontSize , ScreenUtil instance
FrictionFactor
= double Function(double overscrollFraction
The multiple applied to overscroll to make it appear that scrolling past
the edge of the scrollable contents is harder than scrolling the list.
This is done by reducing the ratio of the scroll effect output vs the
scroll gesture input.
GoExceptionHandler
= void Function(BuildContext context , GoRouterState state , GoRouter router
The function signature of GoRouter.onException.
GoRouterBuilderWithNav
= Widget Function(BuildContext context , Widget child
Signature of a go router builder function with navigator.
GoRouterPageBuilder
= Page Function(BuildContext context , GoRouterState state
The page builder for GoRoute .
GoRouterRedirect
= FutureOr <String ? Function(BuildContext context , GoRouterState state
The signature of the redirect callback.
GoRouterWidgetBuilder
= Widget Function(BuildContext context , GoRouterState state
The widget builder for GoRoute .
The signature that iterates header fields.
HiveLogger
Hive's logger
HiveLoggerLevel
Hive's logger level
IndicatorBuilder
= Widget Function(BuildContext context , IndicatorState state
Indicator widget builder.
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 .
IsMounted
= bool Function()
Used by useIsMounted to allow widgets to determine if the Widget is still
in the widget tree or not.
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.
KeyComparator
= int Function(dynamic key1 , dynamic key2
LifecycleCallback
= FutureOr <void > Function(AppLifecycleState ?previous , AppLifecycleState current
A callback triggered when the app life cycle changes.
LocaleResolver
= Future <Locale ? Function()
回调类型：用于从本地持久化中读取语种代码（如 返回 Locale('zh', 'CN')，为 null 表示跟随系统）
LocaleSaver
= Future <void > Function(Locale ?locale
回调类型：用于将新的语种代码写入本地持久化
LoggerOutput
= void Function(String message
ModeChangeListener
= void Function(IndicatorMode mode , double offset
Mode change listener.
NavigationCallback
= Future <RouteMatchList Function()
The function signature for navigation callbacks in _OnEnterHandler.
NavigatorBuilder
= Widget Function(GlobalKey <NavigatorState navigatorKey , ShellRouteMatch match , RouteMatchList matchList , List <NavigatorObserver ?observers , String ?restorationScopeId
Signature for functions used to build Navigators
OnEnter
= FutureOr <OnEnterResult Function(BuildContext context , GoRouterState currentState , GoRouterState nextState , GoRouter goRouter
The signature for the top-level onEnter callback.
OnEnterThenCallback
= FutureOr <void > Function()
Signature for callbacks invoked after an OnEnterResult is resolved.
OnUnauthorized
= Future <void > Function(DioException error
ParserExceptionHandler
= RouteMatchList Function(BuildContext context , RouteMatchList routeMatchList
The function signature of GoRouteInformationParser.onParserException .
PopPageWithRouteMatchCallback
= bool Function(Route route , dynamic result , RouteMatchBase match
Signature for a function that takes in a route to be popped with
the result and returns a boolean decision on whether the pop
is successful.
ProgressCallback
= void Function(int count , int total
The type of a progress listening callback when sending or receiving data.
QueryParameterDecoder T >
= T Function(String value
Signature for custom query parameter decoding functions.
QueryParameterEncoder T >
= String Function(T value
Signature of custom query parameter encoding.
RebuildFactor
= bool Function(MediaQueryData old , MediaQueryData data
Reducer State , Action >
= State Function(State state , Action action
Composes an Action and a State to create a new State.
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.
RetryEvaluator
= Future <bool Function(DioException error , int attempt
RouteInfoState RouteInformationState
Type alias for route information state with dynamic type parameter.
RouteMatchVisitor
= bool Function(RouteMatchBase
The function signature for RouteMatchList.visitRouteMatches
ScreenUtilInitBuilder
= Widget Function(BuildContext context , Widget ?child
SecondaryIndicatorBuilder
= Widget Function(BuildContext context , IndicatorState state , Indicator indicator
Secondary indicator widget builder.
ShellNavigationContainerBuilder
= Widget Function(BuildContext context , StatefulNavigationShell navigationShell , List <Widget children
Builder for a custom container for the branch Navigators of a
StatefulShellRoute .
ShellRouteBuilder
= Widget Function(BuildContext context , GoRouterState state , Widget child
The widget builder for ShellRoute .
ShellRoutePageBuilder
= Page Function(BuildContext context , GoRouterState state , Widget child
The page builder for ShellRoute .
SpringBuilder
= SpringDescription Function({required double actualTriggerOffset , required IndicatorMode mode , required double offset , required double velocity
Build spring with IndicatorMode and offset.
mode Indicator mode.
offset Indicator offset.
actualTriggerOffset Indicator actual trigger offset.
velocity Indicator actual trigger offset.
StatefulShellRouteBuilder
= Widget Function(BuildContext context , GoRouterState state , StatefulNavigationShell navigationShell
The widget builder for StatefulShellRoute .
StatefulShellRoutePageBuilder
= Page Function(BuildContext context , GoRouterState state , StatefulNavigationShell navigationShell
The page builder for StatefulShellRoute .
StormyThemeVariantFactory
= StormyThemeVariant Function()
主题变体工厂函数类型
用于在需要时动态创建主题变体实例
StormyThemeVariantFactoryOrNull
= StormyThemeVariant ? Function()
主题配置工厂函数类型（可选）
当需要时才调用创建默认变体
ValidateStatus
= bool Function(int ?status
The type of a response status code validate callback.
WidgetWithChildBuilder
= Widget Function(BuildContext context , Animation <double animation , Widget child
