bottom_sheet.dart
15.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
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
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
// Copyright 2014 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
import 'dart:async';
import 'package:flutter/gestures.dart';
import 'package:flutter/material.dart';
import 'package:modal_bottom_sheet/src/utils/scroll_to_top_status_bar.dart';
import 'package:modal_bottom_sheet/src/utils/bottom_sheet_suspended_curve.dart';
const Curve _decelerateEasing = Cubic(0.0, 0.0, 0.2, 1.0);
const Duration _bottomSheetDuration = Duration(milliseconds: 400);
const double _minFlingVelocity = 500.0;
const double _closeProgressThreshold = 0.6;
const double _willPopThreshold = 0.8;
typedef WidgetWithChildBuilder = Widget Function(
BuildContext context, Animation<double> animation, Widget child);
/// A custom bottom sheet.
///
/// The [ModalBottomSheet] widget itself is rarely used directly. Instead, prefer to
/// create a modal bottom sheet with [showMaterialModalBottomSheet].
///
/// See also:
///
/// * [showMaterialModalBottomSheet] which can be used to display a modal bottom
/// sheet with Material appareance.
/// * [showCupertinoModalBottomSheet] which can be used to display a modal bottom
/// sheet with Cupertino appareance.
class ModalBottomSheet extends StatefulWidget {
/// Creates a bottom sheet.
const ModalBottomSheet({
super.key,
required this.animationController,
this.animationCurve,
this.enableDrag = true,
this.containerBuilder,
this.bounce = true,
this.shouldClose,
required this.scrollController,
required this.expanded,
required this.onClosing,
required this.child,
this.minFlingVelocity = _minFlingVelocity,
double? closeProgressThreshold,
this.willPopThreshold = _willPopThreshold,
}) : closeProgressThreshold =
closeProgressThreshold ?? _closeProgressThreshold;
/// The closeProgressThreshold parameter
/// specifies when the bottom sheet will be dismissed when user drags it.
final double closeProgressThreshold;
/// The animation controller that controls the bottom sheet's entrance and
/// exit animations.
///
/// The BottomSheet widget will manipulate the position of this animation, it
/// is not just a passive observer.
final AnimationController animationController;
/// The curve used by the animation showing and dismissing the bottom sheet.
///
/// If no curve is provided it falls back to `decelerateEasing`.
final Curve? animationCurve;
/// Allows the bottom sheet to go beyond the top bound of the content,
/// but then bounce the content back to the edge of
/// the top bound.
final bool bounce;
// Force the widget to fill the maximum size of the viewport
// or if false it will fit to the content of the widget
final bool expanded;
final WidgetWithChildBuilder? containerBuilder;
/// Called when the bottom sheet begins to close.
///
/// A bottom sheet might be prevented from closing (e.g., by user
/// interaction) even after this callback is called. For this reason, this
/// callback might be call multiple times for a given bottom sheet.
final Function() onClosing;
// If shouldClose is null is ignored.
// If returns true => The dialog closes
// If returns false => The dialog cancels close
// Notice that if shouldClose is not null, the dialog will go back to the
// previous position until the function is solved
final Future<bool> Function()? shouldClose;
/// A builder for the contents of the sheet.
///
final Widget child;
/// If true, the bottom sheet can be dragged up and down and dismissed by
/// swiping downwards.
///
/// Default is true.
final bool enableDrag;
final ScrollController scrollController;
/// The minFlingVelocity parameter
/// Determines how fast the sheet should be flinged before closing.
final double minFlingVelocity;
/// The willPopThreshold parameter
/// Determines how far the sheet should be flinged before closing.
final double willPopThreshold;
@override
ModalBottomSheetState createState() => ModalBottomSheetState();
/// Creates an [AnimationController] suitable for a
/// [ModalBottomSheet.animationController].
///
/// This API available as a convenience for a Material compliant bottom sheet
/// animation. If alternative animation durations are required, a different
/// animation controller could be provided.
static AnimationController createAnimationController(
TickerProvider vsync, {
Duration? duration,
}) {
return AnimationController(
duration: duration ?? _bottomSheetDuration,
debugLabel: 'BottomSheet',
vsync: vsync,
);
}
}
class ModalBottomSheetState extends State<ModalBottomSheet>
with TickerProviderStateMixin {
final GlobalKey _childKey = GlobalKey(debugLabel: 'BottomSheet child');
ScrollController get _scrollController => widget.scrollController;
late AnimationController _bounceDragController;
double? get _childHeight {
final childContext = _childKey.currentContext;
final renderBox = childContext?.findRenderObject() as RenderBox;
return renderBox.size.height;
}
bool get _dismissUnderway =>
widget.animationController.status == AnimationStatus.reverse;
// Detect if user is dragging.
// Used on NotificationListener to detect if ScrollNotifications are
// before or after the user stop dragging
bool isDragging = false;
bool get hasReachedWillPopThreshold =>
widget.animationController.value < _willPopThreshold;
bool get hasReachedCloseThreshold =>
widget.animationController.value < widget.closeProgressThreshold;
void _close() {
isDragging = false;
widget.onClosing();
}
void _cancelClose() {
widget.animationController.forward().then((value) {
// When using WillPop, animation doesn't end at 1.
// Check more in detail the problem
if (!widget.animationController.isCompleted) {
widget.animationController.value = 1;
}
});
_bounceDragController.reverse();
}
bool _isCheckingShouldClose = false;
FutureOr<bool> shouldClose() async {
if (_isCheckingShouldClose) return false;
if (widget.shouldClose == null) return false;
_isCheckingShouldClose = true;
final result = await widget.shouldClose?.call();
_isCheckingShouldClose = false;
return result ?? false;
}
ParametricCurve<double> animationCurve = Curves.linear;
void _handleDragUpdate(double primaryDelta) async {
animationCurve = Curves.linear;
assert(widget.enableDrag, 'Dragging is disabled');
if (_dismissUnderway) return;
isDragging = true;
final progress = primaryDelta / (_childHeight ?? primaryDelta);
if (widget.shouldClose != null && hasReachedWillPopThreshold) {
_cancelClose();
final canClose = await shouldClose();
if (canClose) {
_close();
return;
} else {
_cancelClose();
}
}
// Bounce top
final bounce = widget.bounce == true;
final shouldBounce = _bounceDragController.value > 0;
final isBouncing = (widget.animationController.value - progress) > 1;
if (bounce && (shouldBounce || isBouncing)) {
_bounceDragController.value -= progress * 10;
return;
}
widget.animationController.value -= progress;
}
void _handleDragEnd(double velocity) async {
assert(widget.enableDrag, 'Dragging is disabled');
animationCurve = BottomSheetSuspendedCurve(
widget.animationController.value,
curve: _defaultCurve,
);
if (_dismissUnderway || !isDragging) return;
isDragging = false;
// ignore: unawaited_futures
_bounceDragController.reverse();
Future<void> tryClose() async {
if (widget.shouldClose != null) {
_cancelClose();
bool canClose = await shouldClose();
if (canClose) {
_close();
}
} else {
_close();
}
}
// If speed is bigger than _minFlingVelocity try to close it
if (velocity > widget.minFlingVelocity) {
tryClose();
} else if (hasReachedCloseThreshold) {
if (widget.animationController.value > 0.0) {
// ignore: unawaited_futures
widget.animationController.fling(velocity: -1.0);
}
tryClose();
} else {
_cancelClose();
}
}
// As we cannot access the dragGesture detector of the scroll view
// we can not know the DragDownDetails and therefore the end velocity.
// VelocityTracker it is used to calculate the end velocity of the scroll
// when user is trying to close the modal by dragging
VelocityTracker? _velocityTracker;
DateTime? _startTime;
void _handleScrollUpdate(ScrollNotification notification) {
assert(notification.context != null);
//Check if scrollController is used
if (!_scrollController.hasClients) return;
ScrollPosition scrollPosition;
// ignore: invalid_use_of_protected_member
if (_scrollController.positions.length > 1) {
// ignore: invalid_use_of_protected_member
scrollPosition = _scrollController.positions
.firstWhere((p) => p.isScrollingNotifier.value,
// ignore: invalid_use_of_protected_member
orElse: () => _scrollController.positions.first);
} else {
scrollPosition = _scrollController.position;
}
if (scrollPosition.axis == Axis.horizontal) return;
final isScrollReversed = scrollPosition.axisDirection == AxisDirection.down;
final offset = isScrollReversed
? scrollPosition.pixels
: scrollPosition.maxScrollExtent - scrollPosition.pixels;
if (offset <= 0) {
// Clamping Scroll Physics end with a ScrollEndNotification with a DragEndDetail class
// while Bouncing Scroll Physics or other physics that Overflow don't return a drag end info
// We use the velocity from DragEndDetail in case it is available
if (notification is ScrollEndNotification) {
final dragDetails = notification.dragDetails;
if (dragDetails != null) {
_handleDragEnd(dragDetails.primaryVelocity ?? 0);
_velocityTracker = null;
_startTime = null;
return;
}
}
// Otherwise the calculate the velocity with a VelocityTracker
if (_velocityTracker == null) {
final pointerKind = defaultPointerDeviceKind(context);
_velocityTracker = VelocityTracker.withKind(pointerKind);
_startTime = DateTime.now();
}
DragUpdateDetails? dragDetails;
if (notification is ScrollUpdateNotification) {
dragDetails = notification.dragDetails;
}
if (notification is OverscrollNotification) {
dragDetails = notification.dragDetails;
}
assert(_velocityTracker != null);
assert(_startTime != null);
final startTime = _startTime!;
final velocityTracker = _velocityTracker!;
if (dragDetails != null) {
final duration = startTime.difference(DateTime.now());
velocityTracker.addPosition(duration, Offset(0, offset));
_handleDragUpdate(dragDetails.delta.dy);
} else if (isDragging) {
final velocity = velocityTracker.getVelocity().pixelsPerSecond.dy;
_velocityTracker = null;
_startTime = null;
_handleDragEnd(velocity);
}
}
}
Curve get _defaultCurve => widget.animationCurve ?? _decelerateEasing;
@override
void initState() {
animationCurve = _defaultCurve;
_bounceDragController =
AnimationController(vsync: this, duration: Duration(milliseconds: 300));
// Todo: Check if we can remove scroll Controller
super.initState();
}
@override
Widget build(BuildContext context) {
final bounceAnimation = CurvedAnimation(
parent: _bounceDragController,
curve: Curves.easeOutSine,
);
var child = widget.child;
if (widget.containerBuilder != null) {
child = widget.containerBuilder!(
context,
widget.animationController,
child,
);
}
child = AnimatedBuilder(
animation: widget.animationController,
builder: (context, Widget? child) {
assert(child != null);
final animationValue = animationCurve.transform(
widget.animationController.value,
);
final draggableChild = !widget.enableDrag
? child
: KeyedSubtree(
key: _childKey,
child: AnimatedBuilder(
animation: bounceAnimation,
builder: (context, _) => CustomSingleChildLayout(
delegate: _CustomBottomSheetLayout(bounceAnimation.value),
child: GestureDetector(
onVerticalDragUpdate: (details) {
_handleDragUpdate(details.delta.dy);
},
onVerticalDragEnd: (details) {
_handleDragEnd(details.primaryVelocity ?? 0);
},
child: NotificationListener<ScrollNotification>(
onNotification: (ScrollNotification notification) {
_handleScrollUpdate(notification);
return false;
},
child: child!,
),
),
),
),
);
return ClipRect(
child: CustomSingleChildLayout(
delegate: _ModalBottomSheetLayout(
animationValue,
widget.expanded,
),
child: draggableChild,
),
);
},
child: RepaintBoundary(child: child),
);
return ScrollToTopStatusBarHandler(
child: child,
scrollController: _scrollController,
);
}
}
class _ModalBottomSheetLayout extends SingleChildLayoutDelegate {
_ModalBottomSheetLayout(this.progress, this.expand);
final double progress;
final bool expand;
@override
BoxConstraints getConstraintsForChild(BoxConstraints constraints) {
return BoxConstraints(
minWidth: constraints.maxWidth,
maxWidth: constraints.maxWidth,
minHeight: expand ? constraints.maxHeight : 0,
maxHeight: expand ? constraints.maxHeight : constraints.minHeight,
);
}
@override
Offset getPositionForChild(Size size, Size childSize) {
return Offset(0.0, size.height - childSize.height * progress);
}
@override
bool shouldRelayout(_ModalBottomSheetLayout oldDelegate) {
return progress != oldDelegate.progress;
}
}
class _CustomBottomSheetLayout extends SingleChildLayoutDelegate {
_CustomBottomSheetLayout(this.progress);
final double progress;
double? childHeight;
@override
BoxConstraints getConstraintsForChild(BoxConstraints constraints) {
return BoxConstraints(
minWidth: constraints.maxWidth,
maxWidth: constraints.maxWidth,
minHeight: constraints.minHeight,
maxHeight: constraints.maxHeight + progress * 8,
);
}
@override
Offset getPositionForChild(Size size, Size childSize) {
childHeight ??= childSize.height;
return Offset(0.0, size.height - childSize.height);
}
@override
bool shouldRelayout(_CustomBottomSheetLayout oldDelegate) {
if (progress != oldDelegate.progress) {
childHeight = oldDelegate.childHeight;
return true;
}
return false;
}
}
// Checks the device input type as per the OS installed in it
// Mobile platforms will be default to `touch` while desktop will do to `mouse`
// Used with VelocityTracker
// https://github.com/flutter/flutter/pull/64267#issuecomment-694196304
PointerDeviceKind defaultPointerDeviceKind(BuildContext context) {
final platform = Theme.of(context).platform; // ?? defaultTargetPlatform;
switch (platform) {
case TargetPlatform.iOS:
case TargetPlatform.android:
return PointerDeviceKind.touch;
case TargetPlatform.linux:
case TargetPlatform.macOS:
case TargetPlatform.windows:
return PointerDeviceKind.mouse;
case TargetPlatform.fuchsia:
return PointerDeviceKind.unknown;
}
}