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.

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

Conversation

Tamilarasan-Paranthaman
Copy link
Contributor

Description

  • Added UG for individual swiping and infinity height and width features in data grid.

@SyncfusionBuild
Copy link
Contributor

Build Status: INPROGRESS 🔃
Build Location: FLUT-5958-datagrid-vol4-ug

@SyncfusionBuild
Copy link
Contributor

CI Status: FAILURE ❌
Source Compilation: SUCCESS ✅
Failure Reason: CI Failure with violation
Build Location: FLUT-5958-datagrid-vol4-ug
Technical Error(s): 0
Spelling Error(s): 0
Image Alt Text Error(s): 0
Image Size Error(s): 1
Image Name Error(s): 0
FT Layout Syntax Error(s): 0
Front matter Error(s): 0
File Path Error(s): 0

@SyncfusionBuild
Copy link
Contributor

Build Status: INPROGRESS 🔃
Build Location: FLUT-5958-datagrid-vol4-ug

@SyncfusionBuild
Copy link
Contributor

CI Status: SUCCESS ✅
Source Compilation: SUCCESS ✅
Build Location: FLUT-5958-datagrid-vol4-ug
Technical Error(s): 0
Spelling Error(s): 0
Image Alt Text Error(s): 0
Image Size Error(s): 0
Image Name Error(s): 0
FT Layout Syntax Error(s): 0
Front matter Error(s): 0
File Path Error(s): 0

Copy link
Collaborator

@NeelakandanKannan NeelakandanKannan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have added my concerns as comments.

@@ -685,5 +685,75 @@ class _EmployeeDataSource extends DataGridSource {
{% endhighlight %}
{% endtabs %}

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

The `SfDataGrid` provides support to set the height and width of `DataGrid` based on rows and columns available by setting the [shrinkWrapRows] and [shrinkWrapColumns] as `true`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By default, the DataGrid sets its height or width as 300 if its height or width is infinity. Users can sets the height or width based on the number of rows or columns available in DataGrid by using the shrinkWrapRows or shrinkWrapColumns property respectively.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Modified


The `SfDataGrid` provides support to set the height and width of `DataGrid` based on rows and columns available by setting the [shrinkWrapRows] and [shrinkWrapColumns] as `true`.

* [shrinkWrapRows]: Whether the extent of the vertical scroll view should be determined by the number of rows available.By default, if the DataGrid’s parent height is infinity, height is set as 300. If `shrinkWrapRows` property is true, the height is expanding to view all the rows available in DataGrid.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not needed. Remove this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed


* [shrinkWrapRows]: Whether the extent of the vertical scroll view should be determined by the number of rows available.By default, if the DataGrid’s parent height is infinity, height is set as 300. If `shrinkWrapRows` property is true, the height is expanding to view all the rows available in DataGrid.

* [shrinkWrapColumns]: Whether the extent of the horizontal scroll view should be determined by the number of columns available.By default, if the DataGrid’s parent width is infinity, width is set as 300. If `shrinkWrapColumns` property is true, the width is expanding to view all the columns available in DataGrid.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not needed. Remove this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed

## Set different swipe offset for right and left swiping

You can set the different swipe offset based on swipe direction by using the `setSwipeMaxOffset` method in `onSwipeStart` callback.The below example shows how to set individual swipe offset based on swipe direction when swiping a data row from `startToEnd` or `endToStart`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Modified

@SyncfusionBuild
Copy link
Contributor

Build Status: INPROGRESS 🔃
Build Location: FLUT-5958-datagrid-vol4-ug

@SyncfusionBuild
Copy link
Contributor

CI Status: FAILURE ❌
Source Compilation: SUCCESS ✅
Failure Reason: CI Failure with violation
Build Location: FLUT-5958-datagrid-vol4-ug
Technical Error(s): 0
Spelling Error(s): 0
Image Alt Text Error(s): 0
Image Size Error(s): 0
Image Name Error(s): 0
FT Layout Syntax Error(s): 0
Front matter Error(s): 15
File Path Error(s): 0

@Tamilarasan-Paranthaman
Copy link
Contributor Author

rebuild

@SyncfusionBuild
Copy link
Contributor

Build Status: INPROGRESS 🔃
Build Location: FLUT-5958-datagrid-vol4-ug

@SyncfusionBuild
Copy link
Contributor

CI Status: SUCCESS ✅
Source Compilation: SUCCESS ✅
Build Location: FLUT-5958-datagrid-vol4-ug
Technical Error(s): 0
Spelling Error(s): 0
Image Alt Text Error(s): 0
Image Size Error(s): 0
Image Name Error(s): 0
FT Layout Syntax Error(s): 0
Front matter Error(s): 0
File Path Error(s): 0

@SyncfusionBuild
Copy link
Contributor

Build Status: INPROGRESS 🔃
Build Location: FLUT-5958-datagrid-vol4-ug

@SyncfusionBuild
Copy link
Contributor

CI Status: SUCCESS ✅
Source Compilation: SUCCESS ✅
Build Location: FLUT-5958-datagrid-vol4-ug
Technical Error(s): 0
Spelling Error(s): 0
Image Alt Text Error(s): 0
Image Size Error(s): 0
Image Name Error(s): 0
FT Layout Syntax Error(s): 0
Front matter Error(s): 0
File Path Error(s): 0

…lutter-docs into FLUT-5958-datagrid-vol4-ug

# Conflicts:
#	Flutter/datagrid/scrolling.md
@SyncfusionBuild
Copy link
Contributor

Build Status: INPROGRESS 🔃
Build Location: FLUT-5958-datagrid-vol4-ug

@SyncfusionBuild
Copy link
Contributor

CI Status: SUCCESS ✅
Source Compilation: SUCCESS ✅
Build Location: FLUT-5958-datagrid-vol4-ug
Technical Error(s): 0
Spelling Error(s): 0
Image Alt Text Error(s): 0
Image Size Error(s): 0
Image Name Error(s): 0
FT Layout Syntax Error(s): 0
Front matter Error(s): 0
File Path Error(s): 0

Copy link
Collaborator

@NeelakandanKannan NeelakandanKannan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes are fine.

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

By default, the DataGrid sets its height or width as 300 if its height or width is infinity. Users can sets the height or width based on the number of rows or columns available in DataGrid by using the `shrinkWrapRows` or `shrinkWrapColumns` property respectively.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By default, the DataGrid sets it to 300, if the height or width of the DataGrid is infinity. 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.

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

## Set different swipe offset for right and left swiping
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Set different swipe offsets for right and left swiping

## Set different swipe offset for right and left swiping

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@SyncfusionBuild
Copy link
Contributor

Build Status: INPROGRESS 🔃
Build Location: FLUT-5958-datagrid-vol4-ug

@SyncfusionBuild
Copy link
Contributor

CI Status: SUCCESS ✅
Source Compilation: SUCCESS ✅
Build Location: FLUT-5958-datagrid-vol4-ug
Technical Error(s): 0
Spelling Error(s): 0
Image Alt Text Error(s): 0
Image Size Error(s): 0
Image Name Error(s): 0
FT Layout Syntax Error(s): 0
Front matter Error(s): 0
File Path Error(s): 0

@SyncfusionBuild
Copy link
Contributor

Build Status: INPROGRESS 🔃
Build Location: FLUT-5958-datagrid-vol4-ug

@SyncfusionBuild
Copy link
Contributor

CI Status: SUCCESS ✅
Source Compilation: SUCCESS ✅
Build Location: FLUT-5958-datagrid-vol4-ug
Technical Error(s): 0
Spelling Error(s): 0
Image Alt Text Error(s): 0
Image Size Error(s): 0
Image Name Error(s): 0
FT Layout Syntax Error(s): 0
Front matter Error(s): 0
File Path Error(s): 0

@NeelakandanKannan NeelakandanKannan merged commit 8078854 into development Dec 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants