tab_scaffold.dart 20.9 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4 5
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

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

7
import 'bottom_tab_bar.dart';
8
import 'colors.dart';
xster's avatar
xster committed
9
import 'theme.dart';
10

11 12 13 14 15 16 17
/// Coordinates tab selection between a [CupertinoTabBar] and a [CupertinoTabScaffold].
///
/// The [index] property is the index of the selected tab. Changing its value
/// updates the actively displayed tab of the [CupertinoTabScaffold] the
/// [CupertinoTabController] controls, as well as the currently selected tab item of
/// its [CupertinoTabBar].
///
18
/// {@tool snippet}
19 20
/// This samples shows how [CupertinoTabController] can be used to switch tabs in
/// [CupertinoTabScaffold].
21
///
22
/// ** See code in examples/api/lib/cupertino/tab_scaffold/cupertino_tab_controller.0.dart **
23 24 25 26
/// {@end-tool}
///
/// See also:
///
27 28
///  * [CupertinoTabScaffold], a tabbed application root layout that can be
///    controlled by a [CupertinoTabController].
29 30
///  * [RestorableCupertinoTabController], which is a restorable version
///    of this controller.
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
class CupertinoTabController extends ChangeNotifier {
  /// Creates a [CupertinoTabController] to control the tab index of [CupertinoTabScaffold]
  /// and [CupertinoTabBar].
  ///
  /// The [initialIndex] must not be null and defaults to 0. The value must be
  /// greater than or equal to 0, and less than the total number of tabs.
  CupertinoTabController({ int initialIndex = 0 })
    : _index = initialIndex,
      assert(initialIndex != null),
      assert(initialIndex >= 0);

  bool _isDisposed = false;

  /// The index of the currently selected tab.
  ///
  /// Changing the value of [index] updates the actively displayed tab of the
  /// [CupertinoTabScaffold] controlled by this [CupertinoTabController], as well
  /// as the currently selected tab item of its [CupertinoTabScaffold.tabBar].
  ///
  /// The value must be greater than or equal to 0, and less than the total
  /// number of tabs.
  int get index => _index;
  int _index;
  set index(int value) {
    assert(value != null);
    assert(value >= 0);
    if (_index == value) {
      return;
    }
    _index = value;
    notifyListeners();
  }

  @mustCallSuper
  @override
  void dispose() {
    super.dispose();
    _isDisposed = true;
  }
}

72 73 74 75 76 77 78 79 80
/// Implements a tabbed iOS application's root layout and behavior structure.
///
/// The scaffold lays out the tab bar at the bottom and the content between or
/// behind the tab bar.
///
/// A [tabBar] and a [tabBuilder] are required. The [CupertinoTabScaffold]
/// will automatically listen to the provided [CupertinoTabBar]'s tap callbacks
/// to change the active tab.
///
81 82 83 84 85 86
/// A [controller] can be used to provide an initially selected tab index and manage
/// subsequent tab changes. If a controller is not specified, the scaffold will
/// create its own [CupertinoTabController] and manage it internally. Otherwise
/// it's up to the owner of [controller] to call `dispose` on it after finish
/// using it.
///
87
/// Tabs' contents are built with the provided [tabBuilder] at the active
88
/// tab index. The [tabBuilder] must be able to build the same number of
Dan Field's avatar
Dan Field committed
89
/// pages as there are [tabBar] items. Inactive tabs will be moved [Offstage]
90
/// and their animations disabled.
91
///
92 93 94 95
/// Adding/removing tabs, or changing the order of tabs is supported but not
/// recommended. Doing so is against the iOS human interface guidelines, and
/// [CupertinoTabScaffold] may lose some tabs' state in the process.
///
96 97 98 99 100 101 102 103
/// Use [CupertinoTabView] as the root widget of each tab to support tabs with
/// parallel navigation state and history. Since each [CupertinoTabView] contains
/// a [Navigator], rebuilding the [CupertinoTabView] with a different
/// [WidgetBuilder] instance in [CupertinoTabView.builder] will not recreate
/// the [CupertinoTabView]'s navigation stack or update its UI. To update the
/// contents of the [CupertinoTabView] after it's built, trigger a rebuild
/// (via [State.setState], for instance) from its descendant rather than from
/// its ancestor.
104
///
105
/// {@tool dartpad}
106 107
/// A sample code implementing a typical iOS information architecture with tabs.
///
108
/// ** See code in examples/api/lib/cupertino/tab_scaffold/cupertino_tab_scaffold.0.dart **
109
/// {@end-tool}
110
///
111 112 113 114 115
/// To push a route above all tabs instead of inside the currently selected one
/// (such as when showing a dialog on top of this scaffold), use
/// `Navigator.of(rootNavigator: true)` from inside the [BuildContext] of a
/// [CupertinoTabView].
///
116 117
/// See also:
///
118
///  * [CupertinoTabBar], the bottom tab bar inserted in the scaffold.
119
///  * [CupertinoTabController], the selection state of this widget.
120
///  * [CupertinoTabView], the typical root content of each tab that holds its own
121
///    [Navigator] stack.
122 123
///  * [CupertinoPageRoute], a route hosting modal pages with iOS style transitions.
///  * [CupertinoPageScaffold], typical contents of an iOS modal page implementing
124
///    layout with a navigation bar on top.
125
///  * [iOS human interface guidelines](https://developer.apple.com/design/human-interface-guidelines/ios/bars/tab-bars/).
126
class CupertinoTabScaffold extends StatefulWidget {
127 128
  /// Creates a layout for applications with a tab bar at the bottom.
  ///
129
  /// The [tabBar] and [tabBuilder] arguments must not be null.
130
  CupertinoTabScaffold({
131
    super.key,
132 133
    required this.tabBar,
    required this.tabBuilder,
134
    this.controller,
135 136
    this.backgroundColor,
    this.resizeToAvoidBottomInset = true,
137
    this.restorationId,
138 139
  }) : assert(tabBar != null),
       assert(tabBuilder != null),
140 141 142
       assert(
         controller == null || controller.index < tabBar.items.length,
         "The CupertinoTabController's current index ${controller.index} is "
143
         'out of bounds for the tab bar with ${tabBar.items.length} tabs',
144
       );
145 146 147 148 149

  /// The [tabBar] is a [CupertinoTabBar] drawn at the bottom of the screen
  /// that lets the user switch between different tabs in the main content area
  /// when present.
  ///
150 151 152 153 154 155
  /// The [CupertinoTabBar.currentIndex] is only used to initialize a
  /// [CupertinoTabController] when no [controller] is provided. Subsequently
  /// providing a different [CupertinoTabBar.currentIndex] does not affect the
  /// scaffold or the tab bar's active tab index. To programmatically change
  /// the active tab index, use a [CupertinoTabController].
  ///
156 157
  /// If [CupertinoTabBar.onTap] is provided, it will still be called.
  /// [CupertinoTabScaffold] automatically also listen to the
158
  /// [CupertinoTabBar]'s `onTap` to change the [controller]'s `index`
159 160 161 162 163
  /// and change the actively displayed tab in [CupertinoTabScaffold]'s own
  /// main content area.
  ///
  /// If translucent, the main content may slide behind it.
  /// Otherwise, the main content's bottom margin will be offset by its height.
164
  ///
165
  /// By default [tabBar] has its text scale factor set to 1.0 and does not
166
  /// respond to text scale factor changes from the operating system, to match
167
  /// the native iOS behavior. To override this behavior, wrap each of the [tabBar]'s
168 169 170 171 172
  /// items inside a [MediaQuery] with the desired [MediaQueryData.textScaleFactor]
  /// value. The text scale factor value from the operating system can be retrieved
  /// int many ways, such as querying [MediaQuery.textScaleFactorOf] against
  /// [CupertinoApp]'s [BuildContext].
  ///
173
  /// Must not be null.
174 175
  final CupertinoTabBar tabBar;

176 177 178 179 180 181
  /// Controls the currently selected tab index of the [tabBar], as well as the
  /// active tab index of the [tabBuilder]. Providing a different [controller]
  /// will also update the scaffold's current active index to the new controller's
  /// index value.
  ///
  /// Defaults to null.
182
  final CupertinoTabController? controller;
183

184 185
  /// An [IndexedWidgetBuilder] that's called when tabs become active.
  ///
186 187 188
  /// The widgets built by [IndexedWidgetBuilder] are typically a
  /// [CupertinoTabView] in order to achieve the parallel hierarchical
  /// information architecture seen on iOS apps with tab bars.
189
  ///
190 191
  /// When the tab becomes inactive, its content is cached in the widget tree
  /// [Offstage] and its animations disabled.
192
  ///
193 194 195 196
  /// Content can slide under the [tabBar] when they're translucent.
  /// In that case, the child's [BuildContext]'s [MediaQuery] will have a
  /// bottom padding indicating the area of obstructing overlap from the
  /// [tabBar].
197 198
  ///
  /// Must not be null.
199 200
  final IndexedWidgetBuilder tabBuilder;

201 202 203
  /// The color of the widget that underlies the entire scaffold.
  ///
  /// By default uses [CupertinoTheme]'s `scaffoldBackgroundColor` when null.
204
  final Color? backgroundColor;
205

Dan Field's avatar
Dan Field committed
206
  /// Whether the body should size itself to avoid the window's bottom inset.
207 208 209 210 211 212 213 214
  ///
  /// For example, if there is an onscreen keyboard displayed above the
  /// scaffold, the body can be resized to avoid overlapping the keyboard, which
  /// prevents widgets inside the body from being obscured by the keyboard.
  ///
  /// Defaults to true and cannot be null.
  final bool resizeToAvoidBottomInset;

215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
  /// Restoration ID to save and restore the state of the [CupertinoTabScaffold].
  ///
  /// This property only has an effect when no [controller] has been provided:
  /// If it is non-null (and no [controller] has been provided), the scaffold
  /// will persist and restore the currently selected tab index. If a
  /// [controller] has been provided, it is the responsibility of the owner of
  /// that controller to persist and restore it, e.g. by using a
  /// [RestorableCupertinoTabController].
  ///
  /// The state of this widget is persisted in a [RestorationBucket] claimed
  /// from the surrounding [RestorationScope] using the provided restoration ID.
  ///
  /// See also:
  ///
  ///  * [RestorationManager], which explains how state restoration works in
  ///    Flutter.
  final String? restorationId;

233
  @override
234
  State<CupertinoTabScaffold> createState() => _CupertinoTabScaffoldState();
235 236
}

237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
class _CupertinoTabScaffoldState extends State<CupertinoTabScaffold> with RestorationMixin {
  RestorableCupertinoTabController? _internalController;
  CupertinoTabController get _controller =>  widget.controller ?? _internalController!.value;

  @override
  String? get restorationId => widget.restorationId;

  @override
  void restoreState(RestorationBucket? oldBucket, bool initialRestore) {
    _restoreInternalController();
  }

  void _restoreInternalController() {
    if (_internalController != null) {
      registerForRestoration(_internalController!, 'controller');
      _internalController!.value.addListener(_onCurrentIndexChange);
    }
  }
255 256 257 258

  @override
  void initState() {
    super.initState();
259 260 261
    _updateTabController();
  }

262 263 264 265 266 267 268
  void _updateTabController([CupertinoTabController? oldWidgetController]) {
    if (widget.controller == null && _internalController == null) {
      // No widget-provided controller: create an internal controller.
      _internalController = RestorableCupertinoTabController(initialIndex: widget.tabBar.currentIndex);
      if (!restorePending) {
        _restoreInternalController(); // Also adds the listener to the controller.
      }
269
    }
270 271 272 273 274 275 276 277 278 279 280 281
    if (widget.controller != null && _internalController != null) {
      // Use the widget-provided controller.
      unregisterFromRestoration(_internalController!);
      _internalController!.dispose();
      _internalController = null;
    }
    if (oldWidgetController != widget.controller) {
      // The widget-provided controller has changed: move listeners.
      if (oldWidgetController?._isDisposed == false) {
        oldWidgetController!.removeListener(_onCurrentIndexChange);
      }
      widget.controller?.addListener(_onCurrentIndexChange);
282 283 284 285 286
    }
  }

  void _onCurrentIndexChange() {
    assert(
287 288
      _controller.index >= 0 && _controller.index < widget.tabBar.items.length,
      "The $runtimeType's current index ${_controller.index} is "
289
      'out of bounds for the tab bar with ${widget.tabBar.items.length} tabs',
290 291 292 293 294
    );

    // The value of `_controller.index` has already been updated at this point.
    // Calling `setState` to rebuild using `_controller.index`.
    setState(() {});
295 296 297 298 299
  }

  @override
  void didUpdateWidget(CupertinoTabScaffold oldWidget) {
    super.didUpdateWidget(oldWidget);
300
    if (widget.controller != oldWidget.controller) {
301 302
      _updateTabController(oldWidget.controller);
    } else if (_controller.index >= widget.tabBar.items.length) {
303 304
      // If a new [tabBar] with less than (_controller.index + 1) items is provided,
      // clamp the current index.
305
      _controller.index = widget.tabBar.items.length - 1;
306 307
    }
  }
308 309 310

  @override
  Widget build(BuildContext context) {
311 312
    final MediaQueryData existingMediaQuery = MediaQuery.of(context);
    MediaQueryData newMediaQuery = MediaQuery.of(context);
313

314
    Widget content = _TabSwitchingView(
315
      currentTabIndex: _controller.index,
316
      tabCount: widget.tabBar.items.length,
317
      tabBuilder: widget.tabBuilder,
318
    );
319
    EdgeInsets contentPadding = EdgeInsets.zero;
320

321 322 323
    if (widget.resizeToAvoidBottomInset) {
      // Remove the view inset and add it back as a padding in the inner content.
      newMediaQuery = newMediaQuery.removeViewInsets(removeBottom: true);
324
      contentPadding = EdgeInsets.only(bottom: existingMediaQuery.viewInsets.bottom);
325
    }
326

327 328 329 330 331 332
    if (widget.tabBar != null &&
        // Only pad the content with the height of the tab bar if the tab
        // isn't already entirely obstructed by a keyboard or other view insets.
        // Don't double pad.
        (!widget.resizeToAvoidBottomInset ||
            widget.tabBar.preferredSize.height > existingMediaQuery.viewInsets.bottom)) {
333 334
      // TODO(xster): Use real size after partial layout instead of preferred size.
      // https://github.com/flutter/flutter/issues/12912
xster's avatar
xster committed
335 336
      final double bottomPadding =
          widget.tabBar.preferredSize.height + existingMediaQuery.padding.bottom;
337 338 339 340

      // If tab bar opaque, directly stop the main content higher. If
      // translucent, let main content draw behind the tab bar but hint the
      // obstructed area.
xster's avatar
xster committed
341
      if (widget.tabBar.opaque(context)) {
342
        contentPadding = EdgeInsets.only(bottom: bottomPadding);
343
        newMediaQuery = newMediaQuery.removePadding(removeBottom: true);
344
      } else {
345 346 347
        newMediaQuery = newMediaQuery.copyWith(
          padding: newMediaQuery.padding.copyWith(
            bottom: bottomPadding,
348 349 350 351 352
          ),
        );
      }
    }

353 354
    content = MediaQuery(
      data: newMediaQuery,
355 356 357 358
      child: Padding(
        padding: contentPadding,
        child: content,
      ),
359 360
    );

xster's avatar
xster committed
361 362
    return DecoratedBox(
      decoration: BoxDecoration(
363
        color: CupertinoDynamicColor.maybeResolve(widget.backgroundColor, context)
364
            ?? CupertinoTheme.of(context).scaffoldBackgroundColor,
xster's avatar
xster committed
365 366
      ),
      child: Stack(
367 368 369 370 371 372 373 374 375 376 377
        children: <Widget>[
          // The main content being at the bottom is added to the stack first.
          content,
          MediaQuery(
            data: existingMediaQuery.copyWith(textScaleFactor: 1),
            child: Align(
              alignment: Alignment.bottomCenter,
              // Override the tab bar's currentIndex to the current tab and hook in
              // our own listener to update the [_controller.currentIndex] on top of a possibly user
              // provided callback.
              child: widget.tabBar.copyWith(
378
                currentIndex: _controller.index,
379
                onTap: (int newIndex) {
380
                  _controller.index = newIndex;
381
                  // Chain the user's original callback.
382
                  widget.tabBar.onTap?.call(newIndex);
383 384 385 386 387
                },
              ),
            ),
          ),
        ],
xster's avatar
xster committed
388
      ),
389 390
    );
  }
391 392 393

  @override
  void dispose() {
394 395
    if (widget.controller?._isDisposed == false) {
      _controller.removeListener(_onCurrentIndexChange);
396
    }
397
    _internalController?.dispose();
398 399
    super.dispose();
  }
400 401
}

402
/// A widget laying out multiple tabs with only one active tab being built
403
/// at a time and on stage. Off stage tabs' animations are stopped.
404 405
class _TabSwitchingView extends StatefulWidget {
  const _TabSwitchingView({
406 407 408
    required this.currentTabIndex,
    required this.tabCount,
    required this.tabBuilder,
409
  }) : assert(currentTabIndex != null),
410
       assert(tabCount != null && tabCount > 0),
411 412 413
       assert(tabBuilder != null);

  final int currentTabIndex;
414
  final int tabCount;
415 416 417
  final IndexedWidgetBuilder tabBuilder;

  @override
418
  _TabSwitchingViewState createState() => _TabSwitchingViewState();
419 420
}

421
class _TabSwitchingViewState extends State<_TabSwitchingView> {
422 423 424 425 426 427 428 429
  final List<bool> shouldBuildTab = <bool>[];
  final List<FocusScopeNode> tabFocusNodes = <FocusScopeNode>[];

  // When focus nodes are no longer needed, we need to dispose of them, but we
  // can't be sure that nothing else is listening to them until this widget is
  // disposed of, so when they are no longer needed, we move them to this list,
  // and dispose of them when we dispose of this widget.
  final List<FocusScopeNode> discardedNodes = <FocusScopeNode>[];
430 431 432 433

  @override
  void initState() {
    super.initState();
434
    shouldBuildTab.addAll(List<bool>.filled(widget.tabCount, false));
435 436 437 438 439 440 441 442 443 444 445
  }

  @override
  void didChangeDependencies() {
    super.didChangeDependencies();
    _focusActiveTab();
  }

  @override
  void didUpdateWidget(_TabSwitchingView oldWidget) {
    super.didUpdateWidget(oldWidget);
446 447 448 449 450 451

    // Only partially invalidate the tabs cache to avoid breaking the current
    // behavior. We assume that the only possible change is either:
    // - new tabs are appended to the tab list, or
    // - some trailing tabs are removed.
    // If the above assumption is not true, some tabs may lose their state.
452
    final int lengthDiff = widget.tabCount - shouldBuildTab.length;
453 454 455
    if (lengthDiff > 0) {
      shouldBuildTab.addAll(List<bool>.filled(lengthDiff, false));
    } else if (lengthDiff < 0) {
456
      shouldBuildTab.removeRange(widget.tabCount, shouldBuildTab.length);
457
    }
458 459 460
    _focusActiveTab();
  }

461
  // Will focus the active tab if the FocusScope above it has focus already. If
462
  // not, then it will just mark it as the preferred focus for that scope.
463
  void _focusActiveTab() {
464 465 466 467 468 469 470 471
    if (tabFocusNodes.length != widget.tabCount) {
      if (tabFocusNodes.length > widget.tabCount) {
        discardedNodes.addAll(tabFocusNodes.sublist(widget.tabCount));
        tabFocusNodes.removeRange(widget.tabCount, tabFocusNodes.length);
      } else {
        tabFocusNodes.addAll(
          List<FocusScopeNode>.generate(
            widget.tabCount - tabFocusNodes.length,
472
              (int index) => FocusScopeNode(debugLabel: '$CupertinoTabScaffold Tab ${index + tabFocusNodes.length}'),
473 474 475
          ),
        );
      }
476
    }
477 478 479 480 481
    FocusScope.of(context).setFirstFocus(tabFocusNodes[widget.currentTabIndex]);
  }

  @override
  void dispose() {
482
    for (final FocusScopeNode focusScopeNode in tabFocusNodes) {
483
      focusScopeNode.dispose();
484
    }
485
    for (final FocusScopeNode focusScopeNode in discardedNodes) {
486 487
      focusScopeNode.dispose();
    }
488
    super.dispose();
489 490 491 492
  }

  @override
  Widget build(BuildContext context) {
493
    return Stack(
494
      fit: StackFit.expand,
495
      children: List<Widget>.generate(widget.tabCount, (int index) {
496
        final bool active = index == widget.currentTabIndex;
497
        shouldBuildTab[index] = active || shouldBuildTab[index];
498

najeira's avatar
najeira committed
499 500 501 502 503 504 505 506 507
        return HeroMode(
          enabled: active,
          child: Offstage(
            offstage: !active,
            child: TickerMode(
              enabled: active,
              child: FocusScope(
                node: tabFocusNodes[index],
                child: Builder(builder: (BuildContext context) {
508
                  return shouldBuildTab[index] ? widget.tabBuilder(context, index) : const SizedBox.shrink();
najeira's avatar
najeira committed
509 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 536 537 538 539 540 541 542 543 544

/// A [RestorableProperty] that knows how to store and restore a
/// [CupertinoTabController].
///
/// The [CupertinoTabController] is accessible via the [value] getter. During
/// state restoration, the property will restore [CupertinoTabController.index]
/// to the value it had when the restoration data it is getting restored from
/// was collected.
class RestorableCupertinoTabController extends RestorableChangeNotifier<CupertinoTabController> {
  /// Creates a [RestorableCupertinoTabController] to control the tab index of
  /// [CupertinoTabScaffold] and [CupertinoTabBar].
  ///
  /// The `initialIndex` must not be null and defaults to 0. The value must be
  /// greater than or equal to 0, and less than the total number of tabs.
  RestorableCupertinoTabController({ int initialIndex = 0 })
    : assert(initialIndex != null),
      assert(initialIndex >= 0),
      _initialIndex = initialIndex;

  final int _initialIndex;

  @override
  CupertinoTabController createDefaultValue() {
    return CupertinoTabController(initialIndex: _initialIndex);
  }

  @override
545 546 547
  CupertinoTabController fromPrimitives(Object? data) {
    assert(data != null);
    return CupertinoTabController(initialIndex: data! as int);
548 549 550 551 552 553 554
  }

  @override
  Object? toPrimitives() {
    return value.index;
  }
}