ink_paint_test.dart 16.5 KB
Newer Older
1 2 3 4
// Copyright 2017 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

5
import 'package:flutter/foundation.dart';
6 7
import 'package:flutter/material.dart';
import 'package:flutter/rendering.dart';
8
import 'package:flutter/services.dart';
9 10 11 12 13
import 'package:flutter_test/flutter_test.dart';

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

void main() {
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
  testWidgets('The Ink widget renders a Container by default', (WidgetTester tester) async {
    await tester.pumpWidget(
      Material(
        child: Ink(),
      ),
    );
    expect(tester.getSize(find.byType(Container)).height, 600.0);
    expect(tester.getSize(find.byType(Container)).width, 800.0);

    const double height = 150.0;
    const double width = 200.0;
    await tester.pumpWidget(
      Material(
        child: Center( // used to constrain to child's size
          child: Ink(
            height: height,
            width: width,
          ),
        ),
      ),
    );
    await tester.pumpAndSettle();
    expect(tester.getSize(find.byType(Container)).height, height);
    expect(tester.getSize(find.byType(Container)).width, width);
  });

Ian Hickson's avatar
Ian Hickson committed
40
  testWidgets('The InkWell widget renders an ink splash', (WidgetTester tester) async {
41 42
    const Color highlightColor = Color(0xAAFF0000);
    const Color splashColor = Color(0xAA0000FF);
43
    final BorderRadius borderRadius = BorderRadius.circular(6.0);
44 45

    await tester.pumpWidget(
46
      Directionality(
47
        textDirection: TextDirection.ltr,
48 49 50
        child: Material(
          child: Center(
            child: Container(
51 52
              width: 200.0,
              height: 60.0,
53
              child: InkWell(
54 55 56 57 58
                borderRadius: borderRadius,
                highlightColor: highlightColor,
                splashColor: splashColor,
                onTap: () { },
              ),
59 60 61 62 63 64
            ),
          ),
        ),
      ),
    );

65
    final Offset center = tester.getCenter(find.byType(InkWell));
66 67
    final TestGesture gesture = await tester.startGesture(center);
    await tester.pump(); // start gesture
68
    await tester.pump(const Duration(milliseconds: 200)); // wait for splash to be well under way
69

70
    final RenderBox box = Material.of(tester.element(find.byType(InkWell))) as dynamic;
71 72 73
    expect(
      box,
      paints
74 75 76
        ..translate(x: 0.0, y: 0.0)
        ..save()
        ..translate(x: 300.0, y: 270.0)
77
        ..clipRRect(rrect: RRect.fromLTRBR(0.0, 0.0, 200.0, 60.0, const Radius.circular(6.0)))
78 79
        ..circle(x: 100.0, y: 30.0, radius: 21.0, color: splashColor)
        ..restore()
80
        ..rrect(
81
          rrect: RRect.fromLTRBR(300.0, 270.0, 500.0, 330.0, const Radius.circular(6.0)),
82
          color: highlightColor,
83
        ),
84 85 86 87
    );

    await gesture.up();
  });
88

Ian Hickson's avatar
Ian Hickson committed
89
  testWidgets('The InkWell widget renders an ink ripple', (WidgetTester tester) async {
90 91
    const Color highlightColor = Color(0xAAFF0000);
    const Color splashColor = Color(0xB40000FF);
92
    final BorderRadius borderRadius = BorderRadius.circular(6.0);
93 94

    await tester.pumpWidget(
95
      Directionality(
96
        textDirection: TextDirection.ltr,
97 98 99
        child: Material(
          child: Center(
            child: Container(
100 101
              width: 100.0,
              height: 100.0,
102
              child: InkWell(
103 104 105 106 107 108 109
                borderRadius: borderRadius,
                highlightColor: highlightColor,
                splashColor: splashColor,
                onTap: () { },
                radius: 100.0,
                splashFactory: InkRipple.splashFactory,
              ),
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
            ),
          ),
        ),
      ),
    );

    final Offset tapDownOffset = tester.getTopLeft(find.byType(InkWell));
    final Offset inkWellCenter = tester.getCenter(find.byType(InkWell));
    //final TestGesture gesture = await tester.startGesture(tapDownOffset);
    await tester.tapAt(tapDownOffset);
    await tester.pump(); // start gesture

    final RenderBox box = Material.of(tester.element(find.byType(InkWell))) as dynamic;

    bool offsetsAreClose(Offset a, Offset b) => (a - b).distance < 1.0;
    bool radiiAreClose(double a, double b) => (a - b).abs() < 1.0;

127 128 129 130 131
    PaintPattern ripplePattern(Offset expectedCenter, double expectedRadius, int expectedAlpha) {
      return paints
        ..translate(x: 0.0, y: 0.0)
        ..translate(x: tapDownOffset.dx, y: tapDownOffset.dy)
        ..something((Symbol method, List<dynamic> arguments) {
132
          if (method != #drawCircle)
133 134 135 136
            return false;
          final Offset center = arguments[0];
          final double radius = arguments[1];
          final Paint paint = arguments[2];
137
          if (offsetsAreClose(center, expectedCenter) && radiiAreClose(radius, expectedRadius) && paint.color.alpha == expectedAlpha)
138 139 140 141
            return true;
          throw '''
            Expected: center == $expectedCenter, radius == $expectedRadius, alpha == $expectedAlpha
            Found: center == $center radius == $radius alpha == ${paint.color.alpha}''';
142
        }
143 144 145
      );
    }

Ian Hickson's avatar
Ian Hickson committed
146
    // Initially the ripple's center is where the tap occurred;
147 148
    // ripplePattern always add a translation of tapDownOffset.
    expect(box, ripplePattern(Offset.zero, 30.0, 0));
149 150

    // The ripple fades in for 75ms. During that time its alpha is eased from
151
    // 0 to the splashColor's alpha value and its center moves towards the
152 153
    // center of the ink well.
    await tester.pump(const Duration(milliseconds: 50));
154
    expect(box, ripplePattern(const Offset(17.0, 17.0), 56.0, 120));
155 156 157 158

    // At 75ms the ripple has fade in: it's alpha matches the splashColor's
    // alpha and its center has moved closer to the ink well's center.
    await tester.pump(const Duration(milliseconds: 25));
159
    expect(box, ripplePattern(const Offset(29.0, 29.0), 73.0, 180));
160 161 162 163

    // At this point the splash radius has expanded to its limit: 5 past the
    // ink well's radius parameter. The splash center has moved to its final
    // location at the inkwell's center and the fade-out is about to start.
164 165
    // The fade-out begins at 225ms = 50ms + 25ms + 150ms.
    await tester.pump(const Duration(milliseconds: 150));
166
    expect(box, ripplePattern(inkWellCenter - tapDownOffset, 105.0, 180));
167 168 169

    // After another 150ms the fade-out is complete.
    await tester.pump(const Duration(milliseconds: 150));
170
    expect(box, ripplePattern(inkWellCenter - tapDownOffset, 105.0, 0));
Ian Hickson's avatar
Ian Hickson committed
171 172 173 174
  });

  testWidgets('Does the Ink widget render anything', (WidgetTester tester) async {
    await tester.pumpWidget(
175
      Directionality(
176
        textDirection: TextDirection.ltr,
177 178 179
        child: Material(
          child: Center(
            child: Ink(
180 181 182
              color: Colors.blue,
              width: 200.0,
              height: 200.0,
183
              child: InkWell(
184 185 186
                splashColor: Colors.green,
                onTap: () { },
              ),
Ian Hickson's avatar
Ian Hickson committed
187 188 189 190 191
            ),
          ),
        ),
      ),
    );
192

Ian Hickson's avatar
Ian Hickson committed
193 194 195 196 197 198 199 200 201
    final Offset center = tester.getCenter(find.byType(InkWell));
    final TestGesture gesture = await tester.startGesture(center);
    await tester.pump(); // start gesture
    await tester.pump(const Duration(milliseconds: 200)); // wait for splash to be well under way

    final RenderBox box = Material.of(tester.element(find.byType(InkWell))) as dynamic;
    expect(
      box,
      paints
Dan Field's avatar
Dan Field committed
202
        ..rect(rect: const Rect.fromLTRB(300.0, 200.0, 500.0, 400.0), color: Color(Colors.blue.value))
203
        ..circle(color: Color(Colors.green.value)),
Ian Hickson's avatar
Ian Hickson committed
204 205 206
    );

    await tester.pumpWidget(
207
      Directionality(
208
        textDirection: TextDirection.ltr,
209 210 211
        child: Material(
          child: Center(
            child: Ink(
212 213 214
              color: Colors.red,
              width: 200.0,
              height: 200.0,
215
              child: InkWell(
216 217 218
                splashColor: Colors.green,
                onTap: () { },
              ),
Ian Hickson's avatar
Ian Hickson committed
219 220 221 222 223 224 225 226 227 228 229
            ),
          ),
        ),
      ),
    );

    expect(Material.of(tester.element(find.byType(InkWell))), same(box));

    expect(
      box,
      paints
Dan Field's avatar
Dan Field committed
230
        ..rect(rect: const Rect.fromLTRB(300.0, 200.0, 500.0, 400.0), color: Color(Colors.red.value))
231
        ..circle(color: Color(Colors.green.value)),
Ian Hickson's avatar
Ian Hickson committed
232 233 234
    );

    await tester.pumpWidget(
235
      Directionality(
236
        textDirection: TextDirection.ltr,
237 238 239
        child: Material(
          child: Center(
            child: InkWell( // this is at a different depth in the tree so it's now a new InkWell
240 241 242
              splashColor: Colors.green,
              onTap: () { },
            ),
Ian Hickson's avatar
Ian Hickson committed
243 244 245 246 247 248 249 250 251 252 253
          ),
        ),
      ),
    );

    expect(Material.of(tester.element(find.byType(InkWell))), same(box));

    expect(box, isNot(paints..rect()));
    expect(box, isNot(paints..circle()));

    await gesture.up();
254
  }, skip: isBrowser);
255

256
  testWidgets('The InkWell widget renders an SelectAction or ActivateAction-induced ink ripple', (WidgetTester tester) async {
257 258 259 260 261
    const Color highlightColor = Color(0xAAFF0000);
    const Color splashColor = Color(0xB40000FF);
    final BorderRadius borderRadius = BorderRadius.circular(6.0);

    final FocusNode focusNode = FocusNode(debugLabel: 'Test Node');
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
    Future<void> buildTest(Key actionKey) async {
      return await tester.pumpWidget(
        Shortcuts(
          shortcuts: <LogicalKeySet, Intent>{
            LogicalKeySet(LogicalKeyboardKey.space): Intent(actionKey),
          },
          child: Directionality(
            textDirection: TextDirection.ltr,
            child: Material(
              child: Center(
                child: Container(
                  width: 100.0,
                  height: 100.0,
                  child: InkWell(
                    borderRadius: borderRadius,
                    highlightColor: highlightColor,
                    splashColor: splashColor,
                    focusNode: focusNode,
                    onTap: () { },
                    radius: 100.0,
                    splashFactory: InkRipple.splashFactory,
                  ),
284 285 286 287 288
                ),
              ),
            ),
          ),
        ),
289 290
      );
    }
291

292
    await buildTest(ActivateAction.key);
293 294 295
    focusNode.requestFocus();
    await tester.pumpAndSettle();

296 297
    final Offset topLeft = tester.getTopLeft(find.byType(InkWell));
    final Offset inkWellCenter = tester.getCenter(find.byType(InkWell)) - topLeft;
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

    bool offsetsAreClose(Offset a, Offset b) => (a - b).distance < 1.0;
    bool radiiAreClose(double a, double b) => (a - b).abs() < 1.0;

    PaintPattern ripplePattern(double expectedRadius, int expectedAlpha) {
      return paints
        ..translate(x: 0.0, y: 0.0)
        ..translate(x: topLeft.dx, y: topLeft.dy)
        ..something((Symbol method, List<dynamic> arguments) {
          if (method != #drawCircle) {
            return false;
          }
          final Offset center = arguments[0];
          final double radius = arguments[1];
          final Paint paint = arguments[2];
          if (offsetsAreClose(center, inkWellCenter) &&
              radiiAreClose(radius, expectedRadius) &&
              paint.color.alpha == expectedAlpha) {
            return true;
          }
          throw '''
            Expected: center == $inkWellCenter, radius == $expectedRadius, alpha == $expectedAlpha
            Found: center == $center radius == $radius alpha == ${paint.color.alpha}''';
        },
        );
    }

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
    // Now activate it with a keypress.
    await tester.sendKeyEvent(LogicalKeyboardKey.space);
    await tester.pump();

    RenderBox box = Material.of(tester.element(find.byType(InkWell))) as dynamic;

    if (kIsWeb) {
      expect(box, isNot(ripplePattern(30.0, 0)));
    } else {
      // ripplePattern always add a translation of topLeft.
      expect(box, ripplePattern(30.0, 0));

      // The ripple fades in for 75ms. During that time its alpha is eased from
      // 0 to the splashColor's alpha value.
      await tester.pump(const Duration(milliseconds: 50));
      expect(box, ripplePattern(56.0, 120));

      // At 75ms the ripple has faded in: it's alpha matches the splashColor's
      // alpha.
      await tester.pump(const Duration(milliseconds: 25));
      expect(box, ripplePattern(73.0, 180));

      // At this point the splash radius has expanded to its limit: 5 past the
      // ink well's radius parameter. The fade-out is about to start.
      // The fade-out begins at 225ms = 50ms + 25ms + 150ms.
      await tester.pump(const Duration(milliseconds: 150));
      expect(box, ripplePattern(105.0, 180));

      // After another 150ms the fade-out is complete.
      await tester.pump(const Duration(milliseconds: 150));
      expect(box, ripplePattern(105.0, 0));
    }

    // Now try it with a select action instead.
    await buildTest(SelectAction.key);
    await tester.pumpAndSettle();
    await tester.sendKeyEvent(LogicalKeyboardKey.space);
    await tester.pump();

    box = Material.of(tester.element(find.byType(InkWell))) as dynamic;

366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
    // ripplePattern always add a translation of topLeft.
    expect(box, ripplePattern(30.0, 0));

    // The ripple fades in for 75ms. During that time its alpha is eased from
    // 0 to the splashColor's alpha value.
    await tester.pump(const Duration(milliseconds: 50));
    expect(box, ripplePattern(56.0, 120));

    // At 75ms the ripple has faded in: it's alpha matches the splashColor's
    // alpha.
    await tester.pump(const Duration(milliseconds: 25));
    expect(box, ripplePattern(73.0, 180));

    // At this point the splash radius has expanded to its limit: 5 past the
    // ink well's radius parameter. The fade-out is about to start.
    // The fade-out begins at 225ms = 50ms + 25ms + 150ms.
    await tester.pump(const Duration(milliseconds: 150));
    expect(box, ripplePattern(105.0, 180));

    // After another 150ms the fade-out is complete.
    await tester.pump(const Duration(milliseconds: 150));
    expect(box, ripplePattern(105.0, 0));
  });

390 391 392
  testWidgets('Cancel an InkRipple that was disposed when its animation ended', (WidgetTester tester) async {
    // Regression test for https://github.com/flutter/flutter/issues/14391
    await tester.pumpWidget(
393
      Directionality(
394
        textDirection: TextDirection.ltr,
395 396 397
        child: Material(
          child: Center(
            child: Container(
398 399
              width: 100.0,
              height: 100.0,
400
              child: InkWell(
401 402 403 404
                onTap: () { },
                radius: 100.0,
                splashFactory: InkRipple.splashFactory,
              ),
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
            ),
          ),
        ),
      ),
    );

    final Offset tapDownOffset = tester.getTopLeft(find.byType(InkWell));
    await tester.tapAt(tapDownOffset);
    await tester.pump(); // start splash
    await tester.pump(const Duration(milliseconds: 375)); // _kFadeOutDuration, in_ripple.dart

    final TestGesture gesture = await tester.startGesture(tapDownOffset);
    await tester.pump(); // start gesture
    await gesture.moveTo(const Offset(0.0, 0.0));
    await gesture.up(); // generates a tap cancel
    await tester.pumpAndSettle();
  });
422 423

  testWidgets('Cancel an InkRipple that was disposed when its animation ended', (WidgetTester tester) async {
424 425
    const Color highlightColor = Color(0xAAFF0000);
    const Color splashColor = Color(0xB40000FF);
426 427 428

    // Regression test for https://github.com/flutter/flutter/issues/14391
    await tester.pumpWidget(
429
      Directionality(
430
        textDirection: TextDirection.ltr,
431 432 433
        child: Material(
          child: Center(
            child: Container(
434 435
              width: 100.0,
              height: 100.0,
436
              child: InkWell(
437 438 439 440 441 442
                splashColor: splashColor,
                highlightColor: highlightColor,
                onTap: () { },
                radius: 100.0,
                splashFactory: InkRipple.splashFactory,
              ),
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
            ),
          ),
        ),
      ),
    );

    final Offset tapDownOffset = tester.getTopLeft(find.byType(InkWell));
    await tester.tapAt(tapDownOffset);
    await tester.pump(); // start splash
    // No delay here so _fadeInController.value=1.0 (InkRipple.dart)

    // Generate a tap cancel; Will cancel the ink splash before it started
    final TestGesture gesture = await tester.startGesture(tapDownOffset);
    await tester.pump(); // start gesture
    await gesture.moveTo(const Offset(0.0, 0.0));
    await gesture.up(); // generates a tap cancel

    final RenderBox box = Material.of(tester.element(find.byType(InkWell))) as dynamic;
    expect(box, paints..everything((Symbol method, List<dynamic> arguments) {
      if (method != #drawCircle)
        return true;
      final Paint paint = arguments[2];
      if (paint.color.alpha == 0)
        return true;
      throw 'Expected: paint.color.alpha == 0, found: ${paint.color.alpha}';
    }));
  });
470
}