// 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 'package:flutter/gestures.dart'; import 'package:flutter/material.dart'; import 'package:flutter_test/flutter_test.dart'; void main() { testWidgets('ScrollMetricsNotification test', (WidgetTester tester) async { final events = []; Widget buildFrame(double height) { return NotificationListener( onNotification: (Notification value) { events.add(value); return false; }, child: SingleChildScrollView(child: SizedBox(height: height)), ); } await tester.pumpWidget(buildFrame(1200.0)); expect(events.length, 1); var event = events[0] as ScrollMetricsNotification; expect(event.metrics.extentBefore, 0.0); expect(event.metrics.extentInside, 600.0); expect(event.metrics.extentAfter, 600.0); expect(event.metrics.extentTotal, 1200.0); events.clear(); await tester.pumpWidget(buildFrame(1000.0)); // Change the content dimensions will trigger a new event. expect(events.length, 1); event = events[0] as ScrollMetricsNotification; expect(event.metrics.extentBefore, 0.0); expect(event.metrics.extentInside, 600.0); expect(event.metrics.extentAfter, 400.0); expect(event.metrics.extentTotal, 1000.0); events.clear(); final TestGesture gesture = await tester.startGesture(const Offset(100.0, 100.0)); await tester.pump(const Duration(seconds: 1)); await gesture.moveBy(const Offset(-10.0, -10.0)); await tester.pump(const Duration(seconds: 1)); await gesture.up(); await tester.pump(const Duration(seconds: 1)); expect(events.length, 5); // user scroll do not trigger the ScrollMetricsNotification. expect(events[0] is ScrollStartNotification, true); expect(events[1] is UserScrollNotification, true); expect(events[2] is ScrollUpdateNotification, true); expect(events[3] is ScrollEndNotification, true); expect(events[4] is UserScrollNotification, true); events.clear(); // Change the content dimensions again. await tester.pumpWidget(buildFrame(500.0)); expect(events.length, 1); event = events[0] as ScrollMetricsNotification; expect(event.metrics.extentBefore, 0.0); expect(event.metrics.extentInside, 600.0); expect(event.metrics.extentAfter, 0.0); expect(event.metrics.extentTotal, 600.0); events.clear(); // The content dimensions does not change. await tester.pumpWidget(buildFrame(500.0)); expect(events.length, 0); }); testWidgets('Scroll notification basics', (WidgetTester tester) async { late ScrollNotification notification; await tester.pumpWidget( NotificationListener( onNotification: (ScrollNotification value) { if (value is ScrollStartNotification || value is ScrollUpdateNotification || value is ScrollEndNotification) { notification = value; } return false; }, child: const SingleChildScrollView(child: SizedBox(height: 1200.0)), ), ); final TestGesture gesture = await tester.startGesture(const Offset(100.0, 100.0)); await tester.pump(const Duration(seconds: 1)); expect(notification, isA()); expect(notification.depth, equals(0)); final start = notification as ScrollStartNotification; expect(start.dragDetails, isNotNull); expect(start.dragDetails!.globalPosition, equals(const Offset(100.0, 100.0))); await gesture.moveBy(const Offset(-10.0, -10.0)); await tester.pump(const Duration(seconds: 1)); expect(notification, isA()); expect(notification.depth, equals(0)); final update = notification as ScrollUpdateNotification; expect(update.dragDetails, isNotNull); expect(update.dragDetails!.globalPosition, equals(const Offset(90.0, 90.0))); expect(update.dragDetails!.delta, equals(const Offset(0.0, -10.0))); await gesture.up(); await tester.pump(const Duration(seconds: 1)); expect(notification, isA()); expect(notification.depth, equals(0)); final end = notification as ScrollEndNotification; expect(end.dragDetails, isNotNull); expect(end.dragDetails!.velocity, equals(Velocity.zero)); }); testWidgets('Scroll notification depth', (WidgetTester tester) async { final depth0Types = []; final depth1Types = []; final depth0Values = []; final depth1Values = []; await tester.pumpWidget( NotificationListener( onNotification: (ScrollNotification value) { depth1Types.add(value.runtimeType); depth1Values.add(value.depth); return false; }, child: SingleChildScrollView( dragStartBehavior: DragStartBehavior.down, child: SizedBox( height: 1200.0, child: NotificationListener( onNotification: (ScrollNotification value) { depth0Types.add(value.runtimeType); depth0Values.add(value.depth); return false; }, child: Container( padding: const EdgeInsets.all(50.0), child: const SingleChildScrollView( dragStartBehavior: DragStartBehavior.down, child: SizedBox(height: 1200.0), ), ), ), ), ), ), ); final TestGesture gesture = await tester.startGesture(const Offset(100.0, 100.0)); await tester.pump(const Duration(seconds: 1)); await gesture.moveBy(const Offset(-10.0, -40.0)); await tester.pump(const Duration(seconds: 1)); await gesture.up(); await tester.pump(const Duration(seconds: 1)); final types = [ ScrollStartNotification, UserScrollNotification, ScrollUpdateNotification, ScrollEndNotification, UserScrollNotification, ]; expect(depth0Types, equals(types)); expect(depth1Types, equals(types)); expect(depth0Values, equals([0, 0, 0, 0, 0])); expect(depth1Values, equals([1, 1, 1, 1, 1])); }); testWidgets('ScrollNotifications bubble past Scaffold Material', (WidgetTester tester) async { final notificationTypes = []; await tester.pumpWidget( MaterialApp( home: NotificationListener( onNotification: (ScrollNotification value) { notificationTypes.add(value.runtimeType); return false; }, child: Scaffold( body: SizedBox.expand( child: SingleChildScrollView( dragStartBehavior: DragStartBehavior.down, child: SizedBox( height: 1200.0, child: Container( padding: const EdgeInsets.all(50.0), child: const SingleChildScrollView( dragStartBehavior: DragStartBehavior.down, child: SizedBox(height: 1200.0), ), ), ), ), ), ), ), ), ); final TestGesture gesture = await tester.startGesture(const Offset(100.0, 100.0)); await tester.pump(const Duration(seconds: 1)); await gesture.moveBy(const Offset(-10.0, -40.0)); await tester.pump(const Duration(seconds: 1)); await gesture.up(); await tester.pump(const Duration(seconds: 1)); final types = [ ScrollStartNotification, UserScrollNotification, ScrollUpdateNotification, ScrollEndNotification, UserScrollNotification, ]; expect(notificationTypes, equals(types)); }); testWidgets('ScrollNotificationObserver', (WidgetTester tester) async { late ScrollNotificationObserverState observer; ScrollNotification? notification; void handleNotification(ScrollNotification value) { if (value is ScrollStartNotification || value is ScrollUpdateNotification || value is ScrollEndNotification) { notification = value; } } await tester.pumpWidget( ScrollNotificationObserver( child: Builder( builder: (BuildContext context) { observer = ScrollNotificationObserver.of(context); return const SingleChildScrollView(child: SizedBox(height: 1200.0)); }, ), ), ); observer.addListener(handleNotification); TestGesture gesture = await tester.startGesture(const Offset(100.0, 100.0)); await tester.pumpAndSettle(); expect(notification, isA()); expect(notification!.depth, equals(0)); final start = notification! as ScrollStartNotification; expect(start.dragDetails, isNotNull); expect(start.dragDetails!.globalPosition, equals(const Offset(100.0, 100.0))); await gesture.moveBy(const Offset(-10.0, -10.0)); await tester.pumpAndSettle(); expect(notification, isA()); expect(notification!.depth, equals(0)); final update = notification! as ScrollUpdateNotification; expect(update.dragDetails, isNotNull); expect(update.dragDetails!.globalPosition, equals(const Offset(90.0, 90.0))); expect(update.dragDetails!.delta, equals(const Offset(0.0, -10.0))); await gesture.up(); await tester.pumpAndSettle(); expect(notification, isA()); expect(notification!.depth, equals(0)); final end = notification! as ScrollEndNotification; expect(end.dragDetails, isNotNull); expect(end.dragDetails!.velocity, equals(Velocity.zero)); observer.removeListener(handleNotification); notification = null; gesture = await tester.startGesture(const Offset(100.0, 100.0)); await tester.pumpAndSettle(); expect(notification, isNull); await gesture.moveBy(const Offset(-10.0, -10.0)); await tester.pumpAndSettle(); expect(notification, isNull); await gesture.up(); await tester.pumpAndSettle(); expect(notification, isNull); }); testWidgets('ScrollBar thumb drag triggers scroll start-update-end notifications', ( WidgetTester tester, ) async { final scrollController = ScrollController(); ScrollNotification? notification; addTearDown(scrollController.dispose); bool handleScrollNotification(ScrollNotification value) { if (value is ScrollStartNotification || value is ScrollUpdateNotification || value is ScrollEndNotification) { notification = value; } return true; } await tester.pumpWidget( MaterialApp( home: Scaffold( body: SizedBox.expand( child: Scrollbar( thumbVisibility: true, controller: scrollController, child: NotificationListener( onNotification: handleScrollNotification, child: SingleChildScrollView( controller: scrollController, child: const SizedBox(height: 1200.0), ), ), ), ), ), ), ); await tester.pumpAndSettle(); expect(scrollController.offset, 0); expect(notification, isNull); final TestGesture dragScrollbarGesture = await tester.startGesture(const Offset(790, 45)); await tester.pumpAndSettle(); expect(notification, isA()); await dragScrollbarGesture.moveBy(const Offset(0, -20)); await tester.pumpAndSettle(); expect(notification, isA()); expect(scrollController.offset, 20); await dragScrollbarGesture.moveBy(const Offset(0, -20)); await tester.pumpAndSettle(); expect(notification, isA()); expect(scrollController.offset, 40); await dragScrollbarGesture.up(); await tester.pumpAndSettle(); expect(notification, isA()); }); }