draggable_scrollable_sheet.dart 43.6 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

5 6
import 'dart:math' as math;

7
import 'package:flutter/foundation.dart';
8 9 10
import 'package:flutter/gestures.dart';

import 'basic.dart';
11
import 'binding.dart';
12
import 'framework.dart';
13
import 'inherited_notifier.dart';
14
import 'layout_builder.dart';
15
import 'notification_listener.dart';
16
import 'scroll_activity.dart';
17 18
import 'scroll_context.dart';
import 'scroll_controller.dart';
19
import 'scroll_notification.dart';
20 21 22 23
import 'scroll_physics.dart';
import 'scroll_position.dart';
import 'scroll_position_with_single_context.dart';
import 'scroll_simulation.dart';
24
import 'value_listenable_builder.dart';
25 26 27

/// The signature of a method that provides a [BuildContext] and
/// [ScrollController] for building a widget that may overflow the draggable
28
/// [Axis] of the containing [DraggableScrollableSheet].
29 30 31 32 33 34 35 36 37
///
/// Users should apply the [scrollController] to a [ScrollView] subclass, such
/// as a [SingleChildScrollView], [ListView] or [GridView], to have the whole
/// sheet be draggable.
typedef ScrollableWidgetBuilder = Widget Function(
  BuildContext context,
  ScrollController scrollController,
);

38 39 40 41 42 43 44 45 46
/// Controls a [DraggableScrollableSheet].
///
/// Draggable scrollable controllers are typically stored as member variables in
/// [State] objects and are reused in each [State.build]. Controllers can only
/// be used to control one sheet at a time. A controller can be reused with a
/// new sheet if the previous sheet has been disposed.
///
/// The controller's methods cannot be used until after the controller has been
/// passed into a [DraggableScrollableSheet] and the sheet has run initState.
47 48 49 50 51 52 53 54
///
/// A [DraggableScrollableController] is a [Listenable]. It notifies its
/// listeners whenever an attached sheet changes sizes. It does not notify its
/// listeners when a sheet is first attached or when an attached sheet's
/// parameters change without affecting the sheet's current size. It does not
/// fire when [pixels] changes without [size] changing. For example, if the
/// constraints provided to an attached sheet change.
class DraggableScrollableController extends ChangeNotifier {
55
  _DraggableScrollableSheetScrollController? _attachedController;
56
  final Set<AnimationController> _animationControllers = <AnimationController>{};
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75

  /// Get the current size (as a fraction of the parent height) of the attached sheet.
  double get size {
    _assertAttached();
    return _attachedController!.extent.currentSize;
  }

  /// Get the current pixel height of the attached sheet.
  double get pixels {
    _assertAttached();
    return _attachedController!.extent.currentPixels;
  }

  /// Convert a sheet's size (fractional value of parent container height) to pixels.
  double sizeToPixels(double size) {
    _assertAttached();
    return _attachedController!.extent.sizeToPixels(size);
  }

76 77 78 79 80 81 82 83
  /// Returns Whether any [DraggableScrollableController] objects have attached themselves to the
  /// [DraggableScrollableSheet].
  ///
  /// If this is false, then members that interact with the [ScrollPosition],
  /// such as [sizeToPixels], [size], [animateTo], and [jumpTo], must not be
  /// called.
  bool get isAttached => _attachedController != null && _attachedController!.hasClients;

84 85 86 87 88 89
  /// Convert a sheet's pixel height to size (fractional value of parent container height).
  double pixelsToSize(double pixels) {
    _assertAttached();
    return _attachedController!.extent.pixelsToSize(pixels);
  }

90 91
  /// Animates the attached sheet from its current size to the given [size], a
  /// fractional value of the parent container's height.
92 93 94 95 96 97 98 99 100 101 102 103 104
  ///
  /// Any active sheet animation is canceled. If the sheet's internal scrollable
  /// is currently animating (e.g. responding to a user fling), that animation is
  /// canceled as well.
  ///
  /// An animation will be interrupted whenever the user attempts to scroll
  /// manually, whenever another activity is started, or when the sheet hits its
  /// max or min size (e.g. if you animate to 1 but the max size is .8, the
  /// animation will stop playing when it reaches .8).
  ///
  /// The duration must not be zero. To jump to a particular value without an
  /// animation, use [jumpTo].
  ///
105 106 107
  /// The sheet will not snap after calling [animateTo] even if [DraggableScrollableSheet.snap]
  /// is true. Snapping only occurs after user drags.
  ///
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
  /// When calling [animateTo] in widget tests, `await`ing the returned
  /// [Future] may cause the test to hang and timeout. Instead, use
  /// [WidgetTester.pumpAndSettle].
  Future<void> animateTo(
    double size, {
    required Duration duration,
    required Curve curve,
  }) async {
    _assertAttached();
    assert(size >= 0 && size <= 1);
    assert(duration != Duration.zero);
    final AnimationController animationController = AnimationController.unbounded(
      vsync: _attachedController!.position.context.vsync,
      value: _attachedController!.extent.currentSize,
    );
123
    _animationControllers.add(animationController);
124 125 126
    _attachedController!.position.goIdle();
    // This disables any snapping until the next user interaction with the sheet.
    _attachedController!.extent.hasDragged = false;
127
    _attachedController!.extent.hasChanged = true;
128 129 130 131 132 133
    _attachedController!.extent.startActivity(onCanceled: () {
      // Don't stop the controller if it's already finished and may have been disposed.
      if (animationController.isAnimating) {
        animationController.stop();
      }
    });
134
    animationController.addListener(() {
135 136 137 138 139 140 141 142 143 144
      _attachedController!.extent.updateSize(
        animationController.value,
        _attachedController!.position.context.notificationContext!,
      );
      if (animationController.value > _attachedController!.extent.maxSize ||
          animationController.value < _attachedController!.extent.minSize) {
        // Animation hit the max or min size, stop animating.
        animationController.stop(canceled: false);
      }
    });
145
    await animationController.animateTo(size, duration: duration, curve: curve);
146 147 148 149 150 151 152 153 154 155 156
  }

  /// Jumps the attached sheet from its current size to the given [size], a
  /// fractional value of the parent container's height.
  ///
  /// If [size] is outside of a the attached sheet's min or max child size,
  /// [jumpTo] will jump the sheet to the nearest valid size instead.
  ///
  /// Any active sheet animation is canceled. If the sheet's inner scrollable
  /// is currently animating (e.g. responding to a user fling), that animation is
  /// canceled as well.
157 158 159
  ///
  /// The sheet will not snap after calling [jumpTo] even if [DraggableScrollableSheet.snap]
  /// is true. Snapping only occurs after user drags.
160 161 162 163 164 165 166
  void jumpTo(double size) {
    _assertAttached();
    assert(size >= 0 && size <= 1);
    // Call start activity to interrupt any other playing activities.
    _attachedController!.extent.startActivity(onCanceled: () {});
    _attachedController!.position.goIdle();
    _attachedController!.extent.hasDragged = false;
167
    _attachedController!.extent.hasChanged = true;
168 169 170 171 172 173 174 175 176 177 178
    _attachedController!.extent.updateSize(size, _attachedController!.position.context.notificationContext!);
  }

  /// Reset the attached sheet to its initial size (see: [DraggableScrollableSheet.initialChildSize]).
  void reset() {
    _assertAttached();
    _attachedController!.reset();
  }

  void _assertAttached() {
    assert(
179
      isAttached,
180 181 182 183 184 185 186 187
      'DraggableScrollableController is not attached to a sheet. A DraggableScrollableController '
        'must be used in a DraggableScrollableSheet before any of its methods are called.',
    );
  }

  void _attach(_DraggableScrollableSheetScrollController scrollController) {
    assert(_attachedController == null, 'Draggable scrollable controller is already attached to a sheet.');
    _attachedController = scrollController;
188
    _attachedController!.extent._currentSize.addListener(notifyListeners);
189
    _attachedController!.onPositionDetached = _disposeAnimationControllers;
190 191 192 193 194 195 196 197 198 199 200 201
  }

  void _onExtentReplaced(_DraggableSheetExtent previousExtent) {
    // When the extent has been replaced, the old extent is already disposed and
    // the controller will point to a new extent. We have to add our listener to
    // the new extent.
    _attachedController!.extent._currentSize.addListener(notifyListeners);
    if (previousExtent.currentSize != _attachedController!.extent.currentSize) {
      // The listener won't fire for a change in size between two extent
      // objects so we have to fire it manually here.
      notifyListeners();
    }
202 203
  }

xubaolin's avatar
xubaolin committed
204 205 206 207 208 209
  void _detach({bool disposeExtent = false}) {
    if (disposeExtent) {
      _attachedController?.extent.dispose();
    } else {
      _attachedController?.extent._currentSize.removeListener(notifyListeners);
    }
210 211
    _attachedController = null;
  }
212 213 214 215 216 217 218

  void _disposeAnimationControllers() {
    for (final AnimationController animationController in _animationControllers) {
      animationController.dispose();
    }
    _animationControllers.clear();
  }
219 220
}

221 222 223
/// A container for a [Scrollable] that responds to drag gestures by resizing
/// the scrollable until a limit is reached, and then scrolling.
///
224 225
/// {@youtube 560 315 https://www.youtube.com/watch?v=Hgw819mL_78}
///
226 227 228 229 230 231 232 233 234 235 236 237
/// This widget can be dragged along the vertical axis between its
/// [minChildSize], which defaults to `0.25` and [maxChildSize], which defaults
/// to `1.0`. These sizes are percentages of the height of the parent container.
///
/// The widget coordinates resizing and scrolling of the widget returned by
/// builder as the user drags along the horizontal axis.
///
/// The widget will initially be displayed at its initialChildSize which
/// defaults to `0.5`, meaning half the height of its parent. Dragging will work
/// between the range of minChildSize and maxChildSize (as percentages of the
/// parent container's height) as long as the builder creates a widget which
/// uses the provided [ScrollController]. If the widget created by the
238
/// [ScrollableWidgetBuilder] does not use the provided [ScrollController], the
239 240
/// sheet will remain at the initialChildSize.
///
241 242 243 244 245 246
/// By default, the widget will stay at whatever size the user drags it to. To
/// make the widget snap to specific sizes whenever they lift their finger
/// during a drag, set [snap] to `true`. The sheet will snap between
/// [minChildSize] and [maxChildSize]. Use [snapSizes] to add more sizes for
/// the sheet to snap between.
///
247 248 249 250
/// The snapping effect is only applied on user drags. Programmatically
/// manipulating the sheet size via [DraggableScrollableController.animateTo] or
/// [DraggableScrollableController.jumpTo] will ignore [snap] and [snapSizes].
///
Chris Bracken's avatar
Chris Bracken committed
251
/// By default, the widget will expand its non-occupied area to fill available
252 253 254 255
/// space in the parent. If this is not desired, e.g. because the parent wants
/// to position sheet based on the space it is taking, the [expand] property
/// may be set to false.
///
256
/// {@tool snippet}
257 258 259 260 261 262 263 264 265 266
///
/// This is a sample widget which shows a [ListView] that has 25 [ListTile]s.
/// It starts out as taking up half the body of the [Scaffold], and can be
/// dragged up to the full height of the scaffold or down to 25% of the height
/// of the scaffold. Upon reaching full height, the list contents will be
/// scrolled up or down, until they reach the top of the list again and the user
/// drags the sheet back down.
///
/// ```dart
/// class HomePage extends StatelessWidget {
267
///   const HomePage({super.key});
268
///
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
///   @override
///   Widget build(BuildContext context) {
///     return Scaffold(
///       appBar: AppBar(
///         title: const Text('DraggableScrollableSheet'),
///       ),
///       body: SizedBox.expand(
///         child: DraggableScrollableSheet(
///           builder: (BuildContext context, ScrollController scrollController) {
///             return Container(
///               color: Colors.blue[100],
///               child: ListView.builder(
///                 controller: scrollController,
///                 itemCount: 25,
///                 itemBuilder: (BuildContext context, int index) {
///                   return ListTile(title: Text('Item $index'));
///                 },
///               ),
///             );
///           },
///         ),
///       ),
///     );
///   }
/// }
/// ```
/// {@end-tool}
class DraggableScrollableSheet extends StatefulWidget {
  /// Creates a widget that can be dragged and scrolled in a single gesture.
  ///
299 300
  /// The [builder], [initialChildSize], [minChildSize], [maxChildSize] and
  /// [expand] parameters must not be null.
301
  const DraggableScrollableSheet({
302
    super.key,
303 304 305
    this.initialChildSize = 0.5,
    this.minChildSize = 0.25,
    this.maxChildSize = 1.0,
306
    this.expand = true,
307 308
    this.snap = false,
    this.snapSizes,
309
    this.snapAnimationDuration,
310
    this.controller,
311
    required this.builder,
312 313 314 315 316 317 318
  })  : assert(initialChildSize != null),
        assert(minChildSize != null),
        assert(maxChildSize != null),
        assert(minChildSize >= 0.0),
        assert(maxChildSize <= 1.0),
        assert(minChildSize <= initialChildSize),
        assert(initialChildSize <= maxChildSize),
319
        assert(snapAnimationDuration == null || snapAnimationDuration > Duration.zero),
320
        assert(expand != null),
321
        assert(builder != null);
322 323 324 325

  /// The initial fractional value of the parent container's height to use when
  /// displaying the widget.
  ///
326 327 328 329
  /// Rebuilding the sheet with a new [initialChildSize] will only move the
  /// the sheet to the new value if the sheet has not yet been dragged since it
  /// was first built or since the last call to [DraggableScrollableActuator.reset].
  ///
330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
  /// The default value is `0.5`.
  final double initialChildSize;

  /// The minimum fractional value of the parent container's height to use when
  /// displaying the widget.
  ///
  /// The default value is `0.25`.
  final double minChildSize;

  /// The maximum fractional value of the parent container's height to use when
  /// displaying the widget.
  ///
  /// The default value is `1.0`.
  final double maxChildSize;

345 346 347 348 349 350 351 352 353 354
  /// Whether the widget should expand to fill the available space in its parent
  /// or not.
  ///
  /// In most cases, this should be true. However, in the case of a parent
  /// widget that will position this one based on its desired size (such as a
  /// [Center]), this should be set to false.
  ///
  /// The default value is true.
  final bool expand;

355 356 357 358 359 360
  /// Whether the widget should snap between [snapSizes] when the user lifts
  /// their finger during a drag.
  ///
  /// If the user's finger was still moving when they lifted it, the widget will
  /// snap to the next snap size (see [snapSizes]) in the direction of the drag.
  /// If their finger was still, the widget will snap to the nearest snap size.
361
  ///
362 363 364
  /// Snapping is not applied when the sheet is programmatically moved by
  /// calling [DraggableScrollableController.animateTo] or [DraggableScrollableController.jumpTo].
  ///
365 366 367 368
  /// Rebuilding the sheet with snap newly enabled will immediately trigger a
  /// snap unless the sheet has not yet been dragged away from
  /// [initialChildSize] since first being built or since the last call to
  /// [DraggableScrollableActuator.reset].
369 370 371 372 373 374 375 376 377 378 379 380
  final bool snap;

  /// A list of target sizes that the widget should snap to.
  ///
  /// Snap sizes are fractional values of the parent container's height. They
  /// must be listed in increasing order and be between [minChildSize] and
  /// [maxChildSize].
  ///
  /// The [minChildSize] and [maxChildSize] are implicitly included in snap
  /// sizes and do not need to be specified here. For example, `snapSizes = [.5]`
  /// will result in a sheet that snaps between [minChildSize], `.5`, and
  /// [maxChildSize].
381 382 383 384 385 386 387
  ///
  /// Any modifications to the [snapSizes] list will not take effect until the
  /// `build` function containing this widget is run again.
  ///
  /// Rebuilding with a modified or new list will trigger a snap unless the
  /// sheet has not yet been dragged away from [initialChildSize] since first
  /// being built or since the last call to [DraggableScrollableActuator.reset].
388 389
  final List<double>? snapSizes;

390 391 392 393 394 395
  /// Defines a duration for the snap animations.
  ///
  /// If it's not set, then the animation duration is the distance to the snap
  /// target divided by the velocity of the widget.
  final Duration? snapAnimationDuration;

396 397 398
  /// A controller that can be used to programmatically control this sheet.
  final DraggableScrollableController? controller;

399 400 401 402 403 404
  /// The builder that creates a child to display in this widget, which will
  /// use the provided [ScrollController] to enable dragging and scrolling
  /// of the contents.
  final ScrollableWidgetBuilder builder;

  @override
405
  State<DraggableScrollableSheet> createState() => _DraggableScrollableSheetState();
406 407
}

408 409 410 411 412 413 414
/// A [Notification] related to the extent, which is the size, and scroll
/// offset, which is the position of the child list, of the
/// [DraggableScrollableSheet].
///
/// [DraggableScrollableSheet] widgets notify their ancestors when the size of
/// the sheet changes. When the extent of the sheet changes via a drag,
/// this notification bubbles up through the tree, which means a given
Chris Bracken's avatar
Chris Bracken committed
415
/// [NotificationListener] will receive notifications for all descendant
416
/// [DraggableScrollableSheet] widgets. To focus on notifications from the
417
/// nearest [DraggableScrollableSheet] descendant, check that the [depth]
418 419 420 421 422 423 424 425 426 427 428 429 430 431
/// property of the notification is zero.
///
/// When an extent notification is received by a [NotificationListener], the
/// listener will already have completed build and layout, and it is therefore
/// too late for that widget to call [State.setState]. Any attempt to adjust the
/// build or layout based on an extent notification would result in a layout
/// that lagged one frame behind, which is a poor user experience. Extent
/// notifications are used primarily to drive animations. The [Scaffold] widget
/// listens for extent notifications and responds by driving animations for the
/// [FloatingActionButton] as the bottom sheet scrolls up.
class DraggableScrollableNotification extends Notification with ViewportNotificationMixin {
  /// Creates a notification that the extent of a [DraggableScrollableSheet] has
  /// changed.
  ///
432 433
  /// All parameters are required. The [minExtent] must be >= 0. The [maxExtent]
  /// must be <= 1.0. The [extent] must be between [minExtent] and [maxExtent].
434
  DraggableScrollableNotification({
435 436 437 438 439
    required this.extent,
    required this.minExtent,
    required this.maxExtent,
    required this.initialExtent,
    required this.context,
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
  }) : assert(extent != null),
       assert(initialExtent != null),
       assert(minExtent != null),
       assert(maxExtent != null),
       assert(0.0 <= minExtent),
       assert(maxExtent <= 1.0),
       assert(minExtent <= extent),
       assert(minExtent <= initialExtent),
       assert(extent <= maxExtent),
       assert(initialExtent <= maxExtent),
       assert(context != null);

  /// The current value of the extent, between [minExtent] and [maxExtent].
  final double extent;

  /// The minimum value of [extent], which is >= 0.
  final double minExtent;

  /// The maximum value of [extent].
  final double maxExtent;

  /// The initially requested value for [extent].
  final double initialExtent;

  /// The build context of the widget that fired this notification.
  ///
  /// This can be used to find the sheet's render objects to determine the size
  /// of the viewport, for instance. A listener can only assume this context
  /// is live when it first gets the notification.
  final BuildContext context;

  @override
  void debugFillDescription(List<String> description) {
    super.debugFillDescription(description);
    description.add('minExtent: $minExtent, extent: $extent, maxExtent: $maxExtent, initialExtent: $initialExtent');
  }
}

478 479 480 481 482 483 484 485 486
/// Manages state between [_DraggableScrollableSheetState],
/// [_DraggableScrollableSheetScrollController], and
/// [_DraggableScrollableSheetScrollPosition].
///
/// The State knows the pixels available along the axis the widget wants to
/// scroll, but expects to get a fraction of those pixels to render the sheet.
///
/// The ScrollPosition knows the number of pixels a user wants to move the sheet.
///
Casey Rogers's avatar
Casey Rogers committed
487
/// The [currentSize] will never be null.
488 489 490
/// The [availablePixels] will never be null, but may be `double.infinity`.
class _DraggableSheetExtent {
  _DraggableSheetExtent({
Casey Rogers's avatar
Casey Rogers committed
491 492
    required this.minSize,
    required this.maxSize,
493 494
    required this.snap,
    required this.snapSizes,
Casey Rogers's avatar
Casey Rogers committed
495
    required this.initialSize,
496
    this.snapAnimationDuration,
Casey Rogers's avatar
Casey Rogers committed
497
    ValueNotifier<double>? currentSize,
498
    bool? hasDragged,
499
    bool? hasChanged,
Casey Rogers's avatar
Casey Rogers committed
500 501 502 503 504 505 506
  })  : assert(minSize != null),
        assert(maxSize != null),
        assert(initialSize != null),
        assert(minSize >= 0),
        assert(maxSize <= 1),
        assert(minSize <= initialSize),
        assert(initialSize <= maxSize),
507
        _currentSize = currentSize ?? ValueNotifier<double>(initialSize),
508
        availablePixels = double.infinity,
509 510
        hasDragged = hasDragged ?? false,
        hasChanged = hasChanged ?? false;
511 512

  VoidCallback? _cancelActivity;
513

Casey Rogers's avatar
Casey Rogers committed
514 515
  final double minSize;
  final double maxSize;
516 517
  final bool snap;
  final List<double> snapSizes;
518
  final Duration? snapAnimationDuration;
Casey Rogers's avatar
Casey Rogers committed
519 520
  final double initialSize;
  final ValueNotifier<double> _currentSize;
521 522
  double availablePixels;

523
  // Used to disable snapping until the user has dragged on the sheet.
524
  bool hasDragged;
525

526 527 528 529 530 531 532 533 534 535 536
  // Used to determine if the sheet should move to a new initial size when it
  // changes.
  // We need both `hasChanged` and `hasDragged` to achieve the following
  // behavior:
  //   1. The sheet should only snap following user drags (as opposed to
  //      programmatic sheet changes). See docs for `animateTo` and `jumpTo`.
  //   2. The sheet should move to a new initial child size on rebuild iff the
  //      sheet has not changed, either by drag or programmatic control. See
  //      docs for `initialChildSize`.
  bool hasChanged;

Casey Rogers's avatar
Casey Rogers committed
537 538
  bool get isAtMin => minSize >= _currentSize.value;
  bool get isAtMax => maxSize <= _currentSize.value;
539

Casey Rogers's avatar
Casey Rogers committed
540 541
  double get currentSize => _currentSize.value;
  double get currentPixels => sizeToPixels(_currentSize.value);
542

Casey Rogers's avatar
Casey Rogers committed
543
  List<double> get pixelSnapSizes => snapSizes.map(sizeToPixels).toList();
544

545 546 547 548 549 550 551 552 553 554 555
  /// Start an activity that affects the sheet and register a cancel call back
  /// that will be called if another activity starts.
  ///
  /// Note that `onCanceled` will get called even if the subsequent activity
  /// started after this one finished so `onCanceled` should be safe to call at
  /// any time.
  void startActivity({required VoidCallback onCanceled}) {
    _cancelActivity?.call();
    _cancelActivity = onCanceled;
  }

Casey Rogers's avatar
Casey Rogers committed
556
  /// The scroll position gets inputs in terms of pixels, but the size is
557
  /// expected to be expressed as a number between 0..1.
558 559 560
  ///
  /// This should only be called to respond to a user drag. To update the
  /// size in response to a programmatic call, use [updateSize] directly.
561
  void addPixelDelta(double delta, BuildContext context) {
562 563 564 565 566 567
    // Stop any playing sheet animations.
    _cancelActivity?.call();
    _cancelActivity = null;
    // The user has interacted with the sheet, set `hasDragged` to true so that
    // we'll snap if applicable.
    hasDragged = true;
568
    hasChanged = true;
569 570 571
    if (availablePixels == 0) {
      return;
    }
Casey Rogers's avatar
Casey Rogers committed
572
    updateSize(currentSize + pixelsToSize(delta), context);
573 574
  }

575 576 577 578 579
  /// Set the size to the new value. [newSize] should be a number between
  /// [minSize] and [maxSize].
  ///
  /// This can be triggered by a programmatic (e.g. controller triggered) change
  /// or a user drag.
Casey Rogers's avatar
Casey Rogers committed
580
  void updateSize(double newSize, BuildContext context) {
581
    assert(newSize != null);
582
    _currentSize.value = clampDouble(newSize, minSize, maxSize);
583
    DraggableScrollableNotification(
Casey Rogers's avatar
Casey Rogers committed
584 585 586 587
      minExtent: minSize,
      maxExtent: maxSize,
      extent: currentSize,
      initialExtent: initialSize,
588 589
      context: context,
    ).dispatch(context);
590
  }
591

Casey Rogers's avatar
Casey Rogers committed
592 593
  double pixelsToSize(double pixels) {
    return pixels / availablePixels * maxSize;
594 595
  }

596 597
  double sizeToPixels(double size) {
    return size / maxSize * availablePixels;
598
  }
599

xubaolin's avatar
xubaolin committed
600 601 602 603
  void dispose() {
    _currentSize.dispose();
  }

604
  _DraggableSheetExtent copyWith({
Casey Rogers's avatar
Casey Rogers committed
605 606
    required double minSize,
    required double maxSize,
607 608
    required bool snap,
    required List<double> snapSizes,
Casey Rogers's avatar
Casey Rogers committed
609
    required double initialSize,
610
    Duration? snapAnimationDuration,
611 612
  }) {
    return _DraggableSheetExtent(
Casey Rogers's avatar
Casey Rogers committed
613 614
      minSize: minSize,
      maxSize: maxSize,
615 616
      snap: snap,
      snapSizes: snapSizes,
617
      snapAnimationDuration: snapAnimationDuration,
Casey Rogers's avatar
Casey Rogers committed
618
      initialSize: initialSize,
619 620 621
      // Set the current size to the possibly updated initial size if the sheet
      // hasn't changed yet.
      currentSize: ValueNotifier<double>(hasChanged
622
          ? clampDouble(_currentSize.value, minSize, maxSize)
Casey Rogers's avatar
Casey Rogers committed
623
          : initialSize),
624
      hasDragged: hasDragged,
625
      hasChanged: hasChanged,
626 627
    );
  }
628 629 630
}

class _DraggableScrollableSheetState extends State<DraggableScrollableSheet> {
631 632
  late _DraggableScrollableSheetScrollController _scrollController;
  late _DraggableSheetExtent _extent;
633 634 635 636

  @override
  void initState() {
    super.initState();
637
    _extent = _DraggableSheetExtent(
Casey Rogers's avatar
Casey Rogers committed
638 639
      minSize: widget.minChildSize,
      maxSize: widget.maxChildSize,
640 641
      snap: widget.snap,
      snapSizes: _impliedSnapSizes(),
642
      snapAnimationDuration: widget.snapAnimationDuration,
Casey Rogers's avatar
Casey Rogers committed
643
      initialSize: widget.initialChildSize,
644 645
    );
    _scrollController = _DraggableScrollableSheetScrollController(extent: _extent);
646
    widget.controller?._attach(_scrollController);
647 648
  }

649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670
  List<double> _impliedSnapSizes() {
    for (int index = 0; index < (widget.snapSizes?.length ?? 0); index += 1) {
      final double snapSize = widget.snapSizes![index];
      assert(snapSize >= widget.minChildSize && snapSize <= widget.maxChildSize,
        '${_snapSizeErrorMessage(index)}\nSnap sizes must be between `minChildSize` and `maxChildSize`. ');
      assert(index == 0 || snapSize > widget.snapSizes![index - 1],
        '${_snapSizeErrorMessage(index)}\nSnap sizes must be in ascending order. ');
    }
    // Ensure the snap sizes start and end with the min and max child sizes.
    if (widget.snapSizes == null || widget.snapSizes!.isEmpty) {
      return <double>[
        widget.minChildSize,
        widget.maxChildSize,
      ];
    }
    return <double>[
      if (widget.snapSizes!.first != widget.minChildSize) widget.minChildSize,
      ...widget.snapSizes!,
      if (widget.snapSizes!.last != widget.maxChildSize) widget.maxChildSize,
    ];
  }

671 672 673
  @override
  void didUpdateWidget(covariant DraggableScrollableSheet oldWidget) {
    super.didUpdateWidget(oldWidget);
xubaolin's avatar
xubaolin committed
674 675 676 677
    if (widget.controller != oldWidget.controller) {
      oldWidget.controller?._detach();
      widget.controller?._attach(_scrollController);
    }
678
    _replaceExtent(oldWidget);
679 680
  }

681 682 683 684
  @override
  void didChangeDependencies() {
    super.didChangeDependencies();
    if (_InheritedResetNotifier.shouldReset(context)) {
685
      _scrollController.reset();
686 687 688
    }
  }

689 690
  @override
  Widget build(BuildContext context) {
691 692 693 694 695 696 697 698 699 700 701 702 703 704
    return ValueListenableBuilder<double>(
      valueListenable: _extent._currentSize,
      builder: (BuildContext context, double currentSize, Widget? child) => LayoutBuilder(
        builder: (BuildContext context, BoxConstraints constraints) {
          _extent.availablePixels = widget.maxChildSize * constraints.biggest.height;
          final Widget sheet = FractionallySizedBox(
            heightFactor: currentSize,
            alignment: Alignment.bottomCenter,
            child: child,
          );
          return widget.expand ? SizedBox.expand(child: sheet) : sheet;
        },
      ),
      child: widget.builder(context, _scrollController),
705 706 707 708 709
    );
  }

  @override
  void dispose() {
xubaolin's avatar
xubaolin committed
710
    widget.controller?._detach(disposeExtent: true);
711 712 713
    _scrollController.dispose();
    super.dispose();
  }
714

715
  void _replaceExtent(covariant DraggableScrollableSheet oldWidget) {
716
    final _DraggableSheetExtent previousExtent = _extent;
xubaolin's avatar
xubaolin committed
717
    _extent = previousExtent.copyWith(
Casey Rogers's avatar
Casey Rogers committed
718 719
      minSize: widget.minChildSize,
      maxSize: widget.maxChildSize,
720 721
      snap: widget.snap,
      snapSizes: _impliedSnapSizes(),
722
      snapAnimationDuration: widget.snapAnimationDuration,
Casey Rogers's avatar
Casey Rogers committed
723
      initialSize: widget.initialChildSize,
724 725 726 727
    );
    // Modify the existing scroll controller instead of replacing it so that
    // developers listening to the controller do not have to rebuild their listeners.
    _scrollController.extent = _extent;
728 729
    // If an external facing controller was provided, let it know that the
    // extent has been replaced.
730
    widget.controller?._onExtentReplaced(previousExtent);
xubaolin's avatar
xubaolin committed
731
    previousExtent.dispose();
732 733 734 735 736 737 738 739 740
    if (widget.snap
        && (widget.snap != oldWidget.snap || widget.snapSizes != oldWidget.snapSizes)
        && _scrollController.hasClients
    ) {
      // Trigger a snap in case snap or snapSizes has changed and there is a
      // scroll position currently attached. We put this in a post frame
      // callback so that `build` can update `_extent.availablePixels` before
      // this runs-we can't use the previous extent's available pixels as it may
      // have changed when the widget was updated.
741
      WidgetsBinding.instance.addPostFrameCallback((Duration timeStamp) {
742 743 744 745 746
        for (int index = 0; index < _scrollController.positions.length; index++) {
          final _DraggableScrollableSheetScrollPosition position =
            _scrollController.positions.elementAt(index) as _DraggableScrollableSheetScrollPosition;
          position.goBallistic(0);
        }
747 748 749 750
      });
    }
  }

751 752
  String _snapSizeErrorMessage(int invalidIndex) {
    final List<String> snapSizesWithIndicator = widget.snapSizes!.asMap().keys.map(
753
      (int index) {
754 755 756 757 758 759 760 761 762 763
        final String snapSizeString = widget.snapSizes![index].toString();
        if (index == invalidIndex) {
          return '>>> $snapSizeString <<<';
        }
        return snapSizeString;
      },
    ).toList();
    return "Invalid snapSize '${widget.snapSizes![invalidIndex]}' at index $invalidIndex of:\n"
        '  $snapSizesWithIndicator';
  }
764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781
}

/// A [ScrollController] suitable for use in a [ScrollableWidgetBuilder] created
/// by a [DraggableScrollableSheet].
///
/// If a [DraggableScrollableSheet] contains content that is exceeds the height
/// of its container, this controller will allow the sheet to both be dragged to
/// fill the container and then scroll the child content.
///
/// See also:
///
///  * [_DraggableScrollableSheetScrollPosition], which manages the positioning logic for
///    this controller.
///  * [PrimaryScrollController], which can be used to establish a
///    [_DraggableScrollableSheetScrollController] as the primary controller for
///    descendants.
class _DraggableScrollableSheetScrollController extends ScrollController {
  _DraggableScrollableSheetScrollController({
782
    required this.extent,
783
  }) : assert(extent != null);
784

785
  _DraggableSheetExtent extent;
786
  VoidCallback? onPositionDetached;
787 788 789 790 791

  @override
  _DraggableScrollableSheetScrollPosition createScrollPosition(
    ScrollPhysics physics,
    ScrollContext context,
792
    ScrollPosition? oldPosition,
793 794
  ) {
    return _DraggableScrollableSheetScrollPosition(
795
      physics: const AlwaysScrollableScrollPhysics().applyTo(physics),
796 797
      context: context,
      oldPosition: oldPosition,
798
      getExtent: () => extent,
799 800 801 802 803 804 805 806
    );
  }

  @override
  void debugFillDescription(List<String> description) {
    super.debugFillDescription(description);
    description.add('extent: $extent');
  }
807 808 809 810

  @override
  _DraggableScrollableSheetScrollPosition get position =>
      super.position as _DraggableScrollableSheetScrollPosition;
811 812 813 814

  void reset() {
    extent._cancelActivity?.call();
    extent.hasDragged = false;
815
    extent.hasChanged = false;
816 817 818 819 820 821 822 823 824 825 826 827
    // jumpTo can result in trying to replace semantics during build.
    // Just animate really fast.
    // Avoid doing it at all if the offset is already 0.0.
    if (offset != 0.0) {
      animateTo(
        0.0,
        duration: const Duration(milliseconds: 1),
        curve: Curves.linear,
      );
    }
    extent.updateSize(extent.initialSize, position.context.notificationContext!);
  }
828 829 830 831 832 833

  @override
  void detach(ScrollPosition position) {
    onPositionDetached?.call();
    super.detach(position);
  }
834 835 836 837 838 839 840 841
}

/// A scroll position that manages scroll activities for
/// [_DraggableScrollableSheetScrollController].
///
/// This class is a concrete subclass of [ScrollPosition] logic that handles a
/// single [ScrollContext], such as a [Scrollable]. An instance of this class
/// manages [ScrollActivity] instances, which changes the
Casey Rogers's avatar
Casey Rogers committed
842
/// [_DraggableSheetExtent.currentSize] or visible content offset in the
843 844 845 846 847
/// [Scrollable]'s [Viewport]
///
/// See also:
///
///  * [_DraggableScrollableSheetScrollController], which uses this as its [ScrollPosition].
848
class _DraggableScrollableSheetScrollPosition extends ScrollPositionWithSingleContext {
849
  _DraggableScrollableSheetScrollPosition({
850 851 852
    required super.physics,
    required super.context,
    super.oldPosition,
853
    required this.getExtent,
854
  });
855

856
  VoidCallback? _dragCancelCallback;
857
  final _DraggableSheetExtent Function() getExtent;
858
  final Set<AnimationController> _ballisticControllers = <AnimationController>{};
859 860
  bool get listShouldScroll => pixels > 0.0;

861 862
  _DraggableSheetExtent get extent => getExtent();

863 864 865 866 867 868 869 870 871 872 873 874 875 876 877
  @override
  void absorb(ScrollPosition other) {
    super.absorb(other);
    assert(_dragCancelCallback == null);

    if (other is! _DraggableScrollableSheetScrollPosition) {
      return;
    }

    if (other._dragCancelCallback != null) {
      _dragCancelCallback = other._dragCancelCallback;
      other._dragCancelCallback = null;
    }
  }

878 879
  @override
  void beginActivity(ScrollActivity? newActivity) {
880 881 882 883
    // Cancel the running ballistic simulations
    for (final AnimationController ballisticController in _ballisticControllers) {
      ballisticController.stop();
    }
884 885 886
    super.beginActivity(newActivity);
  }

887 888 889
  @override
  void applyUserOffset(double delta) {
    if (!listShouldScroll &&
890 891 892
        (!(extent.isAtMin || extent.isAtMax) ||
          (extent.isAtMin && delta < 0) ||
          (extent.isAtMax && delta > 0))) {
893
      extent.addPixelDelta(-delta, context.notificationContext!);
894 895 896 897 898
    } else {
      super.applyUserOffset(delta);
    }
  }

899 900 901
  bool get _isAtSnapSize {
    return extent.snapSizes.any(
      (double snapSize) {
Casey Rogers's avatar
Casey Rogers committed
902
        return (extent.currentSize - snapSize).abs() <= extent.pixelsToSize(physics.tolerance.distance);
903 904 905
      },
    );
  }
906
  bool get _shouldSnap => extent.snap && extent.hasDragged && !_isAtSnapSize;
907

908 909
  @override
  void dispose() {
910 911 912 913
    for (final AnimationController ballisticController in _ballisticControllers) {
      ballisticController.dispose();
    }
    _ballisticControllers.clear();
914 915 916
    super.dispose();
  }

917 918
  @override
  void goBallistic(double velocity) {
919 920 921
    if ((velocity == 0.0 && !_shouldSnap) ||
        (velocity < 0.0 && listShouldScroll) ||
        (velocity > 0.0 && extent.isAtMax)) {
922 923 924 925 926 927 928
      super.goBallistic(velocity);
      return;
    }
    // Scrollable expects that we will dispose of its current _dragCancelCallback
    _dragCancelCallback?.call();
    _dragCancelCallback = null;

929 930 931 932
    late final Simulation simulation;
    if (extent.snap) {
      // Snap is enabled, simulate snapping instead of clamping scroll.
      simulation = _SnappingSimulation(
933 934 935
        position: extent.currentPixels,
        initialVelocity: velocity,
        pixelSnapSize: extent.pixelSnapSizes,
936
        snapAnimationDuration: extent.snapAnimationDuration,
937 938
        tolerance: physics.tolerance,
      );
939 940 941 942 943 944 945 946 947 948
    } else {
      // The iOS bouncing simulation just isn't right here - once we delegate
      // the ballistic back to the ScrollView, it will use the right simulation.
      simulation = ClampingScrollSimulation(
        // Run the simulation in terms of pixels, not extent.
        position: extent.currentPixels,
        velocity: velocity,
        tolerance: physics.tolerance,
      );
    }
949 950

    final AnimationController ballisticController = AnimationController.unbounded(
951
      debugLabel: objectRuntimeType(this, '_DraggableScrollableSheetPosition'),
952 953
      vsync: context.vsync,
    );
954 955
    _ballisticControllers.add(ballisticController);

956
    double lastPosition = extent.currentPixels;
957
    void tick() {
958 959
      final double delta = ballisticController.value - lastPosition;
      lastPosition = ballisticController.value;
960
      extent.addPixelDelta(delta, context.notificationContext!);
961 962 963 964 965 966 967
      if ((velocity > 0 && extent.isAtMax) || (velocity < 0 && extent.isAtMin)) {
        // Make sure we pass along enough velocity to keep scrolling - otherwise
        // we just "bounce" off the top making it look like the list doesn't
        // have more to scroll.
        velocity = ballisticController.velocity + (physics.tolerance.velocity * ballisticController.velocity.sign);
        super.goBallistic(velocity);
        ballisticController.stop();
968 969
      } else if (ballisticController.isCompleted) {
        super.goBallistic(0);
970 971 972 973
      }
    }

    ballisticController
974
      ..addListener(tick)
975
      ..animateWith(simulation).whenCompleteOrCancel(
976
        () {
977 978 979 980
          if (_ballisticControllers.contains(ballisticController)) {
            _ballisticControllers.remove(ballisticController);
            ballisticController.dispose();
          }
981
        },
982 983 984 985 986 987 988 989 990 991
      );
  }

  @override
  Drag drag(DragStartDetails details, VoidCallback dragCancelCallback) {
    // Save this so we can call it later if we have to [goBallistic] on our own.
    _dragCancelCallback = dragCancelCallback;
    return super.drag(details, dragCancelCallback);
  }
}
992 993 994 995

/// A widget that can notify a descendent [DraggableScrollableSheet] that it
/// should reset its position to the initial state.
///
996
/// The [Scaffold] uses this widget to notify a persistent bottom sheet that
997 998 999
/// the user has tapped back if the sheet has started to cover more of the body
/// than when at its initial position. This is important for users of assistive
/// technology, where dragging may be difficult to communicate.
1000 1001 1002 1003 1004 1005 1006
///
/// This is just a wrapper on top of [DraggableScrollableController]. It is
/// primarily useful for controlling a sheet in a part of the widget tree that
/// the current code does not control (e.g. library code trying to affect a sheet
/// in library users' code). Generally, it's easier to control the sheet
/// directly by creating a controller and passing the controller to the sheet in
/// its constructor (see [DraggableScrollableSheet.controller]).
1007 1008 1009 1010 1011 1012
class DraggableScrollableActuator extends StatelessWidget {
  /// Creates a widget that can notify descendent [DraggableScrollableSheet]s
  /// to reset to their initial position.
  ///
  /// The [child] parameter is required.
  DraggableScrollableActuator({
1013
    super.key,
1014
    required this.child,
1015
  });
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031

  /// This child's [DraggableScrollableSheet] descendant will be reset when the
  /// [reset] method is applied to a context that includes it.
  ///
  /// Must not be null.
  final Widget child;

  final _ResetNotifier _notifier = _ResetNotifier();

  /// Notifies any descendant [DraggableScrollableSheet] that it should reset
  /// to its initial position.
  ///
  /// Returns `true` if a [DraggableScrollableActuator] is available and
  /// some [DraggableScrollableSheet] is listening for updates, `false`
  /// otherwise.
  static bool reset(BuildContext context) {
1032
    final _InheritedResetNotifier? notifier = context.dependOnInheritedWidgetOfExactType<_InheritedResetNotifier>();
1033 1034 1035 1036 1037 1038 1039 1040
    if (notifier == null) {
      return false;
    }
    return notifier._sendReset();
  }

  @override
  Widget build(BuildContext context) {
1041
    return _InheritedResetNotifier(notifier: _notifier, child: child);
1042 1043 1044
  }
}

1045
/// A [ChangeNotifier] to use with [InheritedResetNotifier] to notify
1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
/// descendants that they should reset to initial state.
class _ResetNotifier extends ChangeNotifier {
  /// Whether someone called [sendReset] or not.
  ///
  /// This flag should be reset after checking it.
  bool _wasCalled = false;

  /// Fires a reset notification to descendants.
  ///
  /// Returns false if there are no listeners.
  bool sendReset() {
    if (!hasListeners) {
      return false;
    }
    _wasCalled = true;
    notifyListeners();
    return true;
  }
}

class _InheritedResetNotifier extends InheritedNotifier<_ResetNotifier> {
  /// Creates an [InheritedNotifier] that the [DraggableScrollableSheet] will
Casey Rogers's avatar
Casey Rogers committed
1068
  /// listen to for an indication that it should reset itself back to [DraggableScrollableSheet.initialChildSize].
1069 1070 1071
  ///
  /// The [child] and [notifier] properties must not be null.
  const _InheritedResetNotifier({
1072 1073 1074
    required super.child,
    required _ResetNotifier super.notifier,
  });
1075

1076
  bool _sendReset() => notifier!.sendReset();
1077 1078 1079 1080 1081 1082

  /// Specifies whether the [DraggableScrollableSheet] should reset to its
  /// initial position.
  ///
  /// Returns true if the notifier requested a reset, false otherwise.
  static bool shouldReset(BuildContext context) {
1083
    final InheritedWidget? widget = context.dependOnInheritedWidgetOfExactType<_InheritedResetNotifier>();
1084 1085 1086 1087
    if (widget == null) {
      return false;
    }
    assert(widget is _InheritedResetNotifier);
1088
    final _InheritedResetNotifier inheritedNotifier = widget as _InheritedResetNotifier;
1089 1090
    final bool wasCalled = inheritedNotifier.notifier!._wasCalled;
    inheritedNotifier.notifier!._wasCalled = false;
1091 1092 1093
    return wasCalled;
  }
}
1094 1095 1096 1097 1098 1099

class _SnappingSimulation extends Simulation {
  _SnappingSimulation({
    required this.position,
    required double initialVelocity,
    required List<double> pixelSnapSize,
1100
    Duration? snapAnimationDuration,
1101 1102
    super.tolerance,
  }) {
1103
    _pixelSnapSize = _getSnapSize(initialVelocity, pixelSnapSize);
1104 1105 1106 1107

    if (snapAnimationDuration != null && snapAnimationDuration.inMilliseconds > 0) {
       velocity = (_pixelSnapSize - position) * 1000 / snapAnimationDuration.inMilliseconds;
    }
1108 1109
    // Check the direction of the target instead of the sign of the velocity because
    // we may snap in the opposite direction of velocity if velocity is very low.
1110
    else if (_pixelSnapSize < position) {
1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175
      velocity = math.min(-minimumSpeed, initialVelocity);
    } else {
      velocity = math.max(minimumSpeed, initialVelocity);
    }
  }

  final double position;
  late final double velocity;

  // A minimum speed to snap at. Used to ensure that the snapping animation
  // does not play too slowly.
  static const double minimumSpeed = 1600.0;

  late final double _pixelSnapSize;

  @override
  double dx(double time) {
    if (isDone(time)) {
      return 0;
    }
    return velocity;
  }

  @override
  bool isDone(double time) {
    return x(time) == _pixelSnapSize;
  }

  @override
  double x(double time) {
    final double newPosition = position + velocity * time;
    if ((velocity >= 0 && newPosition > _pixelSnapSize) ||
        (velocity < 0 && newPosition < _pixelSnapSize)) {
      // We're passed the snap size, return it instead.
      return _pixelSnapSize;
    }
    return newPosition;
  }

  // Find the two closest snap sizes to the position. If the velocity is
  // non-zero, select the size in the velocity's direction. Otherwise,
  // the nearest snap size.
  double _getSnapSize(double initialVelocity, List<double> pixelSnapSizes) {
    final int indexOfNextSize = pixelSnapSizes
        .indexWhere((double size) => size >= position);
    if (indexOfNextSize == 0) {
      return pixelSnapSizes.first;
    }
    final double nextSize = pixelSnapSizes[indexOfNextSize];
    final double previousSize = pixelSnapSizes[indexOfNextSize - 1];
    if (initialVelocity.abs() <= tolerance.velocity) {
      // If velocity is zero, snap to the nearest snap size with the minimum velocity.
      if (position - previousSize < nextSize - position) {
        return previousSize;
      } else {
        return nextSize;
      }
    }
    // Snap forward or backward depending on current velocity.
    if (initialVelocity < 0.0) {
      return pixelSnapSizes[indexOfNextSize - 1];
    }
    return pixelSnapSizes[indexOfNextSize];
  }
}