text_field_focus_test.dart 17.1 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:ui';

7
import 'package:flutter/material.dart';
8
import 'package:flutter/services.dart';
9
import 'package:flutter_test/flutter_test.dart';
10
import 'package:leak_tracker_flutter_testing/leak_tracker_flutter_testing.dart';
11 12

void main() {
13
  // Regression test for https://github.com/flutter/flutter/issues/87099
14
  testWidgetsWithLeakTracking('TextField.autofocus should skip the element that never layout', (WidgetTester tester) async {
15 16 17 18
    await tester.pumpWidget(
      MaterialApp(
        home: Scaffold(
          body: Navigator(
19
            pages: const <Page<void>>[_APage(), _BPage()],
20 21 22 23 24 25 26 27 28 29 30
            onPopPage: (Route<dynamic> route, dynamic result) {
              return false;
            },
          ),
        ),
      ),
    );

    expect(tester.takeException(), isNull);
  });

31
  testWidgetsWithLeakTracking('Dialog interaction', (WidgetTester tester) async {
32
    expect(tester.testTextInput.isVisible, isFalse);
33

34
    final FocusNode focusNode = FocusNode(debugLabel: 'Editable Text Node');
35
    addTearDown(focusNode.dispose);
36

37
    await tester.pumpWidget(
38
      MaterialApp(
39 40 41
        home: Material(
          child: Center(
            child: TextField(
42
              focusNode: focusNode,
43
              autofocus: true,
44 45 46 47 48 49
            ),
          ),
        ),
      ),
    );

50
    expect(tester.testTextInput.isVisible, isTrue);
51
    expect(focusNode.hasPrimaryFocus, isTrue);
52 53 54 55 56 57 58 59 60 61

    final BuildContext context = tester.element(find.byType(TextField));

    showDialog<void>(
      context: context,
      builder: (BuildContext context) => const SimpleDialog(title: Text('Dialog')),
    );

    await tester.pump();

62 63
    expect(tester.testTextInput.isVisible, isFalse);

64
    Navigator.of(tester.element(find.text('Dialog'))).pop();
65 66
    await tester.pump();

67
    expect(focusNode.hasPrimaryFocus, isTrue);
68 69
    expect(tester.testTextInput.isVisible, isTrue);

70
    await tester.pumpWidget(Container());
71 72 73 74

    expect(tester.testTextInput.isVisible, isFalse);
  });

75
  testWidgetsWithLeakTracking('Request focus shows keyboard', (WidgetTester tester) async {
76
    final FocusNode focusNode = FocusNode();
77
    addTearDown(focusNode.dispose);
78 79

    await tester.pumpWidget(
80
      MaterialApp(
81
        home: Material(
82 83
          child: Center(
            child: TextField(
84
              focusNode: focusNode,
85 86 87 88 89 90
            ),
          ),
        ),
      ),
    );

91 92 93 94 95
    expect(tester.testTextInput.isVisible, isFalse);

    FocusScope.of(tester.element(find.byType(TextField))).requestFocus(focusNode);
    await tester.idle();

96 97
    expect(tester.testTextInput.isVisible, isTrue);

98
    await tester.pumpWidget(Container());
99 100 101 102

    expect(tester.testTextInput.isVisible, isFalse);
  });

103
  testWidgetsWithLeakTracking('Autofocus shows keyboard', (WidgetTester tester) async {
104 105 106
    expect(tester.testTextInput.isVisible, isFalse);

    await tester.pumpWidget(
107 108
      const MaterialApp(
        home: Material(
109
          child: Center(
110 111 112
            child: TextField(
              autofocus: true,
            ),
113 114 115 116 117 118 119
          ),
        ),
      ),
    );

    expect(tester.testTextInput.isVisible, isTrue);

120
    await tester.pumpWidget(Container());
121 122 123 124

    expect(tester.testTextInput.isVisible, isFalse);
  });

125
  testWidgetsWithLeakTracking('Tap shows keyboard', (WidgetTester tester) async {
126 127 128
    expect(tester.testTextInput.isVisible, isFalse);

    await tester.pumpWidget(
129 130
      const MaterialApp(
        home: Material(
131
          child: Center(
132
            child: TextField(),
133 134 135 136 137
          ),
        ),
      ),
    );

138
    expect(tester.testTextInput.isVisible, isFalse);
139

140 141
    await tester.tap(find.byType(TextField));
    await tester.idle();
142

143
    expect(tester.testTextInput.isVisible, isTrue);
144 145 146
    // Prevent the gesture recognizer from recognizing the next tap as a
    // double-tap.
    await tester.pump(const Duration(seconds: 1));
147

148
    tester.testTextInput.hide();
149 150
    final EditableTextState state = tester.state<EditableTextState>(find.byType(EditableText));
    state.connectionClosed();
151 152 153 154

    expect(tester.testTextInput.isVisible, isFalse);

    await tester.tap(find.byType(TextField));
155
    await tester.idle();
156 157 158

    expect(tester.testTextInput.isVisible, isTrue);

159
    await tester.pumpWidget(Container());
160 161

    expect(tester.testTextInput.isVisible, isFalse);
162
  });
163

164
  testWidgetsWithLeakTracking('Focus triggers keep-alive', (WidgetTester tester) async {
165
    final FocusNode focusNode = FocusNode();
166
    addTearDown(focusNode.dispose);
167 168

    await tester.pumpWidget(
169 170 171
      MaterialApp(
        home: Material(
          child: ListView(
172
            children: <Widget>[
173
              TextField(
174 175
                focusNode: focusNode,
              ),
176
              Container(
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
                height: 1000.0,
              ),
            ],
          ),
        ),
      ),
    );

    expect(find.byType(TextField), findsOneWidget);
    expect(tester.testTextInput.isVisible, isFalse);

    FocusScope.of(tester.element(find.byType(TextField))).requestFocus(focusNode);
    await tester.pump();
    expect(find.byType(TextField), findsOneWidget);
    expect(tester.testTextInput.isVisible, isTrue);

193
    await tester.drag(find.byType(TextField), const Offset(0.0, -1000.0));
194
    await tester.pump();
195
    expect(find.byType(TextField, skipOffstage: false), findsOneWidget);
196 197 198 199 200 201 202 203 204
    expect(tester.testTextInput.isVisible, isTrue);

    focusNode.unfocus();
    await tester.pump();

    expect(find.byType(TextField), findsNothing);
    expect(tester.testTextInput.isVisible, isFalse);
  });

205
  testWidgetsWithLeakTracking('Focus keep-alive works with GlobalKey reparenting', (WidgetTester tester) async {
206
    final FocusNode focusNode = FocusNode();
207
    addTearDown(focusNode.dispose);
208

209
    Widget makeTest(String? prefix) {
210 211 212
      return MaterialApp(
        home: Material(
          child: ListView(
213
            children: <Widget>[
214
              TextField(
215
                focusNode: focusNode,
216
                decoration: InputDecoration(
217 218 219
                  prefixText: prefix,
                ),
              ),
220
              Container(
221 222 223 224 225 226 227 228 229 230 231 232
                height: 1000.0,
              ),
            ],
          ),
        ),
      );
    }

    await tester.pumpWidget(makeTest(null));
    FocusScope.of(tester.element(find.byType(TextField))).requestFocus(focusNode);
    await tester.pump();
    expect(find.byType(TextField), findsOneWidget);
233
    await tester.drag(find.byType(TextField), const Offset(0.0, -1000.0));
234
    await tester.pump();
235
    expect(find.byType(TextField, skipOffstage: false), findsOneWidget);
236 237
    await tester.pumpWidget(makeTest('test'));
    await tester.pump(); // in case the AutomaticKeepAlive widget thinks it needs a cleanup frame
238
    expect(find.byType(TextField, skipOffstage: false), findsOneWidget);
239
  });
Hans Muller's avatar
Hans Muller committed
240

241
  testWidgetsWithLeakTracking('TextField with decoration:null', (WidgetTester tester) async {
Hans Muller's avatar
Hans Muller committed
242 243 244
    // Regression test for https://github.com/flutter/flutter/issues/16880

    await tester.pumpWidget(
245 246
      const MaterialApp(
        home: Material(
247 248
          child: Center(
            child: TextField(
249
              decoration: null,
Hans Muller's avatar
Hans Muller committed
250 251 252 253 254 255 256 257
            ),
          ),
        ),
      ),
    );

    expect(tester.testTextInput.isVisible, isFalse);
    await tester.tap(find.byType(TextField));
258
    await tester.idle();
Hans Muller's avatar
Hans Muller committed
259 260
    expect(tester.testTextInput.isVisible, isTrue);
  });
261

262
  testWidgetsWithLeakTracking('Sibling FocusScopes', (WidgetTester tester) async {
263 264 265
    expect(tester.testTextInput.isVisible, isFalse);

    final FocusScopeNode focusScopeNode0 = FocusScopeNode();
266
    addTearDown(focusScopeNode0.dispose);
267
    final FocusScopeNode focusScopeNode1 = FocusScopeNode();
268 269
    addTearDown(focusScopeNode1.dispose);

270 271 272 273 274 275 276 277 278 279 280 281 282
    final Key textField0 = UniqueKey();
    final Key textField1 = UniqueKey();

    await tester.pumpWidget(
      MaterialApp(
        home: Scaffold(
          body: Center(
            child: Column(
              mainAxisSize: MainAxisSize.min,
              children: <Widget>[
                FocusScope(
                  node: focusScopeNode0,
                  child: Builder(
283
                    builder: (BuildContext context) => TextField(key: textField0),
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
                  ),
                ),
                FocusScope(
                  node: focusScopeNode1,
                  child: Builder(
                    builder: (BuildContext context) => TextField(key: textField1),
                  ),
                ),
              ],
            ),
          ),
        ),
      ),
    );

    expect(tester.testTextInput.isVisible, isFalse);

    await tester.tap(find.byKey(textField0));
    await tester.idle();
    expect(tester.testTextInput.isVisible, isTrue);

    tester.testTextInput.hide();
    expect(tester.testTextInput.isVisible, isFalse);

    await tester.tap(find.byKey(textField1));
    await tester.idle();
    expect(tester.testTextInput.isVisible, isTrue);

    await tester.tap(find.byKey(textField0));
    await tester.idle();
    expect(tester.testTextInput.isVisible, isTrue);

    await tester.tap(find.byKey(textField1));
    await tester.idle();
    expect(tester.testTextInput.isVisible, isTrue);

    tester.testTextInput.hide();
    expect(tester.testTextInput.isVisible, isFalse);

    await tester.tap(find.byKey(textField0));
    await tester.idle();
    expect(tester.testTextInput.isVisible, isTrue);

    await tester.pumpWidget(Container());
    expect(tester.testTextInput.isVisible, isFalse);
  });

331
  testWidgetsWithLeakTracking('Sibling Navigators', (WidgetTester tester) async {
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
    expect(tester.testTextInput.isVisible, isFalse);

    final Key textField0 = UniqueKey();
    final Key textField1 = UniqueKey();

    await tester.pumpWidget(
      MaterialApp(
        home: Scaffold(
          body: Center(
            child: Column(
              children: <Widget>[
                Expanded(
                  child: Navigator(
                    onGenerateRoute: (RouteSettings settings) {
                      return MaterialPageRoute<void>(
                        builder: (BuildContext context) {
                          return TextField(key: textField0);
                        },
                        settings: settings,
                      );
                    },
                  ),
                ),
                Expanded(
                  child: Navigator(
                    onGenerateRoute: (RouteSettings settings) {
                      return MaterialPageRoute<void>(
                        builder: (BuildContext context) {
                          return TextField(key: textField1);
                        },
                        settings: settings,
                      );
                    },
                  ),
                ),
              ],
            ),
          ),
        ),
      ),
    );

    expect(tester.testTextInput.isVisible, isFalse);

    await tester.tap(find.byKey(textField0));
    await tester.idle();
    expect(tester.testTextInput.isVisible, isTrue);

    tester.testTextInput.hide();
    expect(tester.testTextInput.isVisible, isFalse);

    await tester.tap(find.byKey(textField1));
    await tester.idle();
    expect(tester.testTextInput.isVisible, isTrue);

    await tester.tap(find.byKey(textField0));
    await tester.idle();
    expect(tester.testTextInput.isVisible, isTrue);

    await tester.tap(find.byKey(textField1));
    await tester.idle();
    expect(tester.testTextInput.isVisible, isTrue);

    tester.testTextInput.hide();
    expect(tester.testTextInput.isVisible, isFalse);

    await tester.tap(find.byKey(textField0));
    await tester.idle();
    expect(tester.testTextInput.isVisible, isTrue);

    await tester.pumpWidget(Container());
    expect(tester.testTextInput.isVisible, isFalse);
  });
405

406
  testWidgetsWithLeakTracking('A Focused text-field will lose focus when clicking outside of its hitbox with a mouse on desktop', (WidgetTester tester) async {
407
    final FocusNode focusNodeA = FocusNode();
408
    addTearDown(focusNodeA.dispose);
409
    final FocusNode focusNodeB = FocusNode();
410 411
    addTearDown(focusNodeB.dispose);

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
    final Key key = UniqueKey();

    await tester.pumpWidget(
      MaterialApp(
        home: Material(
          child: ListView(
            children: <Widget>[
              TextField(
                focusNode: focusNodeA,
              ),
              Container(
                key: key,
                height: 200,
              ),
              TextField(
                focusNode: focusNodeB,
              ),
            ],
          ),
        ),
      ),
    );

    final TestGesture down1 = await tester.startGesture(tester.getCenter(find.byType(TextField).first), kind: PointerDeviceKind.mouse);
    await tester.pump();
    await tester.pumpAndSettle();
    await down1.up();
    await down1.removePointer();

    expect(focusNodeA.hasFocus, true);
    expect(focusNodeB.hasFocus, false);

    // Click on the container to not hit either text field.
    final TestGesture down2 = await tester.startGesture(tester.getCenter(find.byKey(key)), kind: PointerDeviceKind.mouse);
    await tester.pump();
    await tester.pumpAndSettle();
    await down2.up();
    await down2.removePointer();

    expect(focusNodeA.hasFocus, false);
    expect(focusNodeB.hasFocus, false);

    // Second text field can still gain focus.

    final TestGesture down3 = await tester.startGesture(tester.getCenter(find.byType(TextField).last), kind: PointerDeviceKind.mouse);
    await tester.pump();
    await tester.pumpAndSettle();
    await down3.up();
    await down3.removePointer();

    expect(focusNodeA.hasFocus, false);
    expect(focusNodeB.hasFocus, true);
  }, variant: TargetPlatformVariant.desktop());
465

466
  testWidgetsWithLeakTracking('A Focused text-field will not lose focus when clicking on its decoration', (WidgetTester tester) async {
467
    final FocusNode focusNodeA = FocusNode();
468
    addTearDown(focusNodeA.dispose);
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 499 500 501 502 503
    final Key iconKey = UniqueKey();

    await tester.pumpWidget(
      MaterialApp(
        home: Material(
          child: ListView(
            children: <Widget>[
              TextField(
                focusNode: focusNodeA,
                decoration: InputDecoration(
                  icon: Icon(Icons.copy_all, key: iconKey),
                ),
              ),
            ],
          ),
        ),
      ),
    );

    final TestGesture down1 = await tester.startGesture(tester.getCenter(find.byType(TextField).first), kind: PointerDeviceKind.mouse);
    await tester.pump();
    await down1.removePointer();

    expect(focusNodeA.hasFocus, true);

    // Click on the icon which has a different RO than the text field's focus node context
    final TestGesture down2 = await tester.startGesture(tester.getCenter(find.byKey(iconKey)), kind: PointerDeviceKind.mouse);
    await tester.pump();
    await tester.pumpAndSettle();
    await down2.up();
    await down2.removePointer();

    expect(focusNodeA.hasFocus, true);
  }, variant: TargetPlatformVariant.desktop());

504
  testWidgetsWithLeakTracking('A Focused text-field will lose focus when clicking outside of its hitbox with a mouse on desktop after tab navigation', (WidgetTester tester) async {
505
    final FocusNode focusNodeA = FocusNode(debugLabel: 'A');
506
    addTearDown(focusNodeA.dispose);
507
    final FocusNode focusNodeB = FocusNode(debugLabel: 'B');
508 509
    addTearDown(focusNodeB.dispose);

510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
    final Key key = UniqueKey();

    await tester.pumpWidget(
      MaterialApp(
        home: Material(
          child: ListView(
            children: <Widget>[
              const TextField(),
              const TextField(),
              TextField(
                focusNode: focusNodeA,
              ),
              Container(
                key: key,
                height: 200,
              ),
              TextField(
                focusNode: focusNodeB,
              ),
            ],
          ),
        ),
      ),
    );
    // Tab over to the 3rd text field.
    for (int i = 0; i < 3; i += 1) {
536 537 538 539 540 541 542 543 544 545 546
      await tester.sendKeyEvent(LogicalKeyboardKey.tab);
      await tester.pump();
    }

    Future<void> click(Finder finder) async {
      final TestGesture gesture = await tester.startGesture(
        tester.getCenter(finder),
        kind: PointerDeviceKind.mouse,
      );
      await gesture.up();
      await gesture.removePointer();
547 548 549 550 551 552
    }

    expect(focusNodeA.hasFocus, true);
    expect(focusNodeB.hasFocus, false);

    // Click on the container to not hit either text field.
553
    await click(find.byKey(key));
554 555 556 557 558 559 560
    await tester.pump();

    expect(focusNodeA.hasFocus, false);
    expect(focusNodeB.hasFocus, false);

    // Second text field can still gain focus.

561
    await click(find.byType(TextField).last);
562 563 564 565 566
    await tester.pump();

    expect(focusNodeA.hasFocus, false);
    expect(focusNodeB.hasFocus, true);
  }, variant: TargetPlatformVariant.desktop());
567
}
568 569

class _APage extends Page<void> {
570 571
  const _APage();

572 573 574 575 576 577 578 579
  @override
  Route<void> createRoute(BuildContext context) => PageRouteBuilder<void>(
    settings: this,
    pageBuilder: (_, __, ___) => const TextField(autofocus: true),
  );
}

class _BPage extends Page<void> {
580 581
  const _BPage();

582 583 584 585 586 587
  @override
  Route<void> createRoute(BuildContext context) => PageRouteBuilder<void>(
    settings: this,
    pageBuilder: (_, __, ___) => const Text('B'),
  );
}