data_table_2 2.1.0
data_table_2: ^2.1.0 copied to clipboard
In-place replacement for Flutter's DataTable and PaginatedDataTable with fixed/sticky header and few extra features
In-place substitute for Flutter's stock DataTable and PaginatedDataTable widgets with fixed/sticky header/top row (footer/paginator for PaginatedDataTable) and a few extra features. DataTable2 and PaginatedDataTable2 widgets are based on the sources of Flutter's originals, mimic the API and provide seamless integration.
If you've been using (or considered using) standard Flutter's widgets for displaying tables/data grids and missed the sticky headers (or vertical border, 'no rows' placeholder etc.) - you've come to the right place. No need to learn yet another API of a new control, just stick to well described DataTable and PaginatedDataTable.
LIVE DEMO #
- please check the example folder which recreates the Flutter Gallery's Data Table sample (with PgaintedDataTable and DataSource) as well as has a few more samples. There's also a DataGrid Sample in separate repo.
Extra Features #
- Sticky headers and paginator (when using
PabinatedDataTable2) - Vertiacally scrollable main area (with data rows)
autoRowsToHeightproperty on PaginatedDataTable2 allows to auto calculate page size depending on how much rows fit the height and makes vertical scrolling unnecessary
- All columns are fixed width, table automatically stretches horizontaly, individual column's width is determined as (Width)/(Number of Columns)
- Should you want to adjust sizes of columns, you can replace
DataColumndefinitions withDataColumn2(which is a decendant of DataColumn). The class providessizeproperty which can be set to one of 3 relative sizes (S, M and L) - Width ratios between Small and Medium, Large and Medium columns are defined by
smRatioandlmRatioparams - You can limit the minimal width of the control and scroll it horizontaly if the viewport is narrower (by setting
minWidthproperty) which is useful in portrait orientations with multiple columns not fitting the screen - You can add bottom margin (by setting
bottomMarginproperty) to allow slight overscroll - Fixed width columns are faster than default implementation of DataTable which does 2 passes to determine contents size and justify column widths
- Should you want to adjust sizes of columns, you can replace
- Data rows are wrapped with
FlexibleandSingleScrollViewwidgets to allow widget fill parent container and be scrollable- Vertical scroller is exposed via table's
scrollControllerproperty. See example 'DataTable2 - Scroll-up' which shows 'up' button when scrolling down and allows to jump to the top of the table PaginatedDataTable2.fitproperty controls whether the paginator sticks to the bottom and leaves a gap to data rows above
- Vertical scroller is exposed via table's
- There's
DataRow2alternative to stockDataRowwhich provides row level tap events (including right clicks) emptyproperty which allows defining a placeholder widget to be displayed when data source is emptyborderallows drawing inner and outer vertical and horizontal borders (e.g. outlining individual cells) - stock widgets only allow drawing horizontal row splitters
Usage #
-
Add reference to pubspec.yaml.
-
Import:
import 'package:data_table_2/data_table_2.dart';
- Code:
import 'package:data_table_2/data_table_2.dart';
import 'package:flutter/material.dart';
import 'package:flutter/rendering.dart';
/// Example without datasource
class DataTable2SimpleDemo extends StatelessWidget {
const DataTable2SimpleDemo();
@override
Widget build(BuildContext context) {
return Padding(
padding: const EdgeInsets.all(16),
child: DataTable2(
columnSpacing: 12,
horizontalMargin: 12,
minWidth: 600,
columns: [
DataColumn2(
label: Text('Column A'),
size: ColumnSize.L,
),
DataColumn(
label: Text('Column B'),
),
DataColumn(
label: Text('Column C'),
),
DataColumn(
label: Text('Column D'),
),
DataColumn(
label: Text('Column NUMBERS'),
numeric: true,
),
],
rows: List<DataRow>.generate(
100,
(index) => DataRow(cells: [
DataCell(Text('A' * (10 - index % 10))),
DataCell(Text('B' * (10 - (index + 5) % 10))),
DataCell(Text('C' * (15 - (index + 5) % 10))),
DataCell(Text('D' * (15 - (index + 10) % 10))),
DataCell(Text(((index + 0.1) * 25.4).toString()))
]))),
);
}
}
If you're already using the standard widgets you can reference the package and add '2' to the names of stock widgets (making them DataTable2 or PaginatedDataTable2) and that is it.