flutter pub add horizontal_data_table基于插件公开信息、社区数据与项目使用情况整理的选型参考。
一个 Flutter 包，提供带有固定左列的横向数据表，非常适合显示结构化数据，其中一列在水平滚动时保持可见。通过在用户滚动大量数据时保持关键标识符或标签固定，提升了可用性。专为跨平台使用设计，支持 Android、iOS、Web、macOS、Windows 和 Linux。该包轻量且可无缝集成到现有的 Flutter 应用中。
以下为关联源码仓库的 README 原文快照，最新内容请访问源码仓库。
A Flutter Widget that create a horizontal table with fixed first column.
The following is the guide for installation with different dart sdk and flutter version.
| minium dart sdk | flutter version (stable) | package version |
|---|---|---|
| <2.12.0 | <2.0.1 | 2.5.1 |
| <2.12.0 | =2.0.1 | 2.5.2 |
| >=2.12.0 (enabled null-safety) | >=2.0.1 && <3.0.0 | 3.6.2+1 |
| >=2.12.0 | >=3.0.0 && <3.3.0 | 4.1.1+3 |
| >=2.12.0 && < 2.18.0 | >=3.3.0 && <3.7.0 | 4.1.4 |
| >=2.18.0 && <2.19.0 | >=3.7.0 | 4.2.0 |
| >=2.19.0 | >=3.7.0 | latest |
Run this command to install latest:
flutter pub add horizontal_data_table
onScrollControllerReady: (vertical, horizontal) {
_verticalScrollController = vertical;
_horizontalScrollController = horizontal;
},
This shows Widget's full customizations:
HorizontalDataTable(
{
required double leftHandSideColumnWidth,
required double rightHandSideColumnWidth,
this.tableHeight,
this.isFixedHeader = false,
this.headerWidgets,
this.isFixedFooter = false,
this.footerWidgets,
IndexedWidgetBuilder? leftSideItemBuilder,
IndexedWidgetBuilder? rightSideItemBuilder,
this.itemCount = 0,
List<Widget>? leftSideChildren,
List<Widget>? rightSideChildren,
this.rowSeparatorWidget = const Divider(
color: Colors.transparent,
height: 0.0,
thickness: 0.0,
),
this.elevation = 3.0,
this.elevationColor = Colors.black54,
Color leftHandSideColBackgroundColor = Colors.white,
Color rightHandSideColBackgroundColor = Colors.white,
this.onScrollControllerReady,
this.verticalScrollbarStyle,
this.horizontalScrollbarStyle,
this.enablePullToRefresh = false,
this.refreshIndicatorHeight = 60.0,
this.htdRefreshController,
this.onRefresh,
this.refreshIndicator,
this.fixedSidePlaceHolderRefreshIndicator,
this.enablePullToLoadNewData = false,
this.onLoad,
this.loadIndicator,
this.fixedSidePlaceHolderLoadIndicator,
this.scrollPhysics,
this.horizontalScrollPhysics,
this.itemExtent,
this.leftIntrusion = true,
this.topIntrusion = true,
this.rightIntrusion = true,
this.bottomIntrusion = true,
}
)
/// right-to-left mode constructor
HorizontalDataTable.rtl({...same as the above})
The pull to refresh action is impletemented based on the 'pull-to-refresh' package code. Currently only part of the function is available.
HorizontalDataTable(
{
...
this.enablePullToRefresh = true,
this.refreshIndicator: const WaterDropHeader(),
this.fixedSidePlaceHolderRefreshIndicator,
this.onRefresh: _onRefresh,
this.enablePullToLoadNewData = true,
this.onLoad: _onLoad,
this.loadIndicator: const ClassicFooter(),
this.fixedSidePlaceHolderLoadIndicator,
this.htdRefreshController: _hdtRefreshController,
}
)
refreshIndicator is the header widget when pull to refresh. Supported refreshIndicator:
Basically single level header with a certain height while refreshing. For the on-top header is currently not supported. Since refreshIndicator is a Widget type field, you may customize yourself on the header, but you must set the height of the header. The detail usage you may reference to the pull-to-refresh package.
fixedSidePlaceHolderRefreshIndicator is the fixed column side part refresh indicator. This aims to synchronize the action on both side. Prefer using PlaceholderHeader.
refreshIndicatorHeight is the height of the refreshIndicator. Default is set to 60.
onRefresh is the callback from the refresh action.
loadIndicator is the header widget when pull to load. Supported refreshIndicator:
fixedSidePlaceHolderLoadIndicator is the fixed column side part load indicator. This aims to synchronize the action on both side. Prefer using PlaceholderFooter.
onLoad is the callback from the load action.
htdRefreshController is the wrapper controller for returning the refresh or load result. This is the example on how to use onRefresh and htdRefreshController.
void _onRefresh() async {
//do some network call and get the response
if(isError){
//call this when it is an error case
_hdtRefreshController.refreshFailed();
}else{
//call this when it is a success case
_hdtRefreshController.refreshCompleted();
}
},
void _onLoad() async {
//do some network call and get the response
if(isError){
//call this when it is an error case
_hdtRefreshController.loadFailed();
}else if(isNoMoreData){
//call this when it is end loading data
_hdtRefreshController.loadNoData();
}else{
//call this when it is a success case
_hdtRefreshController.loadCompleted();
}
},
All of this 4 params are required when enablePullToRefresh is set to true.
import 'package:flutter/material.dart';
import 'package:horizontal_data_table/horizontal_data_table.dart';
import 'data/user.dart';
class SimpleTablePage extends StatefulWidget {
const SimpleTablePage({
Key? key,
required this.user,
}) : super(key: key);
final User user;
@override
State<SimpleTablePage> createState() => _SimpleTablePageState();
}
class _SimpleTablePageState extends State<SimpleTablePage> {
@override
void initState() {
widget.user.initData(3000);
super.initState();
}
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(title: const Text('Simple Table')),
body: HorizontalDataTable(
leftHandSideColumnWidth: 100,
rightHandSideColumnWidth: 600,
isFixedHeader: true,
headerWidgets: _getTitleWidget(),
isFixedFooter: true,
footerWidgets: _getTitleWidget(),
leftSideItemBuilder: _generateFirstColumnRow,
rightSideItemBuilder: _generateRightHandSideColumnRow,
itemCount: widget.user.userInfo.length,
rowSeparatorWidget: const Divider(
color: Colors.black38,
height: 1.0,
thickness: 0.0,
),
leftHandSideColBackgroundColor: const Color(0xFFFFFFFF),
rightHandSideColBackgroundColor: const Color(0xFFFFFFFF),
itemExtent: 55,
),
);
}
List<Widget> _getTitleWidget() {
return [
_getTitleItemWidget('Name', 100),
_getTitleItemWidget('Status', 100),
_getTitleItemWidget('Phone', 200),
_getTitleItemWidget('Register', 100),
_getTitleItemWidget('Termination', 200),
];
}
Widget _getTitleItemWidget(String label, double width) {
return Container(
width: width,
height: 56,
padding: const EdgeInsets.fromLTRB(5, 0, 0, 0),
alignment: Alignment.centerLeft,
child: Text(label, style: const TextStyle(fontWeight: FontWeight.bold)),
);
}
Widget _generateFirstColumnRow(BuildContext context, int index) {
return Container(
width: 100,
height: 52,
padding: const EdgeInsets.fromLTRB(5, 0, 0, 0),
alignment: Alignment.centerLeft,
child: Text(widget.user.userInfo[index].name),
);
}
Widget _generateRightHandSideColumnRow(BuildContext context, int index) {
return Row(
children: <Widget>[
Container(
width: 100,
height: 52,
padding: const EdgeInsets.fromLTRB(5, 0, 0, 0),
alignment: Alignment.centerLeft,
child: Row(
children: <Widget>[
Icon(
widget.user.userInfo[index].status
? Icons.notifications_off
: Icons.notifications_active,
color: widget.user.userInfo[index].status
? Colors.red
: Colors.green),
Text(widget.user.userInfo[index].status ? 'Disabled' : 'Active')
],
),
),
Container(
width: 200,
height: 52,
padding: const EdgeInsets.fromLTRB(5, 0, 0, 0),
alignment: Alignment.centerLeft,
child: Text(widget.user.userInfo[index].phone),
),
Container(
width: 100,
height: 52,
padding: const EdgeInsets.fromLTRB(5, 0, 0, 0),
alignment: Alignment.centerLeft,
child: Text(widget.user.userInfo[index].registerDate),
),
Container(
width: 200,
height: 52,
padding: const EdgeInsets.fromLTRB(5, 0, 0, 0),
alignment: Alignment.centerLeft,
child: Text(widget.user.userInfo[index].terminationDate),
),
],
);
}
}
Thank you for the contribution!
Thank you for your reporting and suggestion making this package more complete!
Since many developers get in touch with this package in different places (pub.dev, GitHub, and others website recommandation), I have received your voice regarding to feature request, issue report and question via different channels.
To avoid missing of the messages, I have created the issue templates on GitHub which allow our conversations with ease, especially some discussions are complex when they need to talk with the sample code.
MIT
依赖清单 1 项
^6.0.5