w library
Classes
- ApiClientId
- API 客户端标识符(不可变),用于区分多个 API 客户端
- Barcode
- The Barcode object holds information about the barcode or qr code.
- BaseLocalDataSource
- 本地数据源基础类,所有本地数据源都应继承此类
- BaseRemoteDataSource
- 网络数据源基础类,所有网络数据源都应继承此类
-
BaseRepository<
LocalDataSourceType extends BaseLocalDataSource?, RemoteDataSourceType extends BaseRemoteDataSource?> - 数据仓库基础类:整合本地数据源与网络数据源
- DioRegistry
-
Dio 实例注册表:按
baseUrl缓存并复用Dio实例 - IApiPath
- API 路径契约:定义如何获取基础 URL
- SystemFeatures
- WApiConfig
- API / 网络层配置
- WApp
- 应用初始化和运行工具类
- WAppBar
- 自定义导航栏组件
- WAppBarConfig
- 导航栏配置类
- WAppConfig
- 应用层配置(语言)
- WAppPlugin
- WApp 插件接口 — 让第三方能力以声明式注入应用生命周期
- WAssets
- 全局资产配置
- WAsync
- 异步操作助手
- WAsyncConfig
- 异步操作配置
- WBadge
- 徽章组件,用于显示角标或标记
- WBadgeConfig
- 徽章配置类,用于配置徽章的位置和显示状态
- WBottomSheet
-
底部弹窗工具(基于 GetX 的
Get.bottomSheet/Get.back) - WButton
- 点击效果组件
- WButtonConfig
- 按钮配置类
- WCancellableAction
- 可取消的防抖 / 节流函数包装
- WCancelToken
- 协作式取消令牌
- WCardNumberInputFormatter
- 银行卡号输入格式化器
- WClipRRect
- 圆角裁剪组件,用于为子组件添加圆角
- WClipRRectConfig
- 圆角裁剪配置类,用于配置裁剪的圆角
- WColumn
- Column 便捷工厂
- WConfig
- 应用配置类(Umbrella 兼容层)
- WConfigSetup
- WConfig 链式配置辅助类(保持旧 API)
- WContainer
- 增强版容器组件
- WContainerConfig
- 容器配置类
- WCountdown
- 倒计时工具
- WDividerInputFormatter
- 通用分隔符输入格式化器
- WEncrypt
- 加密工具类
- WFormBorder
- WFormBorder 组件是一个表单边框容器,用于为表单输入添加统一的边框样式和错误提示
- WFormBorderBuilderLayout
- 函数式布局实现
- WFormBorderColumnLayout
- 默认布局实现:边框在上、消息在下
- WFormBorderConfig
- 表单边框配置类,定义边框的样式和构建器
- WFormBorderDecoration
- 表单边框装饰类,定义边框、背景色、圆角、阴影和渐变等样式
- WFormBorderLayout
- 边框与消息的布局策略
- WFormBorderLayoutData
- 边框与消息的布局输入
- WFormBorderState
- WFormBorder 的状态类
- WFormBorderWithData
- 自动从祖先 WFormBuilder 获取表单数据、并复用同一个边框 key 的 WFormBorder
- WFormBuilder
- 表单构建器组件,用于创建和管理表单
- WFormButton
- 表单按钮组件,用于创建可点击的表单字段
- WFormButtonConfig
- 表单按钮配置类,定义按钮的样式和行为
- WFormCheckbox
- 单个复选框字段组件
- WFormCheckboxConfig
- 复选框配置类,定义复选框的样式和行为
- WFormCustomValidator
-
自定义校验器命名空间(面向
FormBuilderValidators) - WFormData
- 表单数据管理类
- WFormDatePicker
- 表单日期选择器组件
- WFormDatePickerConfig
- 日期选择器配置类,定义日期选择器的样式和行为
- WFormDefaults
- 表单全局默认值
-
WFormDropdown<
T> - 表单下拉选择组件
- WFormDropdownConfig
- 下拉选择配置类,定义下拉选择的样式和行为
- WFormMultiDropdown
- 表单多选下拉框组件
- WFormMultiDropdownConfig
- 多选下拉框配置类,定义多选下拉框的样式和行为
- WFormPopup
- 表单弹出层工具
-
WFormPopupRoute<
T> - 表单弹出层路由
-
WFormRadioGroup<
T> - 表单单选按钮组组件
- WFormRadioGroupConfig
- 单选按钮组配置类,定义单选按钮组的样式和行为
- WFormReadOnlyScope
- 表单只读作用域:向下传递「当前整块表单项是否只读」
- WFormTextField
- 表单单行文本输入组件
- WFormTextFieldAction
- 表单文本框 action 的通用实现
- WFormTextFieldClearButton
- 清空文本按钮(预置 action)
- WFormTextFieldConfig
- 文本输入配置类,定义文本输入的样式和行为
- WFormTextFieldData
- WFormTextField 暴露给 actions / leading 槽 Widget 的只读接口。
- WFormTextFieldPasswordToggle
- 密码可见/隐藏切换按钮(预置 action)
- WFormTextFieldScope
- 承载 WFormTextField 内部状态的 InheritedWidget,实现 WFormTextFieldData。
- WFormValidator
- 表单验证器类,用于管理和执行表单验证
- WFormValidatorConfig
- 表单验证器配置类,定义验证器的行为
- WFormValidatorItem
- 表单验证项类,定义单个字段的验证规则
- WGradientCircularProgressIndicator
- 带渐变效果的圆形进度指示器
- WHash
- 哈希工具类
- WImage
- 图片组件
- WImageCacheManager
- 图片缓存管理器
- WImageConfig
- 图片配置类
- WImageController
- 图片控制器
- WImageGlobalConfig
- 图片全局配置类
- WImageProgress
- 图片加载进度
- WInputFormatters
- 常用文本输入格式化器集合
- WKeepAliveWrapper
- 页面保持组件,用于保持子组件的状态
- WLanguage
- 语言管理类,用于管理应用语言设置并在语言变更时通知监听者
- WListView
- 增强版列表组件
- WListViewConfig
- 列表配置类
- WLogger
- 日志工具类(静态入口)
- WLogInterceptor
- 日志拦截器,用于记录 HTTP 请求和响应的详细信息
-
WMap<
T> - 通用地图组件
-
WMapConfig<
T> - 地图组件配置类
-
WMapController<
T> - WMap 的控制器:用于从业务 UI 侧触发地图动作(目前只有「关闭选中」)。
- WMapIconAssets
- 资产图标预热。
- WMapItem
- 地图条目抽象基类
-
WMapItemMapper<
T> - 从业务模型里取地图所需字段的适配器。
-
WMapZone<
T> - 地图区域类
- 底部导航栏组件
- 导航栏配置类
- 底部导航栏控制器
-
WNotificationListenerBuilder<
T extends Notification> - 通知监听器构建器,用于创建和配置 NotificationListener 组件
- WPadding
- Padding 工具类,提供静态工厂方法
- WPlatform
- 平台工具类
- WQrController
- 相机控制器封装
- WQrView
- 二维码 / 条形码扫描组件
- WQrViewOverlayShape
- 二维码扫描框样式配置
- WQrViewState
- WQrView 的状态
- WRegExp
- 常用正则表达式与匹配 / 提取 / 格式化工具
- WRegExpPattern
- 常用正则表达式字符串常量
- WRegExpPreset
- 按分类组织的正则表达式字符串
- WRichText
- 富文本组件,用于显示包含多种样式的文本
- WRichTextConfig
- 富文本配置类,用于配置富文本的样式
- WRoute
- 路由工具类:维护路由栈并按名称操作路由
- WRouteObserver
- 路由观察者:监听路由变化并维护 WRoute 中的路由列表
- WRow
- Row 便捷工厂
- WRowButtons
- 横向滚动按钮组件,用于创建可横向滚动的按钮列表
- WRowButtonsController
- 横向滚动按钮控制器,用于管理按钮的选中状态和滚动
- WScaffold
- 增强版脚手架组件,提供更多自定义选项
- WScaffoldConfig
- WScaffold 配置类,用于链式构建 WScaffold
- WScreen
- 屏幕尺寸与适配工具(零第三方依赖,可与 flutter_screenutil 共存)
- WSizeBox
- SizedBox 工具类,提供便捷的创建方法
- WStep
- 步骤指示器组件
- WStepConfig
- 步骤指示器配置类
- WStorage
- 基于 SharedPreferences 的静态工具类,用于本地存储操作
- WTabBar
- 自定义标签栏组件
- WTabBarConfig
- 标签栏配置类
- WText
- 文本组件,用于显示和配置文本样式
- WTextConfig
- 文本配置类,用于配置文本的样式
- WToast
- BotToast 的轻量封装
- WToastConfig
- 提示配置与调用入口
- WToken
- Token 管理
- WTokenInterceptor
- Token 拦截器,用于处理 token 的添加、更新和错误处理
- WUx
- 用户体验工具类(单例)
- WValidator
- 数据校验工具类
Enums
- BarcodeFormat
- CameraFacing
- Level
- Levels to control logging output. Logging can be enabled to include all levels above certain Level.
- WButtonEffectType
- 按钮效果类型枚举
- WCountdownRemainingType
- 倒计时剩余时间的格式化类型
- WImageLoadStatus
- 图片加载状态枚举
- WImageType
- 图片类型枚举
- WPlatformType
- 平台类型
Extensions
- HexColor on Color
- 颜色扩展类,提供十六进制颜色转换功能
- WColumnExtension on Column
- Column 扩展,提供常用的布局辅助方法
- WFormBorderDecorationExtension on WFormBorderDecoration
- WFormBorderDecoration 扩展,提供链式调用方法
- WFormRowBorderExtension on Row
- Row 扩展,为 Row 附加表单边框(WFormBorderWithData)及内部只读下发能力
-
WGlobalKeyExtension
on GlobalKey<
State< StatefulWidget> > - GlobalKey 扩展类,提供获取组件位置和大小的方法
- WImageConfigBuild on WImageConfig
- WImageConfig 的构建便利方法
- WImageExtension on Image
- 图片扩展类,提供图片预加载功能
-
WMapExtension
on Map<
K, V> - Map 扩展:按键排序与合并
- WNotificationListenerBuilderExtension on Widget
- WNotificationListenerBuilder 的便捷构造函数扩展
- WNumExtension on num
- num 扩展类,提供便捷的 SizedBox 创建方法和其他实用方法
- WRowExtension on Row
- Row 扩展,提供常用的布局辅助方法
- WStringExtension on String
- String 扩展(纯 Dart 工具方法 + hex→Color 转换)
- WStrutStyleExtension on StrutStyle
- StrutStyle 扩展(便捷方法)
- WTextStyleExtension on TextStyle
- TextStyle 扩展(便捷方法)
- WUiStringExtension on String
- String 扩展(ui 组件相关,依赖 WImage)
- WUiStrutStyleExtension on StrutStyle
- StrutStyle 扩展(组件相关,依赖 WTextConfig)
- WUiTextStyleExtension on TextStyle
- TextStyle 扩展(组件相关,依赖 WTextConfig)
- WUiWidgetExtension on Widget
- Widget 扩展(依赖 ui 组件)
- WWidgetExtension on Widget
- Widget 扩展(通用工具方法,不依赖 ui 组件)
Functions
-
wMapItemMapper<
T> () → WMapItemMapper< T> -
implements WMapItem时的默认 mapper。
Typedefs
- WCountdownCallback = void Function(int value)
- 倒计时回调函数类型,参数为秒数
- WFormBorderLayoutBuilder = Widget Function(BuildContext context, WFormBorderLayoutData data)
- 布局构建函数
Exceptions / Errors
- CameraException
- This is thrown when the plugin reports an error.
- WCancellationException
- 取消异常
- WImageAssetError
- 本地资源加载失败
- WImageDecodeError
- Base64 解码失败
- WImageEmptyError
- 数据为空(空串 / 纯空白)
- WImageError
- 图片加载错误
- WImageFileError
- 本地文件读取失败
- WImageNetworkError
- 网络加载失败
- WImageUnsupportedError
-
当前平台不支持该来源(例如 Web 上的
file://)