scroll_controller_test.dart 11.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
// 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.

import 'package:flutter_test/flutter_test.dart';
import 'package:flutter/widgets.dart';

import 'states.dart';

void main() {
  testWidgets('ScrollController control test', (WidgetTester tester) async {
12
    final ScrollController controller = new ScrollController();
13

14 15 16 17 18 19 20 21 22 23 24 25 26 27
    await tester.pumpWidget(
      new Directionality(
        textDirection: TextDirection.ltr,
        child: new ListView(
          controller: controller,
          children: kStates.map<Widget>((String state) {
            return new Container(
              height: 200.0,
              child: new Text(state),
            );
          }).toList(),
        ),
      ),
    );
28 29

    double realOffset() {
Adam Barth's avatar
Adam Barth committed
30
      return tester.state<ScrollableState>(find.byType(Scrollable)).position.pixels;
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
    }

    expect(controller.offset, equals(0.0));
    expect(realOffset(), equals(controller.offset));

    controller.jumpTo(653.0);

    expect(controller.offset, equals(653.0));
    expect(realOffset(), equals(controller.offset));

    await tester.pump();

    expect(controller.offset, equals(653.0));
    expect(realOffset(), equals(controller.offset));

    controller.animateTo(326.0, duration: const Duration(milliseconds: 300), curve: Curves.ease);
47
    await tester.pumpAndSettle(const Duration(milliseconds: 100));
48 49 50 51

    expect(controller.offset, equals(326.0));
    expect(realOffset(), equals(controller.offset));

52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
    await tester.pumpWidget(
      new Directionality(
        textDirection: TextDirection.ltr,
        child: new ListView(
          key: const Key('second'),
          controller: controller,
          children: kStates.map<Widget>((String state) {
            return new Container(
              height: 200.0,
              child: new Text(state),
            );
          }).toList(),
        ),
      ),
    );
67 68 69 70 71 72 73 74 75

    expect(controller.offset, equals(0.0));
    expect(realOffset(), equals(controller.offset));

    controller.jumpTo(653.0);

    expect(controller.offset, equals(653.0));
    expect(realOffset(), equals(controller.offset));

76
    final ScrollController controller2 = new ScrollController();
77

78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
    await tester.pumpWidget(
      new Directionality(
        textDirection: TextDirection.ltr,
        child: new ListView(
          key: const Key('second'),
          controller: controller2,
          children: kStates.map<Widget>((String state) {
            return new Container(
              height: 200.0,
              child: new Text(state),
            );
          }).toList(),
        ),
      ),
    );
93

94
    expect(() => controller.offset, throwsAssertionError);
95 96 97
    expect(controller2.offset, equals(653.0));
    expect(realOffset(), equals(controller2.offset));

98 99
    expect(() => controller.jumpTo(120.0), throwsAssertionError);
    expect(() => controller.animateTo(132.0, duration: const Duration(milliseconds: 300), curve: Curves.ease), throwsAssertionError);
100

101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
    await tester.pumpWidget(
      new Directionality(
        textDirection: TextDirection.ltr,
        child: new ListView(
          key: const Key('second'),
          controller: controller2,
          physics: const BouncingScrollPhysics(),
          children: kStates.map<Widget>((String state) {
            return new Container(
              height: 200.0,
              child: new Text(state),
            );
          }).toList(),
        ),
      ),
    );
117 118 119 120 121 122 123 124 125 126 127 128 129 130

    expect(controller2.offset, equals(653.0));
    expect(realOffset(), equals(controller2.offset));

    controller2.jumpTo(432.0);

    expect(controller2.offset, equals(432.0));
    expect(realOffset(), equals(controller2.offset));

    await tester.pump();

    expect(controller2.offset, equals(432.0));
    expect(realOffset(), equals(controller2.offset));
  });
131 132

  testWidgets('ScrollController control test', (WidgetTester tester) async {
133
    final ScrollController controller = new ScrollController(
134 135 136
      initialScrollOffset: 209.0,
    );

137 138 139 140 141 142 143 144 145 146
    await tester.pumpWidget(
      new Directionality(
        textDirection: TextDirection.ltr,
        child: new GridView.count(
          crossAxisCount: 4,
          controller: controller,
          children: kStates.map<Widget>((String state) => new Text(state)).toList(),
        ),
      ),
    );
147 148

    double realOffset() {
Adam Barth's avatar
Adam Barth committed
149
      return tester.state<ScrollableState>(find.byType(Scrollable)).position.pixels;
150 151 152 153 154 155 156 157 158 159 160 161
    }

    expect(controller.offset, equals(209.0));
    expect(realOffset(), equals(controller.offset));

    controller.jumpTo(105.0);

    await tester.pump();

    expect(controller.offset, equals(105.0));
    expect(realOffset(), equals(controller.offset));

162 163 164 165 166 167 168 169 170 171
    await tester.pumpWidget(
      new Directionality(
        textDirection: TextDirection.ltr,
        child: new GridView.count(
          crossAxisCount: 2,
          controller: controller,
          children: kStates.map<Widget>((String state) => new Text(state)).toList(),
        ),
      ),
    );
172 173 174 175

    expect(controller.offset, equals(105.0));
    expect(realOffset(), equals(controller.offset));
  });
176 177

  testWidgets('DrivenScrollActivity ending after dispose', (WidgetTester tester) async {
178
    final ScrollController controller = new ScrollController();
179

180 181 182 183 184 185 186 187 188
    await tester.pumpWidget(
      new Directionality(
        textDirection: TextDirection.ltr,
        child: new ListView(
          controller: controller,
          children: <Widget>[ new Container(height: 200000.0) ],
        ),
      ),
    );
189 190 191 192 193 194 195 196 197

    controller.animateTo(1000.0, duration: const Duration(seconds: 1), curve: Curves.linear);

    await tester.pump(); // Start the animation.

    // We will now change the tree on the same frame as the animation ends.
    await tester.pumpWidget(new Container(), const Duration(seconds: 2));
  });

198
  testWidgets('Read operations on ScrollControllers with no positions fail', (WidgetTester tester) async {
199
    final ScrollController controller = new ScrollController();
200 201 202 203 204
    expect(() => controller.offset, throwsAssertionError);
    expect(() => controller.position, throwsAssertionError);
  });

  testWidgets('Read operations on ScrollControllers with more than one position fail', (WidgetTester tester) async {
205
    final ScrollController controller = new ScrollController();
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
    await tester.pumpWidget(
      new Directionality(
        textDirection: TextDirection.ltr,
        child: new ListView(
          children: <Widget>[
            new Container(
              constraints: const BoxConstraints(maxHeight: 500.0),
              child: new ListView(
                controller: controller,
                children: kStates.map<Widget>((String state) {
                  return new Container(height: 200.0, child: new Text(state));
                }).toList(),
              ),
            ),
            new Container(
              constraints: const BoxConstraints(maxHeight: 500.0),
              child: new ListView(
                controller: controller,
                children: kStates.map<Widget>((String state) {
                  return new Container(height: 200.0, child: new Text(state));
                }).toList(),
              ),
            ),
          ],
230
        ),
231 232
      ),
    );
233 234 235 236 237 238

    expect(() => controller.offset, throwsAssertionError);
    expect(() => controller.position, throwsAssertionError);
  });

  testWidgets('Write operations on ScrollControllers with no positions fail', (WidgetTester tester) async {
239
    final ScrollController controller = new ScrollController();
240 241 242 243
    expect(() => controller.animateTo(1.0, duration: const Duration(seconds: 1), curve: Curves.linear), throwsAssertionError);
    expect(() => controller.jumpTo(1.0), throwsAssertionError);
  });

244
  testWidgets('Write operations on ScrollControllers with more than one position do not throw', (WidgetTester tester) async {
245
    final ScrollController controller = new ScrollController();
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
    await tester.pumpWidget(
      new Directionality(
        textDirection: TextDirection.ltr,
        child: new ListView(
          children: <Widget>[
            new Container(
              constraints: const BoxConstraints(maxHeight: 500.0),
              child: new ListView(
                controller: controller,
                children: kStates.map<Widget>((String state) {
                  return new Container(height: 200.0, child: new Text(state));
                }).toList(),
              ),
            ),
            new Container(
              constraints: const BoxConstraints(maxHeight: 500.0),
              child: new ListView(
                controller: controller,
                children: kStates.map<Widget>((String state) {
                  return new Container(height: 200.0, child: new Text(state));
                }).toList(),
              ),
            ),
          ],
270
        ),
271 272
      ),
    );
273

274 275
    controller.jumpTo(1.0);
    controller.animateTo(1.0, duration: const Duration(seconds: 1), curve: Curves.linear);
276
    await tester.pumpAndSettle();
277
  });
278 279 280 281 282 283 284 285 286 287

  testWidgets('Scroll controllers notify when the position changes', (WidgetTester tester) async {
    final ScrollController controller = new ScrollController();

    final List<double> log = <double>[];

    controller.addListener(() {
      log.add(controller.offset);
    });

288 289 290 291 292 293 294 295 296 297 298
    await tester.pumpWidget(
      new Directionality(
        textDirection: TextDirection.ltr,
        child: new ListView(
          controller: controller,
          children: kStates.map<Widget>((String state) {
            return new Container(height: 200.0, child: new Text(state));
          }).toList(),
        ),
      ),
    );
299 300 301 302 303 304 305 306 307 308 309 310 311

    expect(log, isEmpty);

    await tester.drag(find.byType(ListView), const Offset(0.0, -250.0));

    expect(log, equals(<double>[ 250.0 ]));
    log.clear();

    controller.dispose();

    await tester.drag(find.byType(ListView), const Offset(0.0, -130.0));
    expect(log, isEmpty);
  });
312 313 314 315 316

  testWidgets('keepScrollOffset', (WidgetTester tester) async {
    final PageStorageBucket bucket = new PageStorageBucket();

    Widget buildFrame(ScrollController controller) {
317 318 319 320 321 322 323 324 325 326 327 328 329
      return new Directionality(
        textDirection: TextDirection.ltr,
        child: new PageStorage(
          bucket: bucket,
          child: new KeyedSubtree(
            key: const PageStorageKey<String>('ListView'),
            child: new ListView(
              key: new UniqueKey(), // it's a different ListView every time
              controller: controller,
              children: new List<Widget>.generate(50, (int index) {
                return new Container(height: 100.0, child: new Text('Item $index'));
              }).toList(),
            ),
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
        ),
      );
    }

    // keepScrollOffset: true (the default). The scroll offset is restored
    // when the ListView is recreated with a new ScrollController.

    // The initialScrollOffset is used in this case, because there's no saved
    // scroll offset.
    ScrollController controller = new ScrollController(initialScrollOffset: 200.0);
    await tester.pumpWidget(buildFrame(controller));
    expect(tester.getTopLeft(find.widgetWithText(Container, 'Item 2')), Offset.zero);

    controller.jumpTo(2000.0);
    await tester.pump();
    expect(tester.getTopLeft(find.widgetWithText(Container, 'Item 20')), Offset.zero);

    // The initialScrollOffset isn't used in this case, because the scrolloffset
    // can be restored.
    controller = new ScrollController(initialScrollOffset: 25.0);
    await tester.pumpWidget(buildFrame(controller));
    expect(controller.offset, 2000.0);
    expect(tester.getTopLeft(find.widgetWithText(Container, 'Item 20')), Offset.zero);

    // keepScrollOffset: false. The scroll offset is -not- restored
    // when the ListView is recreated with a new ScrollController and
    // the initialScrollOffset is used.

    controller = new ScrollController(keepScrollOffset: false, initialScrollOffset: 100.0);
    await tester.pumpWidget(buildFrame(controller));
    expect(controller.offset, 100.0);
    expect(tester.getTopLeft(find.widgetWithText(Container, 'Item 1')), Offset.zero);

  });
365
}