page_test.dart 42.4 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
import 'package:flutter/cupertino.dart' show CupertinoPageRoute;
6
import 'package:flutter/material.dart';
7
import 'package:flutter/rendering.dart';
8
import 'package:flutter_test/flutter_test.dart';
9 10

import '../rendering/mock_canvas.dart';
11 12

void main() {
13
  testWidgets('test page transition (_FadeUpwardsPageTransition)', (WidgetTester tester) async {
14
    await tester.pumpWidget(
15
      MaterialApp(
16
        home: const Material(child: Text('Page 1')),
17 18 19 20 21 22 23
        theme: ThemeData(
          pageTransitionsTheme: const PageTransitionsTheme(
            builders: <TargetPlatform, PageTransitionsBuilder>{
              TargetPlatform.android: FadeUpwardsPageTransitionsBuilder(),
            },
          ),
        ),
24 25
        routes: <String, WidgetBuilder>{
          '/next': (BuildContext context) {
26
            return const Material(child: Text('Page 2'));
27
          },
28
        },
29
      ),
30 31
    );

32 33
    final Offset widget1TopLeft = tester.getTopLeft(find.text('Page 1'));

34 35
    tester.state<NavigatorState>(find.byType(Navigator)).pushNamed('/next');
    await tester.pump();
36
    await tester.pump(const Duration(milliseconds: 1));
37

38 39 40 41
    FadeTransition widget2Opacity =
        tester.element(find.text('Page 2')).findAncestorWidgetOfExactType<FadeTransition>()!;
    Offset widget2TopLeft = tester.getTopLeft(find.text('Page 2'));
    final Size widget2Size = tester.getSize(find.text('Page 2'));
42

43 44 45 46 47 48 49 50
    // Android transition is vertical only.
    expect(widget1TopLeft.dx == widget2TopLeft.dx, true);
    // Page 1 is above page 2 mid-transition.
    expect(widget1TopLeft.dy < widget2TopLeft.dy, true);
    // Animation begins 3/4 of the way up the page.
    expect(widget2TopLeft.dy < widget2Size.height / 4.0, true);
    // Animation starts with page 2 being near transparent.
    expect(widget2Opacity.opacity.value < 0.01, true);
51

52
    await tester.pump(const Duration(milliseconds: 300));
53 54 55 56 57 58 59

    // Page 2 covers page 1.
    expect(find.text('Page 1'), findsNothing);
    expect(find.text('Page 2'), isOnstage);

    tester.state<NavigatorState>(find.byType(Navigator)).pop();
    await tester.pump();
60
    await tester.pump(const Duration(milliseconds: 1));
61

62 63 64
    widget2Opacity =
        tester.element(find.text('Page 2')).findAncestorWidgetOfExactType<FadeTransition>()!;
    widget2TopLeft = tester.getTopLeft(find.text('Page 2'));
65

66 67 68 69
    // Page 2 starts to move down.
    expect(widget1TopLeft.dy < widget2TopLeft.dy, true);
    // Page 2 starts to lose opacity.
    expect(widget2Opacity.opacity.value < 1.0, true);
70

71
    await tester.pump(const Duration(milliseconds: 300));
72 73 74

    expect(find.text('Page 1'), isOnstage);
    expect(find.text('Page 2'), findsNothing);
75
  }, variant: TargetPlatformVariant.only(TargetPlatform.android));
76

77
  testWidgets('test page transition (CupertinoPageTransition)', (WidgetTester tester) async {
78
    final Key page2Key = UniqueKey();
79
    await tester.pumpWidget(
80
      MaterialApp(
81
        home: const Material(child: Text('Page 1')),
82 83
        routes: <String, WidgetBuilder>{
          '/next': (BuildContext context) {
84
            return Material(
85 86 87
              key: page2Key,
              child: const Text('Page 2'),
            );
88
          },
89
        },
90
      ),
91 92
    );

93
    final Offset widget1InitialTopLeft = tester.getTopLeft(find.text('Page 1'));
94 95

    tester.state<NavigatorState>(find.byType(Navigator)).pushNamed('/next');
96

97
    await tester.pump();
98
    await tester.pump(const Duration(milliseconds: 150));
99

100 101
    Offset widget1TransientTopLeft = tester.getTopLeft(find.text('Page 1'));
    Offset widget2TopLeft = tester.getTopLeft(find.text('Page 2'));
102
    final RenderDecoratedBox box = tester.element(find.byKey(page2Key))
103
        .findAncestorRenderObjectOfType<RenderDecoratedBox>()!;
104

105
    // Page 1 is moving to the left.
106
    expect(widget1TransientTopLeft.dx < widget1InitialTopLeft.dx, true);
107
    // Page 1 isn't moving vertically.
108
    expect(widget1TransientTopLeft.dy == widget1InitialTopLeft.dy, true);
109
    // iOS transition is horizontal only.
110
    expect(widget1InitialTopLeft.dy == widget2TopLeft.dy, true);
111
    // Page 2 is coming in from the right.
112
    expect(widget2TopLeft.dx > widget1InitialTopLeft.dx, true);
113 114 115 116 117 118 119 120 121 122 123
    // As explained in _CupertinoEdgeShadowPainter.paint the shadow is drawn
    // as a bunch of rects. The rects are covering an area to the left of
    // where the page 2 box is and a width of 5% of the page 2 box width.
    // `paints` tests relative to the painter's given canvas
    // rather than relative to the screen so assert that the shadow starts at
    // offset.dx = 0.
    final PaintPattern paintsShadow = paints;
    for (int i = 0; i < 0.05 * 800; i += 1) {
      paintsShadow.rect(rect: Rect.fromLTWH(-i.toDouble() - 1.0 , 0.0, 1.0, 600));
    }
    expect(box, paintsShadow);
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138

    await tester.pumpAndSettle();

    // Page 2 covers page 1.
    expect(find.text('Page 1'), findsNothing);
    expect(find.text('Page 2'), isOnstage);

    tester.state<NavigatorState>(find.byType(Navigator)).pop();
    await tester.pump();
    await tester.pump(const Duration(milliseconds: 100));

    widget1TransientTopLeft = tester.getTopLeft(find.text('Page 1'));
    widget2TopLeft = tester.getTopLeft(find.text('Page 2'));

    // Page 1 is coming back from the left.
139
    expect(widget1TransientTopLeft.dx < widget1InitialTopLeft.dx, true);
140
    // Page 1 isn't moving vertically.
141
    expect(widget1TransientTopLeft.dy == widget1InitialTopLeft.dy, true);
142
    // iOS transition is horizontal only.
143
    expect(widget1InitialTopLeft.dy == widget2TopLeft.dy, true);
144
    // Page 2 is leaving towards the right.
145
    expect(widget2TopLeft.dx > widget1InitialTopLeft.dx, true);
146 147 148 149 150 151 152 153 154 155

    await tester.pumpAndSettle();

    expect(find.text('Page 1'), isOnstage);
    expect(find.text('Page 2'), findsNothing);

    widget1TransientTopLeft = tester.getTopLeft(find.text('Page 1'));

    // Page 1 is back where it started.
    expect(widget1InitialTopLeft == widget1TransientTopLeft, true);
156
  }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS, TargetPlatform.macOS }));
157

158
  testWidgets('test page transition (_ZoomPageTransition)', (WidgetTester tester) async {
159
    Iterable<T> findWidgets<T extends Widget>(Finder of) {
160 161 162 163 164
      return tester.widgetList<T>(
        find.ancestor(of: of, matching: find.byType(T)),
      );
    }

165 166
    FadeTransition findForwardFadeTransition(Finder of) {
      return findWidgets<FadeTransition>(of).where(
167 168 169 170
            (FadeTransition t) => t.opacity.status == AnimationStatus.forward,
      ).first;
    }

171 172
    ScaleTransition findForwardScaleTransition(Finder of) {
      return findWidgets<ScaleTransition>(of).where(
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
            (ScaleTransition t) => t.scale.status == AnimationStatus.forward,
      ).first;
    }

    await tester.pumpWidget(
      MaterialApp(
        home: const Material(child: Text('Page 1')),
        routes: <String, WidgetBuilder>{
          '/next': (BuildContext context) {
            return const Material(child: Text('Page 2'));
          },
        },
      ),
    );

    tester.state<NavigatorState>(find.byType(Navigator)).pushNamed('/next');
    await tester.pump();
    await tester.pump(const Duration(milliseconds: 50));

192 193 194
    ScaleTransition widget1Scale = findForwardScaleTransition(find.text('Page 1'));
    ScaleTransition widget2Scale = findForwardScaleTransition(find.text('Page 2'));
    FadeTransition widget2Opacity = findForwardFadeTransition(find.text('Page 2'));
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213

    // Page 1 is enlarging, starts from 1.0.
    expect(widget1Scale.scale.value, greaterThan(1.0));
    // Page 2 is enlarging from the value less than 1.0.
    expect(widget2Scale.scale.value, lessThan(1.0));
    // Page 2 is becoming none transparent.
    expect(widget2Opacity.opacity.value, lessThan(1.0));

    await tester.pump(const Duration(milliseconds: 250));
    await tester.pump(const Duration(milliseconds: 1));

    // Page 2 covers page 1.
    expect(find.text('Page 1'), findsNothing);
    expect(find.text('Page 2'), isOnstage);

    tester.state<NavigatorState>(find.byType(Navigator)).pop();
    await tester.pump();
    await tester.pump(const Duration(milliseconds: 100));

214 215 216
    widget1Scale = findForwardScaleTransition(find.text('Page 1'));
    widget2Scale = findForwardScaleTransition(find.text('Page 2'));
    widget2Opacity = findForwardFadeTransition(find.text('Page 2'));
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231

    // Page 1 is narrowing down, but still larger than 1.0.
    expect(widget1Scale.scale.value, greaterThan(1.0));
    // Page 2 is smaller than 1.0.
    expect(widget2Scale.scale.value, lessThan(1.0));
    // Page 2 is becoming transparent.
    expect(widget2Opacity.opacity.value, lessThan(1.0));

    await tester.pump(const Duration(milliseconds: 200));
    await tester.pump(const Duration(milliseconds: 1));

    expect(find.text('Page 1'), isOnstage);
    expect(find.text('Page 2'), findsNothing);
  }, variant: TargetPlatformVariant.only(TargetPlatform.android));

Dan Field's avatar
Dan Field committed
232
  testWidgets('test fullscreen dialog transition', (WidgetTester tester) async {
233
    await tester.pumpWidget(
Dan Field's avatar
Dan Field committed
234 235
      const MaterialApp(
        home: Material(child: Text('Page 1')),
236
      ),
237 238
    );

239
    final Offset widget1InitialTopLeft = tester.getTopLeft(find.text('Page 1'));
240

241
    tester.state<NavigatorState>(find.byType(Navigator)).push(MaterialPageRoute<void>(
242
      builder: (BuildContext context) {
243
        return const Material(child: Text('Page 2'));
244 245 246 247 248 249 250
      },
      fullscreenDialog: true,
    ));

    await tester.pump();
    await tester.pump(const Duration(milliseconds: 100));

251 252
    Offset widget1TransientTopLeft = tester.getTopLeft(find.text('Page 1'));
    Offset widget2TopLeft = tester.getTopLeft(find.text('Page 2'));
253 254 255 256

    // Page 1 doesn't move.
    expect(widget1TransientTopLeft == widget1InitialTopLeft, true);
    // Fullscreen dialogs transitions vertically only.
257
    expect(widget1InitialTopLeft.dx == widget2TopLeft.dx, true);
258
    // Page 2 is coming in from the bottom.
259
    expect(widget2TopLeft.dy > widget1InitialTopLeft.dy, true);
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276

    await tester.pumpAndSettle();

    // Page 2 covers page 1.
    expect(find.text('Page 1'), findsNothing);
    expect(find.text('Page 2'), isOnstage);

    tester.state<NavigatorState>(find.byType(Navigator)).pop();
    await tester.pump();
    await tester.pump(const Duration(milliseconds: 100));

    widget1TransientTopLeft = tester.getTopLeft(find.text('Page 1'));
    widget2TopLeft = tester.getTopLeft(find.text('Page 2'));

    // Page 1 doesn't move.
    expect(widget1TransientTopLeft == widget1InitialTopLeft, true);
    // Fullscreen dialogs transitions vertically only.
277
    expect(widget1InitialTopLeft.dx == widget2TopLeft.dx, true);
278
    // Page 2 is leaving towards the bottom.
279
    expect(widget2TopLeft.dy > widget1InitialTopLeft.dy, true);
280 281 282 283 284 285 286 287 288 289

    await tester.pumpAndSettle();

    expect(find.text('Page 1'), isOnstage);
    expect(find.text('Page 2'), findsNothing);

    widget1TransientTopLeft = tester.getTopLeft(find.text('Page 1'));

    // Page 1 is back where it started.
    expect(widget1InitialTopLeft == widget1TransientTopLeft, true);
290
  }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS, TargetPlatform.macOS }));
291 292 293

  testWidgets('test no back gesture on Android', (WidgetTester tester) async {
    await tester.pumpWidget(
294
      MaterialApp(
295
        home: const Scaffold(body: Text('Page 1')),
296 297
        routes: <String, WidgetBuilder>{
          '/next': (BuildContext context) {
298
            return const Scaffold(body: Text('Page 2'));
299 300
          },
        },
301
      ),
302 303 304 305 306 307 308 309 310
    );

    tester.state<NavigatorState>(find.byType(Navigator)).pushNamed('/next');
    await tester.pumpAndSettle();

    expect(find.text('Page 1'), findsNothing);
    expect(find.text('Page 2'), isOnstage);

    // Drag from left edge to invoke the gesture.
311
    final TestGesture gesture = await tester.startGesture(const Offset(5.0, 100.0));
312
    await gesture.moveBy(const Offset(400.0, 0.0));
313
    await tester.pump();
314 315 316 317 318

    expect(find.text('Page 1'), findsNothing);
    expect(find.text('Page 2'), isOnstage);

    // Page 2 didn't move
319
    expect(tester.getTopLeft(find.text('Page 2')), Offset.zero);
320
  }, variant: TargetPlatformVariant.only(TargetPlatform.android));
321

Dan Field's avatar
Dan Field committed
322
  testWidgets('test back gesture', (WidgetTester tester) async {
323
    await tester.pumpWidget(
324
      MaterialApp(
325
        home: const Scaffold(body: Text('Page 1')),
326 327
        routes: <String, WidgetBuilder>{
          '/next': (BuildContext context) {
328
            return const Scaffold(body: Text('Page 2'));
329 330
          },
        },
331
      ),
332 333 334 335 336 337 338 339 340
    );

    tester.state<NavigatorState>(find.byType(Navigator)).pushNamed('/next');
    await tester.pumpAndSettle();

    expect(find.text('Page 1'), findsNothing);
    expect(find.text('Page 2'), isOnstage);

    // Drag from left edge to invoke the gesture.
341
    final TestGesture gesture = await tester.startGesture(const Offset(5.0, 100.0));
342
    await gesture.moveBy(const Offset(400.0, 0.0));
343
    await tester.pump();
344 345 346 347

    // Page 1 is now visible.
    expect(find.text('Page 1'), isOnstage);
    expect(find.text('Page 2'), isOnstage);
348 349

    // The route widget position needs to track the finger position very exactly.
350
    expect(tester.getTopLeft(find.text('Page 2')), const Offset(400.0, 0.0));
351 352 353 354

    await gesture.moveBy(const Offset(-200.0, 0.0));
    await tester.pump();

355
    expect(tester.getTopLeft(find.text('Page 2')), const Offset(200.0, 0.0));
356 357 358 359

    await gesture.moveBy(const Offset(-100.0, 200.0));
    await tester.pump();

360
    expect(tester.getTopLeft(find.text('Page 2')), const Offset(100.0, 0.0));
361
  }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS, TargetPlatform.macOS }));
362

363 364
  testWidgets('back gesture while OS changes', (WidgetTester tester) async {
    final Map<String, WidgetBuilder> routes = <String, WidgetBuilder>{
365
      '/': (BuildContext context) => Material(
366
        child: TextButton(
367
          child: const Text('PUSH'),
368
          onPressed: () { Navigator.of(context).pushNamed('/b'); },
369 370
        ),
      ),
371
      '/b': (BuildContext context) => const Text('HELLO'),
372 373
    };
    await tester.pumpWidget(
374 375
      MaterialApp(
        theme: ThemeData(platform: TargetPlatform.iOS),
376 377 378 379
        routes: routes,
      ),
    );
    await tester.tap(find.text('PUSH'));
380
    expect(await tester.pumpAndSettle(const Duration(minutes: 1)), 2);
381 382 383 384 385 386 387 388 389 390 391 392 393 394
    expect(find.text('PUSH'), findsNothing);
    expect(find.text('HELLO'), findsOneWidget);
    final Offset helloPosition1 = tester.getCenter(find.text('HELLO'));
    final TestGesture gesture = await tester.startGesture(const Offset(2.5, 300.0));
    await tester.pump(const Duration(milliseconds: 20));
    await gesture.moveBy(const Offset(100.0, 0.0));
    expect(find.text('PUSH'), findsNothing);
    expect(find.text('HELLO'), findsOneWidget);
    await tester.pump(const Duration(milliseconds: 20));
    expect(find.text('PUSH'), findsOneWidget);
    expect(find.text('HELLO'), findsOneWidget);
    final Offset helloPosition2 = tester.getCenter(find.text('HELLO'));
    expect(helloPosition1.dx, lessThan(helloPosition2.dx));
    expect(helloPosition1.dy, helloPosition2.dy);
395
    expect(Theme.of(tester.element(find.text('HELLO'))).platform, TargetPlatform.iOS);
396
    await tester.pumpWidget(
397 398
      MaterialApp(
        theme: ThemeData(platform: TargetPlatform.android),
399 400 401 402 403 404 405 406 407 408 409 410
        routes: routes,
      ),
    );
    // Now we have to let the theme animation run through.
    // This takes three frames (including the first one above):
    //  1. Start the Theme animation. It's at t=0 so everything else is identical.
    //  2. Start any animations that are informed by the Theme, for example, the
    //     DefaultTextStyle, on the first frame that the theme is not at t=0. In
    //     this case, it's at t=1.0 of the theme animation, so this is also the
    //     frame in which the theme animation ends.
    //  3. End all the other animations.
    expect(await tester.pumpAndSettle(const Duration(minutes: 1)), 2);
411
    expect(Theme.of(tester.element(find.text('HELLO'))).platform, TargetPlatform.android);
412 413 414 415 416 417 418 419 420 421 422 423 424
    final Offset helloPosition3 = tester.getCenter(find.text('HELLO'));
    expect(helloPosition3, helloPosition2);
    expect(find.text('PUSH'), findsOneWidget);
    expect(find.text('HELLO'), findsOneWidget);
    await gesture.moveBy(const Offset(100.0, 0.0));
    await tester.pump(const Duration(milliseconds: 20));
    expect(find.text('PUSH'), findsOneWidget);
    expect(find.text('HELLO'), findsOneWidget);
    final Offset helloPosition4 = tester.getCenter(find.text('HELLO'));
    expect(helloPosition3.dx, lessThan(helloPosition4.dx));
    expect(helloPosition3.dy, helloPosition4.dy);
    await gesture.moveBy(const Offset(500.0, 0.0));
    await gesture.up();
425
    expect(await tester.pumpAndSettle(const Duration(minutes: 1)), 3);
426 427
    expect(find.text('PUSH'), findsOneWidget);
    expect(find.text('HELLO'), findsNothing);
428 429

    await tester.pumpWidget(
430
      MaterialApp(
Dan Field's avatar
Dan Field committed
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
        theme: ThemeData(platform: TargetPlatform.macOS),
        routes: routes,
      ),
    );
    await tester.tap(find.text('PUSH'));
    expect(await tester.pumpAndSettle(const Duration(minutes: 1)), 2);
    expect(find.text('PUSH'), findsNothing);
    expect(find.text('HELLO'), findsOneWidget);
    final Offset helloPosition5 = tester.getCenter(find.text('HELLO'));
    await gesture.down(const Offset(2.5, 300.0));
    await tester.pump(const Duration(milliseconds: 20));
    await gesture.moveBy(const Offset(100.0, 0.0));
    expect(find.text('PUSH'), findsNothing);
    expect(find.text('HELLO'), findsOneWidget);
    await tester.pump(const Duration(milliseconds: 20));
446
    expect(find.text('PUSH'), findsOneWidget);
Dan Field's avatar
Dan Field committed
447 448
    expect(find.text('HELLO'), findsOneWidget);
    final Offset helloPosition6 = tester.getCenter(find.text('HELLO'));
449 450
    expect(helloPosition5.dx, lessThan(helloPosition6.dx));
    expect(helloPosition5.dy, helloPosition6.dy);
451
    expect(Theme.of(tester.element(find.text('HELLO'))).platform, TargetPlatform.macOS);
452
  });
Dan Field's avatar
Dan Field committed
453 454 455 456 457

  testWidgets('test no back gesture on fullscreen dialogs', (WidgetTester tester) async {
    await tester.pumpWidget(
      const MaterialApp(
        home: Scaffold(body: Text('Page 1')),
458
      ),
459 460
    );

461
    tester.state<NavigatorState>(find.byType(Navigator)).push(MaterialPageRoute<void>(
462
      builder: (BuildContext context) {
463
        return const Scaffold(body: Text('Page 2'));
464 465 466 467 468 469 470 471 472
      },
      fullscreenDialog: true,
    ));
    await tester.pumpAndSettle();

    expect(find.text('Page 1'), findsNothing);
    expect(find.text('Page 2'), isOnstage);

    // Drag from left edge to invoke the gesture.
473
    final TestGesture gesture = await tester.startGesture(const Offset(5.0, 100.0));
474
    await gesture.moveBy(const Offset(400.0, 0.0));
475
    await tester.pump();
476 477 478 479 480

    expect(find.text('Page 1'), findsNothing);
    expect(find.text('Page 2'), isOnstage);

    // Page 2 didn't move
481
    expect(tester.getTopLeft(find.text('Page 2')), Offset.zero);
Dan Field's avatar
Dan Field committed
482
  }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }));
483 484 485

  testWidgets('test adaptable transitions switch during execution', (WidgetTester tester) async {
    await tester.pumpWidget(
486
      MaterialApp(
487 488 489 490 491 492 493 494
        theme: ThemeData(
          platform: TargetPlatform.android,
          pageTransitionsTheme: const PageTransitionsTheme(
            builders: <TargetPlatform, PageTransitionsBuilder>{
              TargetPlatform.android: FadeUpwardsPageTransitionsBuilder(),
            },
          ),
        ),
495
        home: const Material(child: Text('Page 1')),
496 497
        routes: <String, WidgetBuilder>{
          '/next': (BuildContext context) {
498
            return const Material(child: Text('Page 2'));
499 500
          },
        },
501
      ),
502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
    );

    final Offset widget1InitialTopLeft = tester.getTopLeft(find.text('Page 1'));

    tester.state<NavigatorState>(find.byType(Navigator)).pushNamed('/next');
    await tester.pump();
    await tester.pump(const Duration(milliseconds: 100));

    Offset widget2TopLeft = tester.getTopLeft(find.text('Page 2'));
    final Size widget2Size = tester.getSize(find.text('Page 2'));

    // Android transition is vertical only.
    expect(widget1InitialTopLeft.dx == widget2TopLeft.dx, true);
    // Page 1 is above page 2 mid-transition.
    expect(widget1InitialTopLeft.dy < widget2TopLeft.dy, true);
    // Animation begins from the top of the page.
    expect(widget2TopLeft.dy < widget2Size.height, true);

    await tester.pump(const Duration(milliseconds: 300));

    // Page 2 covers page 1.
    expect(find.text('Page 1'), findsNothing);
    expect(find.text('Page 2'), isOnstage);

    // Re-pump the same app but with iOS instead of Android.
    await tester.pumpWidget(
528
      MaterialApp(
529
        home: const Material(child: Text('Page 1')),
530 531
        routes: <String, WidgetBuilder>{
          '/next': (BuildContext context) {
532
            return const Material(child: Text('Page 2'));
533 534
          },
        },
535
      ),
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562
    );

    tester.state<NavigatorState>(find.byType(Navigator)).pop();
    await tester.pump();
    await tester.pump(const Duration(milliseconds: 100));

    Offset widget1TransientTopLeft = tester.getTopLeft(find.text('Page 1'));
    widget2TopLeft = tester.getTopLeft(find.text('Page 2'));

    // Page 1 is coming back from the left.
    expect(widget1TransientTopLeft.dx < widget1InitialTopLeft.dx, true);
    // Page 1 isn't moving vertically.
    expect(widget1TransientTopLeft.dy == widget1InitialTopLeft.dy, true);
    // iOS transition is horizontal only.
    expect(widget1InitialTopLeft.dy == widget2TopLeft.dy, true);
    // Page 2 is leaving towards the right.
    expect(widget2TopLeft.dx > widget1InitialTopLeft.dx, true);

    await tester.pump(const Duration(milliseconds: 300));

    expect(find.text('Page 1'), isOnstage);
    expect(find.text('Page 2'), findsNothing);

    widget1TransientTopLeft = tester.getTopLeft(find.text('Page 1'));

    // Page 1 is back where it started.
    expect(widget1InitialTopLeft == widget1TransientTopLeft, true);
563
  }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }));
564

Dan Field's avatar
Dan Field committed
565
  testWidgets('test edge swipe then drop back at starting point works', (WidgetTester tester) async {
566 567 568 569 570 571 572 573
    await tester.pumpWidget(
      MaterialApp(
        onGenerateRoute: (RouteSettings settings) {
          return MaterialPageRoute<void>(
            settings: settings,
            builder: (BuildContext context) {
              final String pageNumber = settings.name == '/' ? '1' : '2';
              return Center(child: Text('Page $pageNumber'));
574
            },
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597
          );
        },
      ),
    );

    tester.state<NavigatorState>(find.byType(Navigator)).pushNamed('/next');

    await tester.pump();
    await tester.pump(const Duration(seconds: 1));

    expect(find.text('Page 1'), findsNothing);
    expect(find.text('Page 2'), isOnstage);

    final TestGesture gesture = await tester.startGesture(const Offset(5, 200));
    await gesture.moveBy(const Offset(300, 0));
    await tester.pump();
    // Bring it exactly back such that there's nothing to animate when releasing.
    await gesture.moveBy(const Offset(-300, 0));
    await gesture.up();
    await tester.pump();

    expect(find.text('Page 1'), findsNothing);
    expect(find.text('Page 2'), isOnstage);
Dan Field's avatar
Dan Field committed
598
  }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }));
599

Dan Field's avatar
Dan Field committed
600
  testWidgets('test edge swipe then drop back at ending point works', (WidgetTester tester) async {
601 602 603 604 605 606 607 608
    await tester.pumpWidget(
      MaterialApp(
        onGenerateRoute: (RouteSettings settings) {
          return MaterialPageRoute<void>(
            settings: settings,
            builder: (BuildContext context) {
              final String pageNumber = settings.name == '/' ? '1' : '2';
              return Center(child: Text('Page $pageNumber'));
609
            },
610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630
          );
        },
      ),
    );

    tester.state<NavigatorState>(find.byType(Navigator)).pushNamed('/next');

    await tester.pump();
    await tester.pump(const Duration(seconds: 1));

    expect(find.text('Page 1'), findsNothing);
    expect(find.text('Page 2'), isOnstage);

    final TestGesture gesture = await tester.startGesture(const Offset(5, 200));
    // The width of the page.
    await gesture.moveBy(const Offset(800, 0));
    await gesture.up();
    await tester.pump();

    expect(find.text('Page 1'), isOnstage);
    expect(find.text('Page 2'), findsNothing);
631
  }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }));
632 633 634 635 636 637 638 639 640 641

  testWidgets('Back swipe dismiss interrupted by route push', (WidgetTester tester) async {
    // Regression test for https://github.com/flutter/flutter/issues/28728
    final GlobalKey scaffoldKey = GlobalKey();

    await tester.pumpWidget(
      MaterialApp(
        home: Scaffold(
          key: scaffoldKey,
          body: Center(
642
            child: ElevatedButton(
643
              onPressed: () {
644
                Navigator.push<void>(scaffoldKey.currentContext!, MaterialPageRoute<void>(
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687
                  builder: (BuildContext context) {
                    return const Scaffold(
                      body: Center(child: Text('route')),
                    );
                  },
                ));
              },
              child: const Text('push'),
            ),
          ),
        ),
      ),
    );

    // Check the basic iOS back-swipe dismiss transition. Dragging the pushed
    // route halfway across the screen will trigger the iOS dismiss animation

    await tester.tap(find.text('push'));
    await tester.pumpAndSettle();
    expect(find.text('route'), findsOneWidget);
    expect(find.text('push'), findsNothing);

    TestGesture gesture = await tester.startGesture(const Offset(5, 300));
    await gesture.moveBy(const Offset(400, 0));
    await gesture.up();
    await tester.pump();
    expect( // The 'route' route has been dragged to the right, halfway across the screen
      tester.getTopLeft(find.ancestor(of: find.text('route'), matching: find.byType(Scaffold))),
      const Offset(400, 0),
    );
    expect( // The 'push' route is sliding in from the left.
      tester.getTopLeft(find.ancestor(of: find.text('push'), matching: find.byType(Scaffold))).dx,
      lessThan(0),
    );
    await tester.pumpAndSettle();
    expect(find.text('push'), findsOneWidget);
    expect(
      tester.getTopLeft(find.ancestor(of: find.text('push'), matching: find.byType(Scaffold))),
      Offset.zero,
    );
    expect(find.text('route'), findsNothing);


688 689 690
    // Run the dismiss animation 60%, which exposes the route "push" button,
    // and then press the button. A drag dropped animation is 400ms when dropped
    // exactly halfway. It follows a curve that is very steep initially.
691 692 693 694 695 696 697

    await tester.tap(find.text('push'));
    await tester.pumpAndSettle();
    expect(find.text('route'), findsOneWidget);
    expect(find.text('push'), findsNothing);

    gesture = await tester.startGesture(const Offset(5, 300));
698
    await gesture.moveBy(const Offset(400, 0)); // Drag halfway.
699
    await gesture.up();
700 701 702 703 704 705 706 707 708 709 710
    await tester.pump(); // Trigger the dropped snapping animation.
    expect(
      tester.getTopLeft(find.ancestor(of: find.text('route'), matching: find.byType(Scaffold))),
      const Offset(400, 0),
    );
    // Let the dismissing snapping animation go 60%.
    await tester.pump(const Duration(milliseconds: 240));
    expect(
      tester.getTopLeft(find.ancestor(of: find.text('route'), matching: find.byType(Scaffold))).dx,
      moreOrLessEquals(798, epsilon: 1),
    );
711 712 713 714

    // Use the navigator to push a route instead of tapping the 'push' button.
    // The topmost route (the one that's animating away), ignores input while
    // the pop is underway because route.navigator.userGestureInProgress.
715
    Navigator.push<void>(scaffoldKey.currentContext!, MaterialPageRoute<void>(
716 717 718 719 720 721 722
      builder: (BuildContext context) {
        return const Scaffold(
          body: Center(child: Text('route')),
        );
      },
    ));

723 724 725
    await tester.pumpAndSettle();
    expect(find.text('route'), findsOneWidget);
    expect(find.text('push'), findsNothing);
726
  }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }));
727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742

  testWidgets('During back swipe the route ignores input', (WidgetTester tester) async {
    // Regression test for https://github.com/flutter/flutter/issues/39989

    final GlobalKey homeScaffoldKey = GlobalKey();
    final GlobalKey pageScaffoldKey = GlobalKey();
    int homeTapCount = 0;
    int pageTapCount = 0;

    await tester.pumpWidget(
      MaterialApp(
        home: Scaffold(
          key: homeScaffoldKey,
          body: GestureDetector(
            onTap: () {
              homeTapCount += 1;
743
            },
744 745 746 747 748 749 750 751 752
          ),
        ),
      ),
    );

    await tester.tap(find.byKey(homeScaffoldKey));
    expect(homeTapCount, 1);
    expect(pageTapCount, 0);

753
    Navigator.push<void>(homeScaffoldKey.currentContext!, MaterialPageRoute<void>(
754 755 756 757 758 759 760 761 762
      builder: (BuildContext context) {
        return Scaffold(
          key: pageScaffoldKey,
          appBar: AppBar(title: const Text('Page')),
          body: Padding(
            padding: const EdgeInsets.all(16),
            child: GestureDetector(
              onTap: () {
                pageTapCount += 1;
763
              },
764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786
            ),
          ),
        );
      },
    ));

    await tester.pumpAndSettle();
    await tester.tap(find.byKey(pageScaffoldKey));
    expect(homeTapCount, 1);
    expect(pageTapCount, 1);

    // Start the basic iOS back-swipe dismiss transition. Drag the pushed
    // "page" route halfway across the screen. The underlying "home" will
    // start sliding in from the left.

    final TestGesture gesture = await tester.startGesture(const Offset(5, 300));
    await gesture.moveBy(const Offset(400, 0));
    await tester.pump();
    expect(tester.getTopLeft(find.byKey(pageScaffoldKey)), const Offset(400, 0));
    expect(tester.getTopLeft(find.byKey(homeScaffoldKey)).dx, lessThan(0));

    // Tapping on the "page" route doesn't trigger the GestureDetector because
    // it's being dragged.
787
    await tester.tap(find.byKey(pageScaffoldKey), warnIfMissed: false);
788 789 790 791
    expect(homeTapCount, 1);
    expect(pageTapCount, 1);

    // Tapping the "page" route's back button doesn't do anything either.
792
    await tester.tap(find.byTooltip('Back'), warnIfMissed: false);
793 794
    await tester.pumpAndSettle();
    expect(tester.getTopLeft(find.byKey(pageScaffoldKey)), const Offset(400, 0));
795
    expect(tester.getTopLeft(find.byKey(homeScaffoldKey)).dx, lessThan(0));
796
  }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }));
797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812

  testWidgets('After a pop caused by a back-swipe, input reaches the exposed route', (WidgetTester tester) async {
    // Regression test for https://github.com/flutter/flutter/issues/41024

    final GlobalKey homeScaffoldKey = GlobalKey();
    final GlobalKey pageScaffoldKey = GlobalKey();
    int homeTapCount = 0;
    int pageTapCount = 0;

    await tester.pumpWidget(
      MaterialApp(
        home: Scaffold(
          key: homeScaffoldKey,
          body: GestureDetector(
            onTap: () {
              homeTapCount += 1;
813
            },
814 815 816 817 818 819 820 821 822
          ),
        ),
      ),
    );

    await tester.tap(find.byKey(homeScaffoldKey));
    expect(homeTapCount, 1);
    expect(pageTapCount, 0);

823
    final ValueNotifier<bool> notifier = Navigator.of(homeScaffoldKey.currentContext!).userGestureInProgressNotifier;
824 825
    expect(notifier.value, false);

826
    Navigator.push<void>(homeScaffoldKey.currentContext!, MaterialPageRoute<void>(
827 828 829 830 831 832 833 834 835
      builder: (BuildContext context) {
        return Scaffold(
          key: pageScaffoldKey,
          appBar: AppBar(title: const Text('Page')),
          body: Padding(
            padding: const EdgeInsets.all(16),
            child: GestureDetector(
              onTap: () {
                pageTapCount += 1;
836
              },
837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866
            ),
          ),
        );
      },
    ));

    await tester.pumpAndSettle();
    await tester.tap(find.byKey(pageScaffoldKey));
    expect(homeTapCount, 1);
    expect(pageTapCount, 1);

    // Trigger the basic iOS back-swipe dismiss transition. Drag the pushed
    // "page" route more than halfway across the screen and then release it.

    final TestGesture gesture = await tester.startGesture(const Offset(5, 300));
    await gesture.moveBy(const Offset(500, 0));
    await tester.pump();
    expect(tester.getTopLeft(find.byKey(pageScaffoldKey)), const Offset(500, 0));
    expect(tester.getTopLeft(find.byKey(homeScaffoldKey)).dx, lessThan(0));
    expect(notifier.value, true);
    await gesture.up();
    await tester.pumpAndSettle();
    expect(notifier.value, false);
    expect(find.byKey(pageScaffoldKey), findsNothing);

    // The back-swipe dismiss pop transition has finished and input on the
    // home page still works.
    await tester.tap(find.byKey(homeScaffoldKey));
    expect(homeTapCount, 2);
    expect(pageTapCount, 1);
867
  }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }));
868

Dan Field's avatar
Dan Field committed
869
  testWidgets('A MaterialPageRoute should slide out with CupertinoPageTransition when a compatible PageRoute is pushed on top of it', (WidgetTester tester) async {
870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894
    // Regression test for https://github.com/flutter/flutter/issues/44864.

    await tester.pumpWidget(
      MaterialApp(
        theme: ThemeData(platform: TargetPlatform.iOS),
        home: Scaffold(
          appBar: AppBar(title: const Text('Title')),
        ),
      ),
    );

    final Offset titleInitialTopLeft = tester.getTopLeft(find.text('Title'));

    tester.state<NavigatorState>(find.byType(Navigator)).push<void>(
      CupertinoPageRoute<void>(builder: (BuildContext context) => const Placeholder()),
    );

    await tester.pump();
    await tester.pump(const Duration(milliseconds: 150));

    final Offset titleTransientTopLeft = tester.getTopLeft(find.text('Title'));

    // Title of the first route slides to the left.
    expect(titleInitialTopLeft.dy, equals(titleTransientTopLeft.dy));
    expect(titleInitialTopLeft.dx, greaterThan(titleTransientTopLeft.dx));
895
  }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }));
896 897 898 899 900

  testWidgets('MaterialPage works', (WidgetTester tester) async {
    final LocalKey pageKey = UniqueKey();
    final TransitionDetector detector = TransitionDetector();
    List<Page<void>> myPages = <Page<void>>[
901
      MaterialPage<void>(key: pageKey, child: const Text('first')),
902 903 904 905
    ];
    await tester.pumpWidget(
      buildNavigator(
        pages: myPages,
906 907 908 909
        onPopPage: (Route<dynamic> route, dynamic result) {
          assert(false); // The test should never execute this.
          return true;
        },
910
        transitionDelegate: detector,
911
      ),
912 913 914 915 916 917
    );

    expect(detector.hasTransition, isFalse);
    expect(find.text('first'), findsOneWidget);

    myPages = <Page<void>>[
918
      MaterialPage<void>(key: pageKey, child: const Text('second')),
919 920 921 922 923
    ];

    await tester.pumpWidget(
      buildNavigator(
        pages: myPages,
924 925 926 927
        onPopPage: (Route<dynamic> route, dynamic result) {
          assert(false); // The test should never execute this.
          return true;
        },
928
        transitionDelegate: detector,
929
      ),
930 931 932 933 934 935 936 937 938 939 940 941 942
    );
    // There should be no transition because the page has the same key.
    expect(detector.hasTransition, isFalse);
    // The content does update.
    expect(find.text('first'), findsNothing);
    expect(find.text('second'), findsOneWidget);
  });

  testWidgets('MaterialPage can toggle MaintainState', (WidgetTester tester) async {
    final LocalKey pageKeyOne = UniqueKey();
    final LocalKey pageKeyTwo = UniqueKey();
    final TransitionDetector detector = TransitionDetector();
    List<Page<void>> myPages = <Page<void>>[
943 944
      MaterialPage<void>(key: pageKeyOne, maintainState: false, child: const Text('first')),
      MaterialPage<void>(key: pageKeyTwo, child: const Text('second')),
945 946 947 948
    ];
    await tester.pumpWidget(
      buildNavigator(
        pages: myPages,
949 950 951 952
        onPopPage: (Route<dynamic> route, dynamic result) {
          assert(false); // The test should never execute this.
          return true;
        },
953
        transitionDelegate: detector,
954
      ),
955 956 957 958 959 960 961 962
    );

    expect(detector.hasTransition, isFalse);
    // Page one does not maintain state.
    expect(find.text('first', skipOffstage: false), findsNothing);
    expect(find.text('second'), findsOneWidget);

    myPages = <Page<void>>[
963
      MaterialPage<void>(key: pageKeyOne, child: const Text('first')),
964
      MaterialPage<void>(key: pageKeyTwo, child: const Text('second')),
965 966 967 968 969
    ];

    await tester.pumpWidget(
      buildNavigator(
        pages: myPages,
970 971 972 973
        onPopPage: (Route<dynamic> route, dynamic result) {
          assert(false); // The test should never execute this.
          return true;
        },
974
        transitionDelegate: detector,
975
      ),
976 977 978 979 980 981 982 983
    );
    // There should be no transition because the page has the same key.
    expect(detector.hasTransition, isFalse);
    // Page one sets the maintain state to be true, its widget tree should be
    // built.
    expect(find.text('first', skipOffstage: false), findsOneWidget);
    expect(find.text('second'), findsOneWidget);
  });
984 985 986 987 988 989 990

  testWidgets('MaterialPage does not lose its state when transitioning out', (WidgetTester tester) async {
    final GlobalKey<NavigatorState> navigator = GlobalKey<NavigatorState>();
    await tester.pumpWidget(KeepsStateTestWidget(navigatorKey: navigator));
    expect(find.text('subpage'), findsOneWidget);
    expect(find.text('home'), findsNothing);

991
    navigator.currentState!.pop();
992 993 994 995 996
    await tester.pump();

    expect(find.text('subpage'), findsOneWidget);
    expect(find.text('home'), findsOneWidget);
  });
997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055

  testWidgets('MaterialPage restores its state', (WidgetTester tester) async {
    await tester.pumpWidget(
      RootRestorationScope(
        restorationId: 'root',
        child: Directionality(
          textDirection: TextDirection.ltr,
          child: Navigator(
            onPopPage: (Route<dynamic> route, dynamic result) { return false; },
            pages: const <Page<Object?>>[
              MaterialPage<void>(
                restorationId: 'p1',
                child: TestRestorableWidget(restorationId: 'p1'),
              ),
            ],
            restorationScopeId: 'nav',
            onGenerateRoute: (RouteSettings settings) {
              return MaterialPageRoute<void>(
                settings: settings,
                builder: (BuildContext context) {
                  return TestRestorableWidget(restorationId: settings.name!);
                },
              );
            },
          ),
        ),
      ),
    );

    expect(find.text('p1'), findsOneWidget);
    expect(find.text('count: 0'), findsOneWidget);

    await tester.tap(find.text('increment'));
    await tester.pump();
    expect(find.text('count: 1'), findsOneWidget);

    tester.state<NavigatorState>(find.byType(Navigator)).restorablePushNamed('p2');
    await tester.pumpAndSettle();

    expect(find.text('p1'), findsNothing);
    expect(find.text('p2'), findsOneWidget);

    await tester.tap(find.text('increment'));
    await tester.pump();
    await tester.tap(find.text('increment'));
    await tester.pump();
    expect(find.text('count: 2'), findsOneWidget);

    await tester.restartAndRestore();

    expect(find.text('p2'), findsOneWidget);
    expect(find.text('count: 2'), findsOneWidget);

    tester.state<NavigatorState>(find.byType(Navigator)).pop();
    await tester.pumpAndSettle();

    expect(find.text('p1'), findsOneWidget);
    expect(find.text('count: 1'), findsOneWidget);
  });
1056 1057 1058 1059 1060 1061
}

class TransitionDetector extends DefaultTransitionDelegate<void> {
  bool hasTransition = false;
  @override
  Iterable<RouteTransitionRecord> resolve({
1062 1063
    required List<RouteTransitionRecord> newPageRouteHistory,
    required Map<RouteTransitionRecord?, RouteTransitionRecord> locationToExitingPageRoute,
1064
    required Map<RouteTransitionRecord?, List<RouteTransitionRecord>> pageRouteToPagelessRoutes,
1065 1066 1067 1068 1069
  }) {
    hasTransition = true;
    return super.resolve(
      newPageRouteHistory: newPageRouteHistory,
      locationToExitingPageRoute: locationToExitingPageRoute,
1070
      pageRouteToPagelessRoutes: pageRouteToPagelessRoutes,
1071 1072 1073 1074 1075
    );
  }
}

Widget buildNavigator({
1076 1077 1078
  required List<Page<dynamic>> pages,
  required PopPageCallback onPopPage,
  GlobalKey<NavigatorState>? key,
1079
  TransitionDelegate<dynamic>? transitionDelegate,
1080 1081
}) {
  return MediaQuery(
1082
    data: MediaQueryData.fromWindow(WidgetsBinding.instance.window),
1083 1084 1085 1086
    child: Localizations(
      locale: const Locale('en', 'US'),
      delegates: const <LocalizationsDelegate<dynamic>>[
        DefaultMaterialLocalizations.delegate,
1087
        DefaultWidgetsLocalizations.delegate,
1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099
      ],
      child: Directionality(
        textDirection: TextDirection.ltr,
        child: Navigator(
          key: key,
          pages: pages,
          onPopPage: onPopPage,
          transitionDelegate: transitionDelegate ?? const DefaultTransitionDelegate<dynamic>(),
        ),
      ),
    ),
  );
1100
}
1101 1102

class KeepsStateTestWidget extends StatefulWidget {
1103
  const KeepsStateTestWidget({super.key, this.navigatorKey});
1104

1105
  final Key? navigatorKey;
1106 1107 1108 1109 1110 1111

  @override
  State<KeepsStateTestWidget> createState() => _KeepsStateTestWidgetState();
}

class _KeepsStateTestWidgetState extends State<KeepsStateTestWidget> {
1112
  String? _subpage = 'subpage';
1113 1114 1115 1116 1117 1118 1119 1120

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Navigator(
        key: widget.navigatorKey,
        pages: <Page<void>>[
          const MaterialPage<void>(child: Text('home')),
1121
          if (_subpage != null) MaterialPage<void>(child: Text(_subpage!)),
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135
        ],
        onPopPage: (Route<dynamic> route, dynamic result) {
          if (!route.didPop(result)) {
            return false;
          }
          setState(() {
            _subpage = null;
          });
          return true;
        },
      ),
    );
  }
}
1136 1137

class TestRestorableWidget extends StatefulWidget {
1138
  const TestRestorableWidget({super.key, required this.restorationId});
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

  final String restorationId;

  @override
  State<StatefulWidget> createState() => _TestRestorableWidgetState();
}

class _TestRestorableWidgetState extends State<TestRestorableWidget> with RestorationMixin {
  @override
  String? get restorationId => widget.restorationId;

  final RestorableInt counter = RestorableInt(0);

  @override
  void restoreState(RestorationBucket? oldBucket, bool initialRestore) {
    registerForRestoration(counter, 'counter');
  }

  @override
  Widget build(BuildContext context) {
    return Column(
      children: <Widget>[
        Text(widget.restorationId),
        Text('count: ${counter.value}'),
        ElevatedButton(
          onPressed: () {
            setState(() {
              counter.value++;
            });
          },
          child: const Text('increment'),
        ),
      ],
    );
  }
}