| // Copyright 2015 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 'dart:async'; |
| import 'dart:math' as math; |
| import 'dart:ui' show lerpDouble; |
| |
| import 'package:flutter/foundation.dart'; |
| import 'package:flutter/rendering.dart'; |
| import 'package:flutter/widgets.dart'; |
| |
| import 'app_bar.dart'; |
| import 'colors.dart'; |
| import 'constants.dart'; |
| import 'debug.dart'; |
| import 'ink_well.dart'; |
| import 'material.dart'; |
| import 'tab_controller.dart'; |
| import 'theme.dart'; |
| |
| const double _kTabHeight = 46.0; |
| const double _kTextAndIconTabHeight = 72.0; |
| const double _kMinTabWidth = 72.0; |
| |
| /// A material design [TabBar] tab. If both [icon] and [text] are |
| /// provided, the text is displayed below the icon. |
| /// |
| /// See also: |
| /// |
| /// * [TabBar], which displays a row of tabs. |
| /// * [TabBarView], which displays a widget for the currently selected tab. |
| /// * [TabController], which coordinates tab selection between a [TabBar] and a [TabBarView]. |
| /// * <https://material.google.com/components/tabs.html> |
| class Tab extends StatelessWidget { |
| /// Creates a material design [TabBar] tab. At least one of [text], [icon], |
| /// and [child] must be non-null. The [text] and [child] arguments must not be |
| /// used at the same time. |
| const Tab({ |
| Key key, |
| this.text, |
| this.icon, |
| this.child, |
| }) : assert(text != null || child != null || icon != null), |
| assert(!(text != null && null != child)), // TODO(goderbauer): https://github.com/dart-lang/sdk/issues/31140 |
| super(key: key); |
| |
| /// The text to display as the tab's label. |
| /// |
| /// Must not be used in combination with [child]. |
| final String text; |
| |
| /// The widget to be used as the tab's label. |
| /// |
| /// Usually a [Text] widget, possibly wrapped in a [Semantics] widget. |
| /// |
| /// Must not be used in combination with [text]. |
| final Widget child; |
| |
| /// An icon to display as the tab's label. |
| final Widget icon; |
| |
| Widget _buildLabelText() { |
| return child ?? new Text(text, softWrap: false, overflow: TextOverflow.fade); |
| } |
| |
| @override |
| Widget build(BuildContext context) { |
| assert(debugCheckHasMaterial(context)); |
| |
| double height; |
| Widget label; |
| if (icon == null) { |
| height = _kTabHeight; |
| label = _buildLabelText(); |
| } else if (text == null) { |
| height = _kTabHeight; |
| label = icon; |
| } else { |
| height = _kTextAndIconTabHeight; |
| label = new Column( |
| mainAxisAlignment: MainAxisAlignment.center, |
| crossAxisAlignment: CrossAxisAlignment.center, |
| children: <Widget>[ |
| new Container( |
| child: icon, |
| margin: const EdgeInsets.only(bottom: 10.0) |
| ), |
| _buildLabelText() |
| ] |
| ); |
| } |
| |
| return new Container( |
| padding: kTabLabelPadding, |
| height: height, |
| constraints: const BoxConstraints(minWidth: _kMinTabWidth), |
| child: new Center(child: label), |
| ); |
| } |
| |
| @override |
| void debugFillProperties(DiagnosticPropertiesBuilder description) { |
| super.debugFillProperties(description); |
| description.add(new StringProperty('text', text, defaultValue: null)); |
| description.add(new DiagnosticsProperty<Widget>('icon', icon, defaultValue: null)); |
| } |
| } |
| |
| class _TabStyle extends AnimatedWidget { |
| const _TabStyle({ |
| Key key, |
| Animation<double> animation, |
| this.selected, |
| this.labelColor, |
| this.unselectedLabelColor, |
| this.labelStyle, |
| this.unselectedLabelStyle, |
| @required this.child, |
| }) : super(key: key, listenable: animation); |
| |
| final TextStyle labelStyle; |
| final TextStyle unselectedLabelStyle; |
| final bool selected; |
| final Color labelColor; |
| final Color unselectedLabelColor; |
| final Widget child; |
| |
| @override |
| Widget build(BuildContext context) { |
| final ThemeData themeData = Theme.of(context); |
| final TextStyle defaultStyle = labelStyle ?? themeData.primaryTextTheme.body2; |
| final TextStyle defaultUnselectedStyle = unselectedLabelStyle ?? labelStyle ?? themeData.primaryTextTheme.body2; |
| final TextStyle textStyle = selected |
| ? defaultStyle |
| : defaultUnselectedStyle; |
| final Color selectedColor = labelColor ?? themeData.primaryTextTheme.body2.color; |
| final Color unselectedColor = unselectedLabelColor ?? selectedColor.withAlpha(0xB2); // 70% alpha |
| final Animation<double> animation = listenable; |
| final Color color = selected |
| ? Color.lerp(selectedColor, unselectedColor, animation.value) |
| : Color.lerp(unselectedColor, selectedColor, animation.value); |
| |
| return new DefaultTextStyle( |
| style: textStyle.copyWith(color: color), |
| child: IconTheme.merge( |
| data: new IconThemeData( |
| size: 24.0, |
| color: color, |
| ), |
| child: child, |
| ), |
| ); |
| } |
| } |
| |
| typedef void _LayoutCallback(List<double> xOffsets, TextDirection textDirection, double width); |
| |
| class _TabLabelBarRenderer extends RenderFlex { |
| _TabLabelBarRenderer({ |
| List<RenderBox> children, |
| @required Axis direction, |
| @required MainAxisSize mainAxisSize, |
| @required MainAxisAlignment mainAxisAlignment, |
| @required CrossAxisAlignment crossAxisAlignment, |
| @required TextDirection textDirection, |
| @required VerticalDirection verticalDirection, |
| @required this.onPerformLayout, |
| }) : assert(onPerformLayout != null), |
| assert(textDirection != null), |
| super( |
| children: children, |
| direction: direction, |
| mainAxisSize: mainAxisSize, |
| mainAxisAlignment: mainAxisAlignment, |
| crossAxisAlignment: crossAxisAlignment, |
| textDirection: textDirection, |
| verticalDirection: verticalDirection, |
| ); |
| |
| _LayoutCallback onPerformLayout; |
| |
| @override |
| void performLayout() { |
| super.performLayout(); |
| // xOffsets will contain childCount+1 values, giving the offsets of the |
| // leading edge of the first tab as the first value, of the leading edge of |
| // the each subsequent tab as each subsequent value, and of the trailing |
| // edge of the last tab as the last value. |
| RenderBox child = firstChild; |
| final List<double> xOffsets = <double>[]; |
| while (child != null) { |
| final FlexParentData childParentData = child.parentData; |
| xOffsets.add(childParentData.offset.dx); |
| assert(child.parentData == childParentData); |
| child = childParentData.nextSibling; |
| } |
| assert(textDirection != null); |
| switch (textDirection) { |
| case TextDirection.rtl: |
| xOffsets.insert(0, size.width); |
| break; |
| case TextDirection.ltr: |
| xOffsets.add(size.width); |
| break; |
| } |
| onPerformLayout(xOffsets, textDirection, size.width); |
| } |
| } |
| |
| // This class and its renderer class only exist to report the widths of the tabs |
| // upon layout. The tab widths are only used at paint time (see _IndicatorPainter) |
| // or in response to input. |
| class _TabLabelBar extends Flex { |
| _TabLabelBar({ |
| Key key, |
| List<Widget> children: const <Widget>[], |
| this.onPerformLayout, |
| }) : super( |
| key: key, |
| children: children, |
| direction: Axis.horizontal, |
| mainAxisSize: MainAxisSize.max, |
| mainAxisAlignment: MainAxisAlignment.start, |
| crossAxisAlignment: CrossAxisAlignment.center, |
| verticalDirection: VerticalDirection.down, |
| ); |
| |
| final _LayoutCallback onPerformLayout; |
| |
| @override |
| RenderFlex createRenderObject(BuildContext context) { |
| return new _TabLabelBarRenderer( |
| direction: direction, |
| mainAxisAlignment: mainAxisAlignment, |
| mainAxisSize: mainAxisSize, |
| crossAxisAlignment: crossAxisAlignment, |
| textDirection: getEffectiveTextDirection(context), |
| verticalDirection: verticalDirection, |
| onPerformLayout: onPerformLayout, |
| ); |
| } |
| |
| @override |
| void updateRenderObject(BuildContext context, _TabLabelBarRenderer renderObject) { |
| super.updateRenderObject(context, renderObject); |
| renderObject.onPerformLayout = onPerformLayout; |
| } |
| } |
| |
| double _indexChangeProgress(TabController controller) { |
| final double controllerValue = controller.animation.value; |
| final double previousIndex = controller.previousIndex.toDouble(); |
| final double currentIndex = controller.index.toDouble(); |
| |
| // The controller's offset is changing because the user is dragging the |
| // TabBarView's PageView to the left or right. |
| if (!controller.indexIsChanging) |
| return (currentIndex - controllerValue).abs().clamp(0.0, 1.0); |
| |
| // The TabController animation's value is changing from previousIndex to currentIndex. |
| return (controllerValue - currentIndex).abs() / (currentIndex - previousIndex).abs(); |
| } |
| |
| class _IndicatorPainter extends CustomPainter { |
| _IndicatorPainter({ |
| @required this.controller, |
| @required this.indicatorWeight, |
| @required this.indicatorPadding, |
| _IndicatorPainter old, |
| }) : assert(controller != null), |
| assert(indicatorWeight != null), |
| assert(indicatorPadding != null), |
| super(repaint: controller.animation) { |
| if (old != null) |
| saveTabOffsets(old._currentTabOffsets, old._currentTextDirection); |
| } |
| |
| final TabController controller; |
| final double indicatorWeight; |
| final EdgeInsetsGeometry indicatorPadding; |
| |
| List<double> _currentTabOffsets; |
| TextDirection _currentTextDirection; |
| EdgeInsets _resolvedIndicatorPadding; |
| |
| Color _color; |
| Rect _currentRect; |
| |
| void saveTabOffsets(List<double> tabOffsets, TextDirection textDirection) { |
| _currentTabOffsets = tabOffsets; |
| _currentTextDirection = textDirection; |
| _resolvedIndicatorPadding = indicatorPadding.resolve(_currentTextDirection); |
| } |
| |
| // _currentTabOffsets[index] is the offset of the start edge of the tab at index, and |
| // _currentTabOffsets[_currentTabOffsets.length] is the end edge of the last tab. |
| int get maxTabIndex => _currentTabOffsets.length - 2; |
| |
| double centerOf(int tabIndex) { |
| assert(_currentTabOffsets != null); |
| assert(_currentTabOffsets.isNotEmpty); |
| assert(tabIndex >= 0); |
| assert(tabIndex <= maxTabIndex); |
| return (_currentTabOffsets[tabIndex] + _currentTabOffsets[tabIndex + 1]) / 2.0; |
| } |
| |
| Rect indicatorRect(Size tabBarSize, int tabIndex) { |
| assert(_currentTabOffsets != null); |
| assert(_currentTextDirection != null); |
| assert(_currentTabOffsets.isNotEmpty); |
| assert(tabIndex >= 0); |
| assert(tabIndex <= maxTabIndex); |
| double tabLeft, tabRight; |
| switch (_currentTextDirection) { |
| case TextDirection.rtl: |
| tabLeft = _currentTabOffsets[tabIndex + 1]; |
| tabRight = _currentTabOffsets[tabIndex]; |
| break; |
| case TextDirection.ltr: |
| tabLeft = _currentTabOffsets[tabIndex]; |
| tabRight = _currentTabOffsets[tabIndex + 1]; |
| break; |
| } |
| tabLeft = math.min(tabLeft + _resolvedIndicatorPadding.left, tabRight); |
| tabRight = math.max(tabRight - _resolvedIndicatorPadding.right, tabLeft); |
| final double tabTop = tabBarSize.height - indicatorWeight; |
| return new Rect.fromLTWH(tabLeft, tabTop, tabRight - tabLeft, indicatorWeight); |
| } |
| |
| @override |
| void paint(Canvas canvas, Size size) { |
| if (controller.indexIsChanging) { |
| // The user tapped on a tab, the tab controller's animation is running. |
| final Rect targetRect = indicatorRect(size, controller.index); |
| _currentRect = Rect.lerp(targetRect, _currentRect ?? targetRect, _indexChangeProgress(controller)); |
| } else { |
| // The user is dragging the TabBarView's PageView left or right. |
| final int currentIndex = controller.index; |
| final Rect previous = currentIndex > 0 ? indicatorRect(size, currentIndex - 1) : null; |
| final Rect middle = indicatorRect(size, currentIndex); |
| final Rect next = currentIndex < maxTabIndex ? indicatorRect(size, currentIndex + 1) : null; |
| final double index = controller.index.toDouble(); |
| final double value = controller.animation.value; |
| if (value == index - 1.0) |
| _currentRect = previous ?? middle; |
| else if (value == index + 1.0) |
| _currentRect = next ?? middle; |
| else if (value == index) |
| _currentRect = middle; |
| else if (value < index) |
| _currentRect = previous == null ? middle : Rect.lerp(middle, previous, index - value); |
| else |
| _currentRect = next == null ? middle : Rect.lerp(middle, next, value - index); |
| } |
| assert(_currentRect != null); |
| canvas.drawRect(_currentRect, new Paint()..color = _color); |
| } |
| |
| static bool _tabOffsetsEqual(List<double> a, List<double> b) { |
| if (a?.length != b?.length) |
| return false; |
| for (int i = 0; i < a.length; i += 1) { |
| if (a[i] != b[i]) |
| return false; |
| } |
| return true; |
| } |
| |
| @override |
| bool shouldRepaint(_IndicatorPainter old) { |
| return controller != old.controller |
| || indicatorWeight != old.indicatorWeight |
| || indicatorPadding != old.indicatorPadding |
| || (!_tabOffsetsEqual(_currentTabOffsets, old._currentTabOffsets)) |
| || _currentTextDirection != old._currentTextDirection; |
| } |
| } |
| |
| class _ChangeAnimation extends Animation<double> with AnimationWithParentMixin<double> { |
| _ChangeAnimation(this.controller); |
| |
| final TabController controller; |
| |
| @override |
| Animation<double> get parent => controller.animation; |
| |
| @override |
| double get value => _indexChangeProgress(controller); |
| } |
| |
| class _DragAnimation extends Animation<double> with AnimationWithParentMixin<double> { |
| _DragAnimation(this.controller, this.index); |
| |
| final TabController controller; |
| final int index; |
| |
| @override |
| Animation<double> get parent => controller.animation; |
| |
| @override |
| double get value { |
| assert(!controller.indexIsChanging); |
| return (controller.animation.value - index.toDouble()).abs().clamp(0.0, 1.0); |
| } |
| } |
| |
| // This class, and TabBarScrollController, only exist to handle the the case |
| // where a scrollable TabBar has a non-zero initialIndex. In that case we can |
| // only compute the scroll position's initial scroll offset (the "correct" |
| // pixels value) after the TabBar viewport width and scroll limits are known. |
| class _TabBarScrollPosition extends ScrollPositionWithSingleContext { |
| _TabBarScrollPosition({ |
| ScrollPhysics physics, |
| ScrollContext context, |
| ScrollPosition oldPosition, |
| this.tabBar, |
| }) : super( |
| physics: physics, |
| context: context, |
| initialPixels: null, |
| oldPosition: oldPosition, |
| ); |
| |
| final _TabBarState tabBar; |
| |
| @override |
| bool applyContentDimensions(double minScrollExtent, double maxScrollExtent) { |
| bool result = true; |
| if (pixels == null) { |
| correctPixels(tabBar._initialScrollOffset(viewportDimension, minScrollExtent, maxScrollExtent)); |
| result = false; |
| } |
| return super.applyContentDimensions(minScrollExtent, maxScrollExtent) && result; |
| } |
| } |
| |
| // This class, and TabBarScrollPosition, only exist to handle the the case |
| // where a scrollable TabBar has a non-zero initialIndex. |
| class _TabBarScrollController extends ScrollController { |
| _TabBarScrollController(this.tabBar); |
| |
| final _TabBarState tabBar; |
| |
| @override |
| ScrollPosition createScrollPosition(ScrollPhysics physics, ScrollContext context, ScrollPosition oldPosition) { |
| return new _TabBarScrollPosition( |
| physics: physics, |
| context: context, |
| oldPosition: oldPosition, |
| tabBar: tabBar, |
| ); |
| } |
| } |
| |
| /// A material design widget that displays a horizontal row of tabs. |
| /// |
| /// Typically created as the [AppBar.bottom] part of an [AppBar] and in |
| /// conjunction with a [TabBarView]. |
| /// |
| /// If a [TabController] is not provided, then there must be a |
| /// [DefaultTabController] ancestor. The tab controller's [TabController.length] |
| /// must equal the length of the [tabs] list. |
| /// |
| /// Requires one of its ancestors to be a [Material] widget. |
| /// |
| /// See also: |
| /// |
| /// * [TabBarView], which displays page views that correspond to each tab. |
| class TabBar extends StatefulWidget implements PreferredSizeWidget { |
| /// Creates a material design tab bar. |
| /// |
| /// The [tabs] argument must not be null and its length must match the [controller]'s |
| /// [TabController.length]. |
| /// |
| /// If a [TabController] is not provided, then there must be a |
| /// [DefaultTabController] ancestor. |
| /// |
| /// The [indicatorWeight] parameter defaults to 2, and must not be null. |
| /// |
| /// The [indicatorPadding] parameter defaults to [EdgeInsets.zero], and must not be null. |
| const TabBar({ |
| Key key, |
| @required this.tabs, |
| this.controller, |
| this.isScrollable: false, |
| this.indicatorColor, |
| this.indicatorWeight: 2.0, |
| this.indicatorPadding: EdgeInsets.zero, |
| this.labelColor, |
| this.labelStyle, |
| this.unselectedLabelColor, |
| this.unselectedLabelStyle, |
| }) : assert(tabs != null), |
| assert(isScrollable != null), |
| assert(indicatorWeight != null && indicatorWeight > 0.0), |
| assert(indicatorPadding != null), |
| super(key: key); |
| |
| /// Typically a list of two or more [Tab] widgets. |
| /// |
| /// The length of this list must match the [controller]'s [TabController.length]. |
| final List<Widget> tabs; |
| |
| /// This widget's selection and animation state. |
| /// |
| /// If [TabController] is not provided, then the value of [DefaultTabController.of] |
| /// will be used. |
| final TabController controller; |
| |
| /// Whether this tab bar can be scrolled horizontally. |
| /// |
| /// If [isScrollable] is true then each tab is as wide as needed for its label |
| /// and the entire [TabBar] is scrollable. Otherwise each tab gets an equal |
| /// share of the available space. |
| final bool isScrollable; |
| |
| /// The color of the line that appears below the selected tab. If this parameter |
| /// is null then the value of the Theme's indicatorColor property is used. |
| final Color indicatorColor; |
| |
| /// The thickness of the line that appears below the selected tab. The value |
| /// of this parameter must be greater than zero. |
| /// |
| /// The default value of [indicatorWeight] is 2.0. |
| final double indicatorWeight; |
| |
| /// The horizontal padding for the line that appears below the selected tab. |
| /// For [isScrollable] tab bars, specifying [kTabLabelPadding] will align |
| /// the indicator with the tab's text for [Tab] widgets and all but the |
| /// shortest [Tab.text] values. |
| /// |
| /// The [EdgeInsets.top] and [EdgeInsets.bottom] values of the |
| /// [indicatorPadding] are ignored. |
| /// |
| /// The default value of [indicatorPadding] is [EdgeInsets.zero]. |
| final EdgeInsetsGeometry indicatorPadding; |
| |
| /// The color of selected tab labels. |
| /// |
| /// Unselected tab labels are rendered with the same color rendered at 70% |
| /// opacity unless [unselectedLabelColor] is non-null. |
| /// |
| /// If this parameter is null then the color of the theme's body2 text color |
| /// is used. |
| final Color labelColor; |
| |
| /// The color of unselected tab labels. |
| /// |
| /// If this property is null, Unselected tab labels are rendered with the |
| /// [labelColor] rendered at 70% opacity. |
| final Color unselectedLabelColor; |
| |
| /// The text style of the selected tab labels. If [unselectedLabelStyle] is |
| /// null then this text style will be used for both selected and unselected |
| /// label styles. |
| /// |
| /// If this property is null then the text style of the theme's body2 |
| /// definition is used. |
| final TextStyle labelStyle; |
| |
| /// The text style of the unselected tab labels |
| /// |
| /// If this property is null then the [labelStyle] value is used. If [labelStyle] |
| /// is null then the text style of the theme's body2 definition is used. |
| final TextStyle unselectedLabelStyle; |
| |
| /// A size whose height depends on if the tabs have both icons and text. |
| /// |
| /// [AppBar] uses this this size to compute its own preferred size. |
| @override |
| Size get preferredSize { |
| for (Widget item in tabs) { |
| if (item is Tab) { |
| final Tab tab = item; |
| if (tab.text != null && tab.icon != null) |
| return new Size.fromHeight(_kTextAndIconTabHeight + indicatorWeight); |
| } |
| } |
| return new Size.fromHeight(_kTabHeight + indicatorWeight); |
| } |
| |
| @override |
| _TabBarState createState() => new _TabBarState(); |
| } |
| |
| class _TabBarState extends State<TabBar> { |
| ScrollController _scrollController; |
| TabController _controller; |
| _IndicatorPainter _indicatorPainter; |
| int _currentIndex; |
| double _tabStripWidth; |
| |
| void _updateTabController() { |
| final TabController newController = widget.controller ?? DefaultTabController.of(context); |
| assert(() { |
| if (newController == null) { |
| throw new FlutterError( |
| 'No TabController for ${widget.runtimeType}.\n' |
| 'When creating a ${widget.runtimeType}, you must either provide an explicit ' |
| 'TabController using the "controller" property, or you must ensure that there ' |
| 'is a DefaultTabController above the ${widget.runtimeType}.\n' |
| 'In this case, there was neither an explicit controller nor a default controller.' |
| ); |
| } |
| return true; |
| }()); |
| if (newController == _controller) |
| return; |
| |
| if (_controller != null) { |
| _controller.animation.removeListener(_handleTabControllerAnimationTick); |
| _controller.removeListener(_handleTabControllerTick); |
| } |
| _controller = newController; |
| if (_controller != null) { |
| _controller.animation.addListener(_handleTabControllerAnimationTick); |
| _controller.addListener(_handleTabControllerTick); |
| _currentIndex = _controller.index; |
| _indicatorPainter = new _IndicatorPainter( |
| controller: _controller, |
| indicatorWeight: widget.indicatorWeight, |
| indicatorPadding: widget.indicatorPadding, |
| old: _indicatorPainter, |
| ); |
| } |
| } |
| |
| @override |
| void didChangeDependencies() { |
| super.didChangeDependencies(); |
| _updateTabController(); |
| } |
| |
| @override |
| void didUpdateWidget(TabBar oldWidget) { |
| super.didUpdateWidget(oldWidget); |
| if (widget.controller != oldWidget.controller) |
| _updateTabController(); |
| } |
| |
| @override |
| void dispose() { |
| if (_controller != null) { |
| _controller.animation.removeListener(_handleTabControllerAnimationTick); |
| _controller.removeListener(_handleTabControllerTick); |
| } |
| // We don't own the _controller Animation, so it's not disposed here. |
| super.dispose(); |
| } |
| |
| int get maxTabIndex => _indicatorPainter.maxTabIndex; |
| |
| double _tabScrollOffset(int index, double viewportWidth, double minExtent, double maxExtent) { |
| if (!widget.isScrollable) |
| return 0.0; |
| double tabCenter = _indicatorPainter.centerOf(index); |
| switch (Directionality.of(context)) { |
| case TextDirection.rtl: |
| tabCenter = _tabStripWidth - tabCenter; |
| break; |
| case TextDirection.ltr: |
| break; |
| } |
| return (tabCenter - viewportWidth / 2.0).clamp(minExtent, maxExtent); |
| } |
| |
| double _tabCenteredScrollOffset(int index) { |
| final ScrollPosition position = _scrollController.position; |
| return _tabScrollOffset(index, position.viewportDimension, position.minScrollExtent, position.maxScrollExtent); |
| } |
| |
| double _initialScrollOffset(double viewportWidth, double minExtent, double maxExtent) { |
| return _tabScrollOffset(_currentIndex, viewportWidth, minExtent, maxExtent); |
| } |
| |
| void _scrollToCurrentIndex() { |
| final double offset = _tabCenteredScrollOffset(_currentIndex); |
| _scrollController.animateTo(offset, duration: kTabScrollDuration, curve: Curves.ease); |
| } |
| |
| void _scrollToControllerValue() { |
| final double leadingPosition = _currentIndex > 0 ? _tabCenteredScrollOffset(_currentIndex - 1) : null; |
| final double middlePosition = _tabCenteredScrollOffset(_currentIndex); |
| final double trailingPosition = _currentIndex < maxTabIndex ? _tabCenteredScrollOffset(_currentIndex + 1) : null; |
| |
| final double index = _controller.index.toDouble(); |
| final double value = _controller.animation.value; |
| double offset; |
| if (value == index - 1.0) |
| offset = leadingPosition ?? middlePosition; |
| else if (value == index + 1.0) |
| offset = trailingPosition ?? middlePosition; |
| else if (value == index) |
| offset = middlePosition; |
| else if (value < index) |
| offset = leadingPosition == null ? middlePosition : lerpDouble(middlePosition, leadingPosition, index - value); |
| else |
| offset = trailingPosition == null ? middlePosition : lerpDouble(middlePosition, trailingPosition, value - index); |
| |
| _scrollController.jumpTo(offset); |
| } |
| |
| void _handleTabControllerAnimationTick() { |
| assert(mounted); |
| if (!_controller.indexIsChanging && widget.isScrollable) { |
| // Sync the TabBar's scroll position with the TabBarView's PageView. |
| _currentIndex = _controller.index; |
| _scrollToControllerValue(); |
| } |
| } |
| |
| void _handleTabControllerTick() { |
| if (_controller.index != _currentIndex) { |
| _currentIndex = _controller.index; |
| if (widget.isScrollable) |
| _scrollToCurrentIndex(); |
| } |
| setState(() { |
| // Rebuild the tabs after a (potentially animated) index change |
| // has completed. |
| }); |
| } |
| |
| // Called each time layout completes. |
| void _saveTabOffsets(List<double> tabOffsets, TextDirection textDirection, double width) { |
| _tabStripWidth = width; |
| _indicatorPainter?.saveTabOffsets(tabOffsets, textDirection); |
| } |
| |
| void _handleTap(int index) { |
| assert(index >= 0 && index < widget.tabs.length); |
| _controller.animateTo(index); |
| } |
| |
| Widget _buildStyledTab(Widget child, bool selected, Animation<double> animation) { |
| return new _TabStyle( |
| animation: animation, |
| selected: selected, |
| labelColor: widget.labelColor, |
| unselectedLabelColor: widget.unselectedLabelColor, |
| labelStyle: widget.labelStyle, |
| unselectedLabelStyle: widget.unselectedLabelStyle, |
| child: child, |
| ); |
| } |
| |
| @override |
| Widget build(BuildContext context) { |
| if (_controller.length == 0) { |
| return new Container( |
| height: _kTabHeight + widget.indicatorWeight, |
| ); |
| } |
| |
| final List<Widget> wrappedTabs = new List<Widget>.from(widget.tabs, growable: false); |
| |
| // If the controller was provided by DefaultTabController and we're part |
| // of a Hero (typically the AppBar), then we will not be able to find the |
| // controller during a Hero transition. See https://github.com/flutter/flutter/issues/213. |
| if (_controller != null) { |
| _indicatorPainter._color = widget.indicatorColor ?? Theme.of(context).indicatorColor; |
| if (_indicatorPainter._color == Material.of(context).color) { |
| // ThemeData tries to avoid this by having indicatorColor avoid being the |
| // primaryColor. However, it's possible that the tab bar is on a |
| // Material that isn't the primaryColor. In that case, if the indicator |
| // color ends up clashing, then this overrides it. When that happens, |
| // automatic transitions of the theme will likely look ugly as the |
| // indicator color suddenly snaps to white at one end, but it's not clear |
| // how to avoid that any further. |
| _indicatorPainter._color = Colors.white; |
| } |
| |
| final int previousIndex = _controller.previousIndex; |
| |
| if (_controller.indexIsChanging) { |
| // The user tapped on a tab, the tab controller's animation is running. |
| assert(_currentIndex != previousIndex); |
| final Animation<double> animation = new _ChangeAnimation(_controller); |
| wrappedTabs[_currentIndex] = _buildStyledTab(wrappedTabs[_currentIndex], true, animation); |
| wrappedTabs[previousIndex] = _buildStyledTab(wrappedTabs[previousIndex], false, animation); |
| } else { |
| // The user is dragging the TabBarView's PageView left or right. |
| final int tabIndex = _currentIndex; |
| final Animation<double> centerAnimation = new _DragAnimation(_controller, tabIndex); |
| wrappedTabs[tabIndex] = _buildStyledTab(wrappedTabs[tabIndex], true, centerAnimation); |
| if (_currentIndex > 0) { |
| final int tabIndex = _currentIndex - 1; |
| final Animation<double> previousAnimation = new _DragAnimation(_controller, tabIndex); |
| wrappedTabs[tabIndex] = _buildStyledTab(wrappedTabs[tabIndex], true, previousAnimation); |
| } |
| if (_currentIndex < widget.tabs.length - 1) { |
| final int tabIndex = _currentIndex + 1; |
| final Animation<double> nextAnimation = new _DragAnimation(_controller, tabIndex); |
| wrappedTabs[tabIndex] = _buildStyledTab(wrappedTabs[tabIndex], true, nextAnimation); |
| } |
| } |
| } |
| |
| // Add the tap handler to each tab. If the tab bar is scrollable |
| // then give all of the tabs equal flexibility so that their widths |
| // reflect the intrinsic width of their labels. |
| final int tabCount = widget.tabs.length; |
| for (int index = 0; index < tabCount; index += 1) { |
| wrappedTabs[index] = new InkWell( |
| onTap: () { _handleTap(index); }, |
| child: new Padding( |
| padding: new EdgeInsets.only(bottom: widget.indicatorWeight), |
| child: new Stack( |
| children: <Widget>[ |
| wrappedTabs[index], |
| new Semantics( |
| selected: index == _currentIndex, |
| // TODO(goderbauer): I10N-ify |
| label: 'Tab ${index + 1} of $tabCount', |
| ), |
| ] |
| ), |
| ), |
| ); |
| if (!widget.isScrollable) |
| wrappedTabs[index] = new Expanded(child: wrappedTabs[index]); |
| } |
| |
| Widget tabBar = new CustomPaint( |
| painter: _indicatorPainter, |
| child: new _TabStyle( |
| animation: kAlwaysDismissedAnimation, |
| selected: false, |
| labelColor: widget.labelColor, |
| unselectedLabelColor: widget.unselectedLabelColor, |
| labelStyle: widget.labelStyle, |
| unselectedLabelStyle: widget.unselectedLabelStyle, |
| child: new _TabLabelBar( |
| onPerformLayout: _saveTabOffsets, |
| children: wrappedTabs, |
| ), |
| ), |
| ); |
| |
| if (widget.isScrollable) { |
| _scrollController ??= new _TabBarScrollController(this); |
| tabBar = new SingleChildScrollView( |
| scrollDirection: Axis.horizontal, |
| controller: _scrollController, |
| child: tabBar, |
| ); |
| } |
| |
| return tabBar; |
| } |
| } |
| |
| /// A page view that displays the widget which corresponds to the currently |
| /// selected tab. Typically used in conjunction with a [TabBar]. |
| /// |
| /// If a [TabController] is not provided, then there must be a [DefaultTabController] |
| /// ancestor. |
| class TabBarView extends StatefulWidget { |
| /// Creates a page view with one child per tab. |
| /// |
| /// The length of [children] must be the same as the [controller]'s length. |
| const TabBarView({ |
| Key key, |
| @required this.children, |
| this.controller, |
| this.physics, |
| }) : assert(children != null), super(key: key); |
| |
| /// This widget's selection and animation state. |
| /// |
| /// If [TabController] is not provided, then the value of [DefaultTabController.of] |
| /// will be used. |
| final TabController controller; |
| |
| /// One widget per tab. |
| final List<Widget> children; |
| |
| /// How the page view should respond to user input. |
| /// |
| /// For example, determines how the page view continues to animate after the |
| /// user stops dragging the page view. |
| /// |
| /// The physics are modified to snap to page boundaries using |
| /// [PageScrollPhysics] prior to being used. |
| /// |
| /// Defaults to matching platform conventions. |
| final ScrollPhysics physics; |
| |
| @override |
| _TabBarViewState createState() => new _TabBarViewState(); |
| } |
| |
| final PageScrollPhysics _kTabBarViewPhysics = const PageScrollPhysics().applyTo(const ClampingScrollPhysics()); |
| |
| class _TabBarViewState extends State<TabBarView> { |
| TabController _controller; |
| PageController _pageController; |
| List<Widget> _children; |
| int _currentIndex; |
| int _warpUnderwayCount = 0; |
| |
| void _updateTabController() { |
| final TabController newController = widget.controller ?? DefaultTabController.of(context); |
| assert(() { |
| if (newController == null) { |
| throw new FlutterError( |
| 'No TabController for ${widget.runtimeType}.\n' |
| 'When creating a ${widget.runtimeType}, you must either provide an explicit ' |
| 'TabController using the "controller" property, or you must ensure that there ' |
| 'is a DefaultTabController above the ${widget.runtimeType}.\n' |
| 'In this case, there was neither an explicit controller nor a default controller.' |
| ); |
| } |
| return true; |
| }()); |
| if (newController == _controller) |
| return; |
| |
| if (_controller != null) |
| _controller.animation.removeListener(_handleTabControllerAnimationTick); |
| _controller = newController; |
| if (_controller != null) |
| _controller.animation.addListener(_handleTabControllerAnimationTick); |
| } |
| |
| @override |
| void initState() { |
| super.initState(); |
| _children = widget.children; |
| } |
| |
| @override |
| void didChangeDependencies() { |
| super.didChangeDependencies(); |
| _updateTabController(); |
| _currentIndex = _controller?.index; |
| _pageController = new PageController(initialPage: _currentIndex ?? 0); |
| } |
| |
| @override |
| void didUpdateWidget(TabBarView oldWidget) { |
| super.didUpdateWidget(oldWidget); |
| if (widget.controller != oldWidget.controller) |
| _updateTabController(); |
| if (widget.children != oldWidget.children && _warpUnderwayCount == 0) |
| _children = widget.children; |
| } |
| |
| @override |
| void dispose() { |
| if (_controller != null) |
| _controller.animation.removeListener(_handleTabControllerAnimationTick); |
| // We don't own the _controller Animation, so it's not disposed here. |
| super.dispose(); |
| } |
| |
| void _handleTabControllerAnimationTick() { |
| if (_warpUnderwayCount > 0 || !_controller.indexIsChanging) |
| return; // This widget is driving the controller's animation. |
| |
| if (_controller.index != _currentIndex) { |
| _currentIndex = _controller.index; |
| _warpToCurrentIndex(); |
| } |
| } |
| |
| Future<Null> _warpToCurrentIndex() async { |
| if (!mounted) |
| return new Future<Null>.value(); |
| |
| if (_pageController.page == _currentIndex.toDouble()) |
| return new Future<Null>.value(); |
| |
| final int previousIndex = _controller.previousIndex; |
| if ((_currentIndex - previousIndex).abs() == 1) |
| return _pageController.animateToPage(_currentIndex, duration: kTabScrollDuration, curve: Curves.ease); |
| |
| assert((_currentIndex - previousIndex).abs() > 1); |
| int initialPage; |
| setState(() { |
| _warpUnderwayCount += 1; |
| _children = new List<Widget>.from(widget.children, growable: false); |
| if (_currentIndex > previousIndex) { |
| _children[_currentIndex - 1] = _children[previousIndex]; |
| initialPage = _currentIndex - 1; |
| } else { |
| _children[_currentIndex + 1] = _children[previousIndex]; |
| initialPage = _currentIndex + 1; |
| } |
| }); |
| |
| _pageController.jumpToPage(initialPage); |
| |
| await _pageController.animateToPage(_currentIndex, duration: kTabScrollDuration, curve: Curves.ease); |
| if (!mounted) |
| return new Future<Null>.value(); |
| |
| setState(() { |
| _warpUnderwayCount -= 1; |
| _children = widget.children; |
| }); |
| } |
| |
| // Called when the PageView scrolls |
| bool _handleScrollNotification(ScrollNotification notification) { |
| if (_warpUnderwayCount > 0) |
| return false; |
| |
| if (notification.depth != 0) |
| return false; |
| |
| _warpUnderwayCount += 1; |
| if (notification is ScrollUpdateNotification && !_controller.indexIsChanging) { |
| if ((_pageController.page - _controller.index).abs() > 1.0) { |
| _controller.index = _pageController.page.floor(); |
| _currentIndex=_controller.index; |
| } |
| _controller.offset = (_pageController.page - _controller.index).clamp(-1.0, 1.0); |
| } else if (notification is ScrollEndNotification) { |
| final ScrollPosition position = _pageController.position; |
| final double pageTolerance = position.physics.tolerance.distance |
| / (position.viewportDimension * _pageController.viewportFraction); |
| _controller.index = (_pageController.page + pageTolerance).floor(); |
| _currentIndex = _controller.index; |
| } |
| _warpUnderwayCount -= 1; |
| |
| return false; |
| } |
| |
| @override |
| Widget build(BuildContext context) { |
| return new NotificationListener<ScrollNotification>( |
| onNotification: _handleScrollNotification, |
| child: new PageView( |
| controller: _pageController, |
| physics: widget.physics == null ? _kTabBarViewPhysics : _kTabBarViewPhysics.applyTo(widget.physics), |
| children: _children, |
| ), |
| ); |
| } |
| } |
| |
| /// Displays a single circle with the specified border and background colors. |
| /// |
| /// Used by [TabPageSelector] to indicate the selected page. |
| class TabPageSelectorIndicator extends StatelessWidget { |
| /// Creates an indicator used by [TabPageSelector]. |
| /// |
| /// The [backgroundColor], [borderColor], and [size] parameters must not be null. |
| const TabPageSelectorIndicator({ |
| Key key, |
| @required this.backgroundColor, |
| @required this.borderColor, |
| @required this.size, |
| }) : assert(backgroundColor != null), assert(borderColor != null), assert(size != null), super(key: key); |
| |
| /// The indicator circle's background color. |
| final Color backgroundColor; |
| |
| /// The indicator circle's border color. |
| final Color borderColor; |
| |
| /// The indicator circle's diameter. |
| final double size; |
| |
| @override |
| Widget build(BuildContext context) { |
| return new Container( |
| width: size, |
| height: size, |
| margin: const EdgeInsets.all(4.0), |
| decoration: new BoxDecoration( |
| color: backgroundColor, |
| border: new Border.all(color: borderColor), |
| shape: BoxShape.circle, |
| ), |
| ); |
| } |
| } |
| |
| /// Displays a row of small circular indicators, one per tab. The selected |
| /// tab's indicator is highlighted. Often used in conjunction with a [TabBarView]. |
| /// |
| /// If a [TabController] is not provided, then there must be a [DefaultTabController] |
| /// ancestor. |
| class TabPageSelector extends StatelessWidget { |
| /// Creates a compact widget that indicates which tab has been selected. |
| const TabPageSelector({ |
| Key key, |
| this.controller, |
| this.indicatorSize: 12.0, |
| this.color, |
| this.selectedColor, |
| }) : assert(indicatorSize != null && indicatorSize > 0.0), super(key: key); |
| |
| /// This widget's selection and animation state. |
| /// |
| /// If [TabController] is not provided, then the value of [DefaultTabController.of] |
| /// will be used. |
| final TabController controller; |
| |
| /// The indicator circle's diameter (the default value is 12.0). |
| final double indicatorSize; |
| |
| /// The indicator circle's fill color for unselected pages. |
| /// |
| /// If this parameter is null then the indicator is filled with [Colors.transparent]. |
| final Color color; |
| |
| /// The indicator circle's fill color for selected pages and border color |
| /// for all indicator circles. |
| /// |
| /// If this parameter is null then the indicator is filled with the theme's |
| /// accent color, [ThemeData.accentColor]. |
| final Color selectedColor; |
| |
| Widget _buildTabIndicator( |
| int tabIndex, |
| TabController tabController, |
| ColorTween selectedColorTween, |
| ColorTween previousColorTween, |
| ) { |
| Color background; |
| if (tabController.indexIsChanging) { |
| // The selection's animation is animating from previousValue to value. |
| final double t = 1.0 - _indexChangeProgress(tabController); |
| if (tabController.index == tabIndex) |
| background = selectedColorTween.lerp(t); |
| else if (tabController.previousIndex == tabIndex) |
| background = previousColorTween.lerp(t); |
| else |
| background = selectedColorTween.begin; |
| } else { |
| // The selection's offset reflects how far the TabBarView has / been dragged |
| // to the previous page (-1.0 to 0.0) or the next page (0.0 to 1.0). |
| final double offset = tabController.offset; |
| if (tabController.index == tabIndex) { |
| background = selectedColorTween.lerp(1.0 - offset.abs()); |
| } else if (tabController.index == tabIndex - 1 && offset > 0.0) { |
| background = selectedColorTween.lerp(offset); |
| } else if (tabController.index == tabIndex + 1 && offset < 0.0) { |
| background = selectedColorTween.lerp(-offset); |
| } else { |
| background = selectedColorTween.begin; |
| } |
| } |
| return new TabPageSelectorIndicator( |
| backgroundColor: background, |
| borderColor: selectedColorTween.end, |
| size: indicatorSize, |
| ); |
| } |
| |
| @override |
| Widget build(BuildContext context) { |
| final Color fixColor = color ?? Colors.transparent; |
| final Color fixSelectedColor = selectedColor ?? Theme.of(context).accentColor; |
| final ColorTween selectedColorTween = new ColorTween(begin: fixColor, end: fixSelectedColor); |
| final ColorTween previousColorTween = new ColorTween(begin: fixSelectedColor, end: fixColor); |
| final TabController tabController = controller ?? DefaultTabController.of(context); |
| assert(() { |
| if (tabController == null) { |
| throw new FlutterError( |
| 'No TabController for $runtimeType.\n' |
| 'When creating a $runtimeType, you must either provide an explicit TabController ' |
| 'using the "controller" property, or you must ensure that there is a ' |
| 'DefaultTabController above the $runtimeType.\n' |
| 'In this case, there was neither an explicit controller nor a default controller.' |
| ); |
| } |
| return true; |
| }()); |
| final Animation<double> animation = new CurvedAnimation( |
| parent: tabController.animation, |
| curve: Curves.fastOutSlowIn, |
| ); |
| return new AnimatedBuilder( |
| animation: animation, |
| builder: (BuildContext context, Widget child) { |
| return new Semantics( |
| label: 'Page ${tabController.index + 1} of ${tabController.length}', |
| child: new Row( |
| mainAxisSize: MainAxisSize.min, |
| children: new List<Widget>.generate(tabController.length, (int tabIndex) { |
| return _buildTabIndicator(tabIndex, tabController, selectedColorTween, previousColorTween); |
| }).toList(), |
| ), |
| ); |
| } |
| ); |
| } |
| } |