Skip to content

Added boundary feature to ReorderableList.#146182

Merged
auto-submit[bot] merged 3 commits intoflutter:masterfrom
yiiim:ReorderableDragBoundary
Dec 6, 2024
Merged

Added boundary feature to ReorderableList.#146182
auto-submit[bot] merged 3 commits intoflutter:masterfrom
yiiim:ReorderableDragBoundary

Conversation

@yiiim
Copy link
Member

@yiiim yiiim commented Apr 3, 2024 •
edited
Loading

Fixes: #146112

Code sample 
import 'package:flutter/material.dart';

void main() {
  runApp(MaterialApp(
    home: Scaffold(
      body: Center(
        child: Container(
          width: 200,
          color: Colors.green,
          child: DragBoundary(
            child: CustomScrollView(
              shrinkWrap: true,
              slivers: <Widget>[
                SliverReorderableList(
                  itemBuilder: (BuildContext context, int index) {
                    return ReorderableDragStartListener(
                      key: ValueKey<int>(index),
                      index: index,
                      child: Text('$index'),
                    );
                  },
                  itemCount: 5,
                  onReorder: (int fromIndex, int toIndex) {},
                ),
              ],
            ),
          ),
        ),
      ),
    ),
  ));
}
without DragBoundary with the DragBoundary
Screen Recording 2024-04-03 at 13 01 19 Screen Recording 2024-04-03 at 13 01 19

Pre-launch Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

@github-actions github-actions bot added the framework flutter/packages/flutter repository. See also f: labels. label Apr 3, 2024
@yiiim yiiim requested a review from Piinks April 4, 2024 07:57
Piinks
Piinks reviewed Apr 17, 2024
View reviewed changes
Copy link
Contributor

@Piinks Piinks left a comment

Choose a reason for hiding this comment

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

Hi @yiiim! Thanks for your patience, and thanks for the PR!

packages/flutter/lib/src/widgets/reorderable_list.dart Outdated
/// When this widget wraps a [ReorderableList], the drag boundary of the [ReorderableList] is confined within this widget.
/// If the [dragBoundingRect] property is provided, the drag boundary is limited to the rectangle returned by [dragBoundingRect].
/// The boundary is specified in global coordinates.
class ReorderableDragBoundary extends InheritedWidget {
Copy link
Contributor

@Piinks Piinks Apr 17, 2024

Choose a reason for hiding this comment

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

This is a really neat concept! I just came across #146749 and wondered if this might be beneficial as a generic drag gesture bounding widget, not just for ReorderableList. WDYT?

packages/flutter/lib/src/widgets/reorderable_list.dart Outdated
});

/// Return the drag boundary of [ReorderableList].
final Rect Function(SliverReorderableListState reorderableListCurrentState)? dragBoundingRect;
Copy link
Contributor

@Piinks Piinks Apr 17, 2024

Choose a reason for hiding this comment

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

This could benefit from typedef-ing the function signature.

packages/flutter/lib/src/widgets/reorderable_list.dart Outdated
/// The [dragBoundingRect] needs to return a rectangle in global coordinates.
const ReorderableDragBoundary({
required super.child,
this.dragBoundingRect,
Copy link
Contributor

@Piinks Piinks Apr 17, 2024

Choose a reason for hiding this comment

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

This feels a bit difficult for users to define. Say the user wants to stick within the bounds of the Viewport, since a Viewport will expand to fill all of the available space, how does the user know what that rect is?

@Piinks Piinks added c: new feature Nothing broken; request for a new capability f: scrolling Viewports, list views, slivers, etc. labels Apr 17, 2024
@yiiim yiiim mentioned this pull request Apr 29, 2024
Merged
9 tasks
@yiiim
Copy link
Member Author

yiiim commented Apr 29, 2024 •
edited
Loading

I implemented a generic drag gesture boundary here: #147521. This PR needs to be reimplemented after it.

@goderbauer
Copy link
Member

goderbauer commented Jul 2, 2024

(triage): We are still waiting on #147521 before we can make progress here.

@chunhtai chunhtai marked this pull request as draft July 30, 2024 22:08
@chunhtai
Copy link
Contributor

chunhtai commented Jul 30, 2024

(triage) converting to draft for now until the other pr is merged. Feel free to convert back once this is ready for review

@chunhtai
Copy link
Contributor

chunhtai commented Oct 1, 2024

(triage) still waiting for the other pr to merge

auto-submit bot pushed a commit that referenced this pull request Oct 30, 2024
@yiiim
Add boundary feature to the drag gesture. (#147521)
c051b69 
Inspired by the review on #146182.

This PR adds boundary feature to the drag gestures, including `MultiDragGestureRecognizer` and `DragGestureRecognizer`. The `GestureDetector` widget will also benefit from this.
@yiiim yiiim force-pushed the ReorderableDragBoundary branch from 22bfa28 to ce14b02 Compare November 9, 2024 07:35
@github-actions github-actions bot removed the f: scrolling Viewports, list views, slivers, etc. label Nov 9, 2024
@yiiim yiiim force-pushed the ReorderableDragBoundary branch from ce14b02 to 1ee40b3 Compare November 9, 2024 08:06
@github-actions github-actions bot added the f: material design flutter/packages/flutter/material repository. label Nov 9, 2024
@yiiim yiiim changed the title New Widget: ReorderableDragBoundary, used to define the drag boundaries of ReorderableList. Added boundary feature to ReorderableList. Nov 9, 2024
@yiiim yiiim marked this pull request as ready for review November 9, 2024 08:40
@yiiim yiiim requested a review from Piinks November 9, 2024 08:40
@Piinks Piinks requested review from Renzo-Olivares and dkwingsmt and removed request for Piinks November 13, 2024 23:15
Renzo-Olivares
Renzo-Olivares reviewed Nov 26, 2024
View reviewed changes
packages/flutter/lib/src/widgets/reorderable_list.dart Outdated
dragOffset = itemRenderBox.globalToLocal(initialPosition);
itemSize = item.context.size!;
_rawDragPosition = initialPosition;
boundary = listState.widget.dragBoundaryProvider?.call(listState.context);
Copy link
Contributor

@Renzo-Olivares Renzo-Olivares Nov 26, 2024

Choose a reason for hiding this comment

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

Have you considered having ReorderableList inherit the drag boundary through forRectMaybeOf by default instead of passing it down as a parameter? Or maybe it should do both, inherit by default, and have a parameter that overrides the default inherited provider.

Copy link
Contributor

@Renzo-Olivares Renzo-Olivares Nov 26, 2024

Choose a reason for hiding this comment

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

I'm also curious if there is any native behavior we have to compare to on other platforms (if a similar component exists).

Copy link
Member Author

@yiiim yiiim Nov 27, 2024

Choose a reason for hiding this comment

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

Modified to default to using DragBoundary.forRectMaybeOf.

dkwingsmt
dkwingsmt approved these changes Dec 2, 2024
View reviewed changes
Copy link
Contributor

@dkwingsmt dkwingsmt left a comment

Choose a reason for hiding this comment

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

LGTM

Renzo-Olivares
Renzo-Olivares approved these changes Dec 5, 2024
View reviewed changes
Copy link
Contributor

@Renzo-Olivares Renzo-Olivares left a comment

Choose a reason for hiding this comment

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

LGTM, thank you for the contribution!

@yiiim yiiim added the autosubmit Merge PR when tree becomes green via auto submit App label Dec 6, 2024
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Dec 8, 2024
@engine-flutter-autoroll
48c6d07 Added boundary feature to ReorderableList. (flutter/flutter#1…
9420fc5 
…46182)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Dec 9, 2024
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Dec 9, 2024
@engine-flutter-autoroll
48c6d07 Added boundary feature to ReorderableList. (flutter/flutter#1…
b675ebc 
…46182)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Dec 9, 2024
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Dec 9, 2024
@engine-flutter-autoroll
48c6d07 Added boundary feature to ReorderableList. (flutter/flutter#1…
be99fc2 
…46182)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Dec 9, 2024
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Dec 9, 2024
@engine-flutter-autoroll
48c6d07 Added boundary feature to ReorderableList. (flutter/flutter#1…
82ec215 
…46182)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Dec 9, 2024
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Dec 9, 2024
@engine-flutter-autoroll
48c6d07 Added boundary feature to ReorderableList. (flutter/flutter#1…
7eef59c 
…46182)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Dec 10, 2024
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Dec 10, 2024
@engine-flutter-autoroll
48c6d07 Added boundary feature to ReorderableList. (flutter/flutter#1…
0095768 
…46182)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Dec 10, 2024
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Dec 10, 2024
@engine-flutter-autoroll
48c6d07 Added boundary feature to ReorderableList. (flutter/flutter#1…
5350bf7 
…46182)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Dec 10, 2024
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Dec 10, 2024
@engine-flutter-autoroll
48c6d07 Added boundary feature to ReorderableList. (flutter/flutter#1…
03fab3b 
…46182)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Dec 10, 2024
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Dec 10, 2024
@engine-flutter-autoroll
48c6d07 Added boundary feature to ReorderableList. (flutter/flutter#1…
8295dd9 
…46182)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Dec 10, 2024
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Dec 10, 2024
@engine-flutter-autoroll
48c6d07 Added boundary feature to ReorderableList. (flutter/flutter#1…
c66a985 
…46182)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Dec 10, 2024
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Dec 10, 2024
@engine-flutter-autoroll
48c6d07 Added boundary feature to ReorderableList. (flutter/flutter#1…
cba972c 
…46182)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Dec 11, 2024
@engine-flutter-autoroll
48c6d07 Added boundary feature to ReorderableList. (flutter/flutter#1…
638a890 
…46182)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Dec 11, 2024
@engine-flutter-autoroll
48c6d07 Added boundary feature to ReorderableList. (flutter/flutter#1…
3e130e1 
…46182)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Dec 11, 2024
@engine-flutter-autoroll
48c6d07 Added boundary feature to ReorderableList. (flutter/flutter#1…
5b84ab5 
…46182)
@reidbaker reidbaker mentioned this pull request Dec 13, 2024
Closed
11 tasks
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 12, 2025
@engine-flutter-autoroll
48c6d07 Added boundary feature to ReorderableList. (flutter/flutter#1…
7501982 
…46182)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 13, 2025
@engine-flutter-autoroll
48c6d07 Added boundary feature to ReorderableList. (flutter/flutter#1…
6e21441 
…46182)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 13, 2025
@engine-flutter-autoroll
48c6d07 Added boundary feature to ReorderableList. (flutter/flutter#1…
6c2bc1c 
…46182)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 6, 2025
@engine-flutter-autoroll
48c6d07 Added boundary feature to ReorderableList. (flutter/flutter#1…
cce8f77 
…46182)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 7, 2025
@engine-flutter-autoroll
48c6d07 Added boundary feature to ReorderableList. (flutter/flutter#1…
a015245 
…46182)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Piinks Piinks Piinks left review comments

@Renzo-Olivares Renzo-Olivares Renzo-Olivares approved these changes

@dkwingsmt dkwingsmt dkwingsmt approved these changes

Assignees

No one assigned

Labels

c: new feature Nothing broken; request for a new capability f: material design flutter/packages/flutter/material repository. framework flutter/packages/flutter repository. See also f: labels.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Proposal to set boundary for the ReorderableListView when dragging item

6 participants

@yiiim @goderbauer @chunhtai @Renzo-Olivares @dkwingsmt @Piinks