tab_scaffold.dart 20 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
class CupertinoTabController extends ChangeNotifier {
  /// Creates a [CupertinoTabController] to control the tab index of [CupertinoTabScaffold]
  /// and [CupertinoTabBar].
  ///
35 36
  /// The [initialIndex] defaults to 0. The value must be greater than or equal
  /// to 0, and less than the total number of tabs.
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
  CupertinoTabController({ int initialIndex = 0 })
    : _index = initialIndex,
      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 >= 0);
    if (_index == value) {
      return;
    }
    _index = value;
    notifyListeners();
  }

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

70 71 72 73 74 75 76 77 78
/// 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.
///
79 80 81 82 83 84
/// 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.
///
85
/// Tabs' contents are built with the provided [tabBuilder] at the active
86
/// tab index. The [tabBuilder] must be able to build the same number of
Dan Field's avatar
Dan Field committed
87
/// pages as there are [tabBar] items. Inactive tabs will be moved [Offstage]
88
/// and their animations disabled.
89
///
90 91 92 93
/// 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.
///
94 95 96 97 98 99 100 101
/// 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.
102
///
103
/// {@tool dartpad}
104 105
/// A sample code implementing a typical iOS information architecture with tabs.
///
106
/// ** See code in examples/api/lib/cupertino/tab_scaffold/cupertino_tab_scaffold.0.dart **
107
/// {@end-tool}
108
///
109 110 111 112 113
/// 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].
///
114 115
/// See also:
///
116
///  * [CupertinoTabBar], the bottom tab bar inserted in the scaffold.
117
///  * [CupertinoTabController], the selection state of this widget.
118
///  * [CupertinoTabView], the typical root content of each tab that holds its own
119
///    [Navigator] stack.
120 121
///  * [CupertinoPageRoute], a route hosting modal pages with iOS style transitions.
///  * [CupertinoPageScaffold], typical contents of an iOS modal page implementing
122
///    layout with a navigation bar on top.
123
///  * [iOS human interface guidelines](https://developer.apple.com/design/human-interface-guidelines/ios/bars/tab-bars/).
124
class CupertinoTabScaffold extends StatefulWidget {
125
  /// Creates a layout for applications with a tab bar at the bottom.
126
  CupertinoTabScaffold({
127
    super.key,
128 129
    required this.tabBar,
    required this.tabBuilder,
130
    this.controller,
131 132
    this.backgroundColor,
    this.resizeToAvoidBottomInset = true,
133
    this.restorationId,
134
  }) : assert(
135 136
         controller == null || controller.index < tabBar.items.length,
         "The CupertinoTabController's current index ${controller.index} is "
137
         'out of bounds for the tab bar with ${tabBar.items.length} tabs',
138
       );
139 140 141 142 143

  /// 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.
  ///
144 145 146 147 148 149
  /// 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].
  ///
150 151
  /// If [CupertinoTabBar.onTap] is provided, it will still be called.
  /// [CupertinoTabScaffold] automatically also listen to the
152
  /// [CupertinoTabBar]'s `onTap` to change the [controller]'s `index`
153 154 155 156 157
  /// 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.
158
  ///
159 160 161
  /// By default [tabBar] disables text scaling to match the native iOS behavior.
  /// To override this behavior, wrap each of the [tabBar]'s items inside a
  /// [MediaQuery] with the desired [TextScaler].
162 163
  final CupertinoTabBar tabBar;

164 165 166 167 168 169
  /// 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.
170
  final CupertinoTabController? controller;
171

172 173
  /// An [IndexedWidgetBuilder] that's called when tabs become active.
  ///
174 175 176
  /// 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.
177
  ///
178 179
  /// When the tab becomes inactive, its content is cached in the widget tree
  /// [Offstage] and its animations disabled.
180
  ///
181 182 183 184
  /// 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].
185 186
  final IndexedWidgetBuilder tabBuilder;

187 188 189
  /// The color of the widget that underlies the entire scaffold.
  ///
  /// By default uses [CupertinoTheme]'s `scaffoldBackgroundColor` when null.
190
  final Color? backgroundColor;
191

Dan Field's avatar
Dan Field committed
192
  /// Whether the body should size itself to avoid the window's bottom inset.
193 194 195 196 197
  ///
  /// 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.
  ///
198
  /// Defaults to true.
199 200
  final bool resizeToAvoidBottomInset;

201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
  /// 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;

219
  @override
220
  State<CupertinoTabScaffold> createState() => _CupertinoTabScaffoldState();
221 222
}

223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
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);
    }
  }
241 242 243 244

  @override
  void initState() {
    super.initState();
245 246 247
    _updateTabController();
  }

248 249 250 251 252 253 254
  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.
      }
255
    }
256 257 258 259 260 261 262 263 264 265 266 267
    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);
268 269 270 271 272
    }
  }

  void _onCurrentIndexChange() {
    assert(
273 274
      _controller.index >= 0 && _controller.index < widget.tabBar.items.length,
      "The $runtimeType's current index ${_controller.index} is "
275
      'out of bounds for the tab bar with ${widget.tabBar.items.length} tabs',
276 277 278 279 280
    );

    // The value of `_controller.index` has already been updated at this point.
    // Calling `setState` to rebuild using `_controller.index`.
    setState(() {});
281 282 283 284 285
  }

  @override
  void didUpdateWidget(CupertinoTabScaffold oldWidget) {
    super.didUpdateWidget(oldWidget);
286
    if (widget.controller != oldWidget.controller) {
287 288
      _updateTabController(oldWidget.controller);
    } else if (_controller.index >= widget.tabBar.items.length) {
289 290
      // If a new [tabBar] with less than (_controller.index + 1) items is provided,
      // clamp the current index.
291
      _controller.index = widget.tabBar.items.length - 1;
292 293
    }
  }
294 295 296

  @override
  Widget build(BuildContext context) {
297 298
    final MediaQueryData existingMediaQuery = MediaQuery.of(context);
    MediaQueryData newMediaQuery = MediaQuery.of(context);
299

300
    Widget content = _TabSwitchingView(
301
      currentTabIndex: _controller.index,
302
      tabCount: widget.tabBar.items.length,
303
      tabBuilder: widget.tabBuilder,
304
    );
305
    EdgeInsets contentPadding = EdgeInsets.zero;
306

307 308 309
    if (widget.resizeToAvoidBottomInset) {
      // Remove the view inset and add it back as a padding in the inner content.
      newMediaQuery = newMediaQuery.removeViewInsets(removeBottom: true);
310
      contentPadding = EdgeInsets.only(bottom: existingMediaQuery.viewInsets.bottom);
311
    }
312

313 314 315 316
    // 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.
    if (!widget.resizeToAvoidBottomInset || widget.tabBar.preferredSize.height > existingMediaQuery.viewInsets.bottom) {
317 318
      // TODO(xster): Use real size after partial layout instead of preferred size.
      // https://github.com/flutter/flutter/issues/12912
xster's avatar
xster committed
319 320
      final double bottomPadding =
          widget.tabBar.preferredSize.height + existingMediaQuery.padding.bottom;
321 322 323 324

      // 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
325
      if (widget.tabBar.opaque(context)) {
326
        contentPadding = EdgeInsets.only(bottom: bottomPadding);
327
        newMediaQuery = newMediaQuery.removePadding(removeBottom: true);
328
      } else {
329 330 331
        newMediaQuery = newMediaQuery.copyWith(
          padding: newMediaQuery.padding.copyWith(
            bottom: bottomPadding,
332 333 334 335 336
          ),
        );
      }
    }

337 338
    content = MediaQuery(
      data: newMediaQuery,
339 340 341 342
      child: Padding(
        padding: contentPadding,
        child: content,
      ),
343 344
    );

xster's avatar
xster committed
345 346
    return DecoratedBox(
      decoration: BoxDecoration(
347
        color: CupertinoDynamicColor.maybeResolve(widget.backgroundColor, context)
348
            ?? CupertinoTheme.of(context).scaffoldBackgroundColor,
xster's avatar
xster committed
349 350
      ),
      child: Stack(
351 352 353
        children: <Widget>[
          // The main content being at the bottom is added to the stack first.
          content,
354
          MediaQuery.withNoTextScaling(
355 356 357 358 359 360
            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(
361
                currentIndex: _controller.index,
362
                onTap: (int newIndex) {
363
                  _controller.index = newIndex;
364
                  // Chain the user's original callback.
365
                  widget.tabBar.onTap?.call(newIndex);
366 367 368 369 370
                },
              ),
            ),
          ),
        ],
xster's avatar
xster committed
371
      ),
372 373
    );
  }
374 375 376

  @override
  void dispose() {
377 378
    if (widget.controller?._isDisposed == false) {
      _controller.removeListener(_onCurrentIndexChange);
379
    }
380
    _internalController?.dispose();
381 382
    super.dispose();
  }
383 384
}

385
/// A widget laying out multiple tabs with only one active tab being built
386
/// at a time and on stage. Off stage tabs' animations are stopped.
387 388
class _TabSwitchingView extends StatefulWidget {
  const _TabSwitchingView({
389 390 391
    required this.currentTabIndex,
    required this.tabCount,
    required this.tabBuilder,
392
  }) : assert(tabCount > 0);
393 394

  final int currentTabIndex;
395
  final int tabCount;
396 397 398
  final IndexedWidgetBuilder tabBuilder;

  @override
399
  _TabSwitchingViewState createState() => _TabSwitchingViewState();
400 401
}

402
class _TabSwitchingViewState extends State<_TabSwitchingView> {
403 404 405 406 407 408 409 410
  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>[];
411 412 413 414

  @override
  void initState() {
    super.initState();
415
    shouldBuildTab.addAll(List<bool>.filled(widget.tabCount, false));
416 417 418 419 420 421 422 423 424 425 426
  }

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

  @override
  void didUpdateWidget(_TabSwitchingView oldWidget) {
    super.didUpdateWidget(oldWidget);
427 428 429 430 431 432

    // 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.
433
    final int lengthDiff = widget.tabCount - shouldBuildTab.length;
434 435 436
    if (lengthDiff > 0) {
      shouldBuildTab.addAll(List<bool>.filled(lengthDiff, false));
    } else if (lengthDiff < 0) {
437
      shouldBuildTab.removeRange(widget.tabCount, shouldBuildTab.length);
438
    }
439 440 441
    _focusActiveTab();
  }

442
  // Will focus the active tab if the FocusScope above it has focus already. If
443
  // not, then it will just mark it as the preferred focus for that scope.
444
  void _focusActiveTab() {
445 446 447 448 449 450 451 452
    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,
453
              (int index) => FocusScopeNode(debugLabel: '$CupertinoTabScaffold Tab ${index + tabFocusNodes.length}'),
454 455 456
          ),
        );
      }
457
    }
458 459 460 461 462
    FocusScope.of(context).setFirstFocus(tabFocusNodes[widget.currentTabIndex]);
  }

  @override
  void dispose() {
463
    for (final FocusScopeNode focusScopeNode in tabFocusNodes) {
464
      focusScopeNode.dispose();
465
    }
466
    for (final FocusScopeNode focusScopeNode in discardedNodes) {
467 468
      focusScopeNode.dispose();
    }
469
    super.dispose();
470 471 472 473
  }

  @override
  Widget build(BuildContext context) {
474
    return Stack(
475
      fit: StackFit.expand,
476
      children: List<Widget>.generate(widget.tabCount, (int index) {
477
        final bool active = index == widget.currentTabIndex;
478
        shouldBuildTab[index] = active || shouldBuildTab[index];
479

najeira's avatar
najeira committed
480 481 482 483 484 485 486 487 488
        return HeroMode(
          enabled: active,
          child: Offstage(
            offstage: !active,
            child: TickerMode(
              enabled: active,
              child: FocusScope(
                node: tabFocusNodes[index],
                child: Builder(builder: (BuildContext context) {
489
                  return shouldBuildTab[index] ? widget.tabBuilder(context, index) : const SizedBox.shrink();
najeira's avatar
najeira committed
490 491
                }),
              ),
492
            ),
493 494 495 496 497 498
          ),
        );
      }),
    );
  }
}
499 500 501 502 503 504 505 506 507 508 509 510

/// 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].
  ///
511 512
  /// The `initialIndex` defaults to zero. The value must be greater than or
  /// equal to zero, and less than the total number of tabs.
513
  RestorableCupertinoTabController({ int initialIndex = 0 })
514
    : assert(initialIndex >= 0),
515 516 517 518 519 520 521 522 523 524
      _initialIndex = initialIndex;

  final int _initialIndex;

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

  @override
525 526 527
  CupertinoTabController fromPrimitives(Object? data) {
    assert(data != null);
    return CupertinoTabController(initialIndex: data! as int);
528 529 530 531 532 533 534
  }

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