flutter_chen_common 1.7.0
flutter_chen_common: ^1.7.0 copied to clipboard
The flutter common package designed to help developers swiftly build aesthetically pleasing and feature-rich mobile application interfaces.
Flutter Chen Common #
🌟 简介 #
本库为Flutter应用开发提供一站式解决方案,包含:
- 可定制的主题系统
- 完整的国际化支持
- 企业级网络请求封装
- N+高质量常用组件
- 常用开发工具及扩展集合
- 刷新列表全方面解决方案
- 开箱即用的通用各类弹窗
- 图片处理全流程解决方案
- 阿里云OSS集成
特性 #
- 🎨 主题系统:通过
ThemeExtension全局配置颜色/圆角/间距等样式 - 🌍 国际化支持:内置中英文,支持自定义文本和动态语言切换
- ⚡ 优先级覆盖:支持全局主题配置 + 组件级参数覆盖
- 📱 自适应设计:完美适配 iOS/Material 设计规范
安装 #
在 pubspec.yaml 中添加依赖:
dependencies:
flutter_chen_common: 最新版本
运行命令:
flutter pub get
快速开始 #
网络请求配置 #
/// 初始化RequestClient,传入baseUrl以及请求拦截器
await RequestClient.init(
baseUrl: Env.getEnvConfig().baseUrl,
interceptors: [RequestInterceptor()]);
/// 使用
RequestClient.instance.request(
"/xxxx",
method: HttpType.post.name,
)
其他配置以及OSS #
/// 初始化SharedPreferences
await SpUtil.init();
ComConfig.setOssConfig(Global.ossConfig);
static Future<Map<String, dynamic>> ossConfig() async {
var res = await AppApi.ossToken();
var params = {
"accessKeyId": res["accessKeyId"],
"policy": res["policy"],
"signature": res["signature"],
"url": "https://${res["bucket"]}.oss-ap-southeast-1.aliyuncs.com",
"dir": "appName"
};
return params;
}
全局主题配置 #
MaterialApp(
theme: ThemeData.light().copyWith(
extensions: [
ComTheme.light()
]
),
home: HomePage(),
)
主题系统 #
内置主题 #
| 主题名称 | 示例代码 |
|---|---|
| Light Theme | ComTheme.light |
| Dark Theme | ComTheme.dark |
可配置属性 #
ComTheme(
theme: ComColors.lightTheme, // 颜色体系
shapes: ComShapes.standard, // 圆角体系
spacing: ComSpacing.standard, // 间距体系
primaryGradient: LinearGradient(
colors: [
ComColors.lightTheme.shade500,
ComColors.lightTheme.shade500,
],
),
success: Colors.green.shade600,
error: Colors.red.shade600,
warning: Colors.orange.shade600,
link: Colors.blue.shade600,
)
// 色系
static MaterialColor lightTheme = const MaterialColor(
0xFF3783FD,
<int, Color>{
50: Color(0xfff8f6f9), // surface 背景色
100: Color(0xfff8f2fa), // surfaceContainerLow 浅色背景色
200: Color(0xfff2ecf4), // surfaceContainer 标准背景色
300: Color(0xffece6ee), // surfaceContainerHigh 较深背景色
400: Color(0xffe6e0e9), // surfaceContainerHighest 深色背景色
500: Color(0xFF3783FD), // primary 主题色
600: Color(0xff1d1b20), // onSurface 主要内容色
700: Color(0xFF909399), // onSurfaceVariant 次要内容色
800: Color(0xffffffff), // surfaceContainerLowest 相同色
900: Color(0xff322f35), // inverseSurface 相反色
},
);
📦 工具类(Utils) #
| 文件名 | 功能描述 |
|---|---|
clipboard_util.dart |
剪贴板操作工具(复制/粘贴文本、监听剪贴板内容) |
clone_util.dart |
对象深拷贝/浅拷贝工具(支持复杂对象克隆) |
color_util.dart |
颜色处理工具(HEX与RGB互转、颜色混合、随机颜色生成) |
date_util.dart |
日期时间工具(格式化、解析、计算时间差) |
device_util.dart |
设备信息工具(获取设备信息) |
encrypt_util.dart |
加密解密工具(算法封装) |
file_util.dart |
文件操作工具(读写文件、目录管理、文件压缩/解压) |
function_util.dart |
通用函数工具(防抖/节流、空安全处理、类型转换) |
image_util.dart |
图片处理工具(压缩、缓存管理、网络图片加载、格式转换) |
json_util.dart |
JSON工具(序列化/反序列化、动态解析、数据校验) |
keyboard_util.dart |
键盘工具(控制键盘显隐、监听高度变化) |
log_util.dart |
日志工具(分级输出、日志存储、调试模式开关) |
package_util.dart |
应用包管理工具(获取应用包信息) |
permission_util.dart |
权限管理工具(全局权限处理、多权限判断及请求) |
sp_util.dart |
本地存储工具(基于SharedPreferences,支持复杂数据存取) |
text_util.dart |
文本处理工具(字符串校验、截断、正则匹配) |
🎨 通用帮助类(Helpers) #
| 文件名 | 功能描述 |
|---|---|
dialog_helper.dart |
弹窗帮助类(通用各类弹窗Toast、Android、iOS确定弹窗、弹窗、选择弹窗、底部弹窗等) |
image_helper.dart |
图片帮助类(图片选择、裁剪、上传) |
oss_helper.dart |
oss帮助类(签名上传oss) |
🎨 通用组件(Widgets) #
| 文件名 | 功能描述 |
|---|---|
refresh_widget.dart |
刷新列表组件(包含上拉加载、下拉刷新、回至顶部、页面数据状态视图(加载、空数据、列表、瀑布流)等功能) |
base_widget.dart |
基础组件基类(统一多状态管理,无网络自动切换该状态布局) |
com_album.dart |
相册组件(图片九宫格仿微信朋友圈显示) |
com_arrow.dart |
方向箭头组件(支持上下左右箭头,常用于列表项导航) |
com_avatar.dart |
头像组件(圆形/方形、网络/本地/文字头像) |
com_button.dart |
按钮组件(主按钮、线性按钮、禁用状态、渐变色、自定义样式) |
com_checkbox.dart |
复选框组件(支持单选/多选、自定义图标) |
com_checkbox_list_title.dart |
列表复选框组件(ListTitle形式下的复现框) |
com_container.dart |
通用容器(圆角、阴影、渐变背景、内边距配置) |
com_empty.dart |
空状态组件(数据为空时展示占位图或提示文字) |
com_gallery.dart |
图片画廊组件(图片查看预览等操作) |
com_image.dart |
增强图片组件(占位图、加载失败兜底、缓存策略) |
com_list_group.dart |
分组列表组件(下划线分隔的列表项布局,自定义下划线) |
com_loading.dart |
加载组件(全局Loading,可自定义) |
com_popup_menu.dart |
弹出菜单组件(自定义菜单项、位置调整) |
com_rating.dart |
评分组件(星级评分、支持半星、自定义图标) |
com_tag.dart |
标签组件(多颜色/尺寸、圆角样式) |
com_title_bar.dart |
标题栏组件(左中右布局、标题居中、常用于底部弹窗标题) |
RefreshWidget #
class DemoLogic extends PagingController {
@override
Future<PagingResponse> loadData() async {
// TODO: implement loadData
dynamic result = {"current": 1, "total": 3, "records": []};
await Future.delayed(2000.milliseconds, () {
for (var i = 0; i < 20; ++i) {
result["records"]?.add(i);
}
});
return PagingResponse.fromMapJson(result);
}
}
class DemoPage extends StatelessWidget {
DemoPage({Key? key}) : super(key: key);
final logic = Get.find<DemoLogic>();
@override
Widget build(BuildContext context) {
return GetBuilder<DemoLogic>(
builder: (controller) {
return Scaffold(
body: RefreshWidget(
controller: logic,
slivers: [
RefreshListWidget(
itemBuilder: (item, index) => _buildItem(index),
controller: logic,
showList: false),
],
));
},
id: logic.pagingState.refreshId,
);
}
Widget _buildItem(index) {
if (index % 3 == 0) {
return Container(
color: Colors.deepOrange,
width: double.infinity,
height: 300.h,
);
}
return Container(
color: Colors.green,
width: double.infinity,
height: 200.h,
);
}
}
示例项目 #
查看完整示例:
git clone https://github.com/Er-Dong-Chen/flutter-common.git
cd flutter-common/example
flutter run
贡献指南 #
欢迎提交 PR 或 Issue!贡献前请阅读:
- 代码规范
- 全局主题指南
- 国际化指南
- 测试要求
许可证 #
MIT License - 详情见 LICENSE 文件