Skip to content

FLUT-5958- [Feature] Prepare the UG documentation of the individual swiping and infinity height and width features in DataGrid #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Dec 14, 2021
Merged

FLUT-5958- [Feature] Prepare the UG documentation of the individual swiping and infinity height and width features in DataGrid #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1fb3abb
FLUT-5958-[feature][flutter]: Added flutter datagrid volume 4 release…
Tamilarasan-Paranthaman Dec 10, 2021
20aae42
FLUT-5958-[feature][flutter]: Added UG GIF file.
Tamilarasan-Paranthaman Dec 10, 2021
0c0310a
FLUT-5958-[feature][flutter]: Reduced GIF size.
Tamilarasan-Paranthaman Dec 10, 2021
d198c22
FLUT-5958-[feature][flutter]: Modified the review corrections
Tamilarasan-Paranthaman Dec 14, 2021
98d87bc
FLUT-5958-[feature][flutter]: Modified the review correction.
Tamilarasan-Paranthaman Dec 14, 2021
0ff20d2
Merge branch 'development' of https://github.com/syncfusion-content/f…
Tamilarasan-Paranthaman Dec 14, 2021
145c608
FLUT-5958-[feature][flutter]: Modified content review corrections.
Tamilarasan-Paranthaman Dec 14, 2021
bbdfe56
FLUT-5958-[feature][flutter]: Modified the content correction.
Tamilarasan-Paranthaman Dec 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added Flutter/datagrid/images/swiping/flutter-datagrid-individual-swiping.gif
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
71 changes: 70 additions & 1 deletion Flutter/datagrid/scrolling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -752,4 +752,73 @@ The `rowsCacheExtent` property will create the additional rows internally with t
{% endhighlight %}
{% endtabs %}

![Flutter DataTable shows increase row cache extent](images/scrolling/flutter-datagrid-increase-row-cache-extent.gif)
![Flutter DataTable shows increase row cache extent](images/scrolling/flutter-datagrid-increase-row-cache-extent.gif)

## Set height and width of DataGrid based on rows and columns available

If the height or width of the DataGrid is infinity, then DataGrid sets its height or width to 300 by default. Users can set the height or width based on the number of rows or columns available in DataGrid by using the `shrinkWrapRows` or `shrinkWrapColumns` property, respectively.

>**NOTE**
Shrink wrapping is significantly more expensive than setting the height and width manually.

{% tabs %}
{% highlight Dart %}

import 'package:syncfusion_flutter_datagrid/datagrid.dart';

late EmployeeDataSource _employeeDataSource;

@override
Widget build(BuildContext context) {
return LayoutBuilder(builder: (context, constraints) {
return SingleChildScrollView(
child: SfDataGrid(
shrinkWrapColumns: true,
shrinkWrapRows: true,
source: _employeeDataSource,
columns: <GridColumn>[
GridColumn(
columnName: 'id',
label: Container(
padding: EdgeInsets.symmetric(horizontal: 16.0),
alignment: Alignment.centerRight,
child: Text(
'ID',
overflow: TextOverflow.ellipsis,
))),
GridColumn(
columnName: 'name',
label: Container(
padding: EdgeInsets.symmetric(horizontal: 16.0),
alignment: Alignment.centerLeft,
child: Text(
'Name',
overflow: TextOverflow.ellipsis,
))),
GridColumn(
columnName: 'designation',
label: Container(
padding: EdgeInsets.symmetric(horizontal: 16.0),
alignment: Alignment.centerLeft,
child: Text(
'Designation',
overflow: TextOverflow.ellipsis,
))),
GridColumn(
columnName: 'salary',
label: Container(
padding: EdgeInsets.symmetric(horizontal: 16.0),
alignment: Alignment.centerRight,
child: Text(
'Salary',
overflow: TextOverflow.ellipsis,
))),
],
),
);
});
}

{% endhighlight %}
{% endtabs %}

108 changes: 107 additions & 1 deletion Flutter/datagrid/swiping.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,4 +260,110 @@ Widget build(BuildContext context) {
{% endhighlight %}
{% endtabs %}

![flutter datagrid shows customized swiping delete functionality](images/swiping/flutter-datagrid-customized-swiping-delete-funtionality.gif)
![flutter datagrid shows customized swiping delete functionality](images/swiping/flutter-datagrid-customized-swiping-delete-funtionality.gif)

## Set different swipe offsets for right and left swiping

You can set the different swipe offsets based on swipe direction by using the `onSwipeStart` callback and passing the required swipe offset to the `setSwipeMaxOffset` method from the `onSwipeStart` callback's argument.

{% tabs %}
{% highlight Dart %}

import 'package:syncfusion_flutter_datagrid/datagrid.dart';

late EmployeeDataSource employeeDataSource;

@override
Widget build(BuildContext context) {
return LayoutBuilder(builder: (context, constraints) {
return SfDataGrid(
allowSwiping: true,
source: employeeDataSource,
onSwipeStart: (details) {
if (details.swipeDirection == DataGridRowSwipeDirection.startToEnd) {
details.setSwipeMaxOffset(200);
} else if (details.swipeDirection == DataGridRowSwipeDirection.endToStart) {
details.setSwipeMaxOffset(100);
}
return true;
},
startSwipeActionsBuilder:
(BuildContext context, DataGridRow row, int rowIndex) {
return GestureDetector(
onTap: () {
employeeDataSource.dataGridRow.insert(
rowIndex,
DataGridRow(cells: [
DataGridCell(value: 1011, columnName: 'id'),
DataGridCell(value: 'Tom Bass', columnName: 'name'),
DataGridCell(
value: 'Developer', columnName: 'designation'),
DataGridCell(value: 20000, columnName: 'salary')
]));
employeeDataSource.updateDataGridSource();
},
child: Container(
color: Colors.greenAccent,
child: Center(
child: Icon(Icons.add),
)));
},
endSwipeActionsBuilder:
(BuildContext context, DataGridRow row, int rowIndex) {
return GestureDetector(
onTap: () {
employeeDataSource.dataGridRow.removeAt(rowIndex);
employeeDataSource.updateDataGridSource();
},
child: Container(
color: Colors.redAccent,
child: Center(
child: Icon(Icons.delete),
)));
},
columns: <GridColumn>[
GridColumn(
columnName: 'id',
label: Container(
padding: EdgeInsets.symmetric(horizontal: 16.0),
alignment: Alignment.centerRight,
child: Text(
'ID',
overflow: TextOverflow.ellipsis,
))),
GridColumn(
columnName: 'name',
label: Container(
padding: EdgeInsets.symmetric(horizontal: 16.0),
alignment: Alignment.centerLeft,
child: Text(
'Name',
overflow: TextOverflow.ellipsis,
))),
GridColumn(
columnName: 'designation',
label: Container(
padding: EdgeInsets.symmetric(horizontal: 16.0),
alignment: Alignment.centerLeft,
child: Text(
'Designation',
overflow: TextOverflow.ellipsis,
))),
GridColumn(
columnName: 'salary',
label: Container(
padding: EdgeInsets.symmetric(horizontal: 16.0),
alignment: Alignment.centerRight,
child: Text(
'Salary',
overflow: TextOverflow.ellipsis,
))),
],
);
});
}

{% endhighlight %}
{% endtabs %}

![flutter datagrid shows swiping a row in both directions with different swiping offset](images/swiping/flutter-datagrid-individual-swiping.gif)