Flutter 自定义TabBar,实现 高度 和 标题与图标距离 可自定义的方案与实践

TabBar 是基本每个App都会使用到的一个控件,在官方内置的 TabBar 的高度只有两种规格且是不可修改的:

//未设置 Icon 时的高度
const double _kTabHeight = 46.0;
//设置 Icon 之后的高度
const double _kTextAndIconTabHeight = 72.0;

标题与Icon之间的距离也是写死的:

margin: const EdgeInsets.only(bottom: 10.0),

Tab高度/文本与Icon的距离 设置详见 class Tab 源码:

class Tab extends StatelessWidget {
  const Tab({
    Key key,
    this.text,
    this.icon,
    this.child,
  }) : assert(text != null || child != null || icon != null),
       assert(!(text != null && null != child)), 
       super(key: key);

  final String text;

  final Widget child;

  final Widget icon;

  Widget _buildLabelText() {
    return child ?? Text(text, softWrap: false, overflow: TextOverflow.fade);
  }

  @override
  Widget build(BuildContext context) {
    assert(debugCheckHasMaterial(context));

    double height;
    Widget label;
    if (icon == null) {//当没有设置 Icon 时,Tab 高度 height 取值 _kTabHeight
      height = _kTabHeight;
      label = _buildLabelText();
    } else if (text == null && child == null) {//当没有设置 text 和 child 时,Tab 高度 height 取值 _kTabHeight
      height = _kTabHeight;
      label = icon;
    } else {//其它情况, Tab 高度 height 取值 _kTextAndIconTabHeight
      height = _kTextAndIconTabHeight;
      label = Column(
        mainAxisAlignment: MainAxisAlignment.center,
        crossAxisAlignment: CrossAxisAlignment.center,
        children: <Widget>[
          Container(
            child: icon,
            margin: const EdgeInsets.only(bottom: 10.0),//这里设置的是 text 和 Icon 的距离
          ),
          _buildLabelText(),
        ],
      );
    }

    return SizedBox(
      height: height,
      child: Center(
        child: label,
        widthFactor: 1.0,
      ),
    );
  }
  
  @override
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(StringProperty('text', text, defaultValue: null));
    properties.add(DiagnosticsProperty<Widget>('icon', icon, defaultValue: null));
  }
}

但是很多时候,我们会需要调整一下TabBar的高度或者标题文本与Icon之间的距离以达到我们UI的要求,而内置的TabBar是无法自定义设置这些参数的,这时候我们就要使出我们的绝招:魔改。
首先上一下我的魔改效果:


image

第一步:把TabBar源码复制一份,为了避免和系统内置的TabBar冲突,把复制的文件里面的class都改个名,比如我 把 class Tab 改为 class ZTab、class TabBar 改为 class ZTabBar 等等

第二步:class ZTab 新增我们需要的属性 :

class ZTab extends StatelessWidget {
  const ZTab({
    Key key,
    this.text,
    this.icon,
    this.child,
    this.tabHeight = _kTabHeight,
    this.textToIconMargin = 0.0,
  }) : assert(text != null || child != null || icon != null),
        assert(!(text != null && null != child)), 
        assert(textToIconMargin >= 0.0),
        super(key: key);

  /// Tab高度,默认 _kTabHeight
  final double tabHeight;
  /// Tab 文本与图标的距离,默认 0.0
  final double textToIconMargin;

  ...
}

然后在 class ZTab 的 build 里面进行设置:

@override
  Widget build(BuildContext context) {
    assert(debugCheckHasMaterial(context));

    double height;
    Widget label;

    if (icon == null) {
      height = _kTabHeight;
      label = _buildLabelText();
    } else if (text == null && child == null) {
      height = _kTabHeight;
      label = icon;
    } else {
      height = _kTextAndIconTabHeight;
      label = Column(
        mainAxisAlignment: MainAxisAlignment.center,
        crossAxisAlignment: CrossAxisAlignment.center,
        children: <Widget>[
          Container(
            child: icon,
            ///这里设置文字与图片的距离
            ///使用自定义的 textToIconMargin
            margin: EdgeInsets.only(bottom: textToIconMargin),
          ),
          _buildLabelText(),
        ],
      );
    }

    ///如果Tab自定义的高度大于 _kTabHeight 则 Tab 使用自定义的高度
    ///我在这里做了限制,限制条件可以自己设置
    if (tabHeight > _kTabHeight) {
      height = tabHeight;
    }

    return SizedBox(
      height: height,
      child: Center(
        child: label,
        widthFactor: 1.0,
      ),
    );
  }

以上修改就可以实现TabBar高度和文本与Icon距离的自定义了,但是在使用的时候,每个Tab都需要设置tabHeight和textToIconMargin,相当繁琐且可能造成设置不统一:

TabBar(
  controller: _tabController,
  tabs: [
    ZTab(text: "Home", icon: Icon(Icons.home, size: 27,), tabHeight: 54.0, textToIconMargin: 0.0,),
    ZTab(text: "Business", icon: Icon(Icons.business, size: 27,), tabHeight: 54.0, textToIconMargin: 0.0,),
    ZTab(text: "Me", icon: Icon(Icons.person, size: 27,), tabHeight: 54.0, textToIconMargin: 0.0,),
  ]
)

为了方便使用和减少错误,继续改造:
新增 Tab 辅助类 ZTabHelper:

///Tab 辅助类
class ZTabHelper {
  const ZTabHelper({
    this.text,
    this.icon,
    this.child,
  }) : assert(text != null || child != null || icon != null),
        assert(!(text != null && null != child));

  final String text;
  final Widget child;
  final Widget icon;
}

修改 class ZTabBar构造方法:

class ZTabBar extends StatefulWidget implements PreferredSizeWidget {
  const ZTabBar({
    Key key,
    ...
    @required this.tabs,
    this.tabHeight = _kTabHeight,
    this.textToIconMargin = 0.0,
  }) : assert(tabs != null),
        assert(isScrollable != null),
        assert(dragStartBehavior != null),
        assert(indicator != null || (indicatorWeight != null && indicatorWeight > 0.0)),
        assert(indicator != null || (indicatorPadding != null)),
        super(key: key);

  /// Tab高度 和 文字与图标的距离 统一提取到 ZTabBar 里面设置
  /// Tab高度
  final double tabHeight;
  /// Tab 文字与图标的距离
  final double textToIconMargin;

  /// 从直接设置 Tab 列表改为设置我们自定义的 ZTabHelper
  final List<ZTabHelper> tabs;
  
  ...
}

修改 @override Size get preferredSize:

@override  
Size get preferredSize {
  for (ZTabHelper item in tabs) {
    if (item is ZTab) {
      final ZTabHelper tab = item;
      if (tab.text != null && tab.icon != null) {
        ///做一下判断,是否使用的是自定义高度
        if (tabHeight > _kTabHeight) {
          return Size.fromHeight(tabHeight + indicatorWeight);
        } else {
          return Size.fromHeight(_kTextAndIconTabHeight + indicatorWeight);
        }       
      }
    }
  }
  ///做一下判断,是否使用的是自定义高度
  if (tabHeight > _kTabHeight) {
    return Size.fromHeight(tabHeight + indicatorWeight);
  } else {
    return Size.fromHeight(_kTabHeight + indicatorWeight);
  }
}

修改 class _ZTabBarState:

class _ZTabBarState extends State<ZTabBar> {
  ...
  ///新增一个存放Tab的列表
  List<Widget> _tabs = <Widget>[];

  @override
  void initState() {
    ///首先判断 _textToIconMargin, 如果 _textToIconMargin 小于 0 会报错
    double _textToIconMargin = widget.textToIconMargin;
    if (_textToIconMargin < 0) {
      _textToIconMargin = 0.0;
    }
    ///循环创建 Tab
    ///必须在 super.initState(); 之前创建好 Tab 列表,不然 build 的时候报错
    widget.tabs.forEach((zTabHelper){
      _tabs.add(ZTab(text: zTabHelper.text, icon: zTabHelper.icon, child: zTabHelper.child, tabHeight: widget.tabHeight, textToIconMargin: _textToIconMargin,));
    });
    _tabKeys = _tabs.map((Widget tab) => GlobalKey()).toList();

    super.initState();
  }
  
  ...
  
  @override
  Widget build(BuildContext context) {
    ...

    final List<Widget> wrappedTabs = List<Widget>(widget.tabs.length);
    for (int i = 0; i < widget.tabs.length; i += 1) {
      wrappedTabs[i] = Center(
        heightFactor: 1.0,
        child: Padding(
          padding: widget.labelPadding ?? tabBarTheme.labelPadding ?? kTabLabelPadding,
          child: KeyedSubtree(
            key: _tabKeys[i],
            child: _tabs[i],//改为我们在initState里面创建的tab列表
          ),
        ),
      );

    }

    ...

    return tabBar;
  }
}

如此,一个可实现 高度 和 标题与图标距离 自定义的TabBar就改造好了。
使用:

ZTabBar(
  controller: _tabController,
  tabHeight: 54.0,//自定义Tab高度
  textToIconMargin: 0.0,//自定义标题与图标距离
  tabs: [
    ZTabHelper(text: "Home", icon: Icon(Icons.home, size: 27,),),
    ZTabHelper(text: "Business", icon: Icon(Icons.business, size: 27,),),
    ZTabHelper(text: "Me", icon: Icon(Icons.person, size: 27,),),
  ]
)
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,968评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,601评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,220评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,416评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,425评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,144评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,432评论 3 401
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,088评论 0 261
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,586评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,028评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,137评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,783评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,343评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,333评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,559评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,595评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,901评论 2 345

推荐阅读更多精彩内容

  • “悟”字,左为“心”,右为“吾”。“心”字不难理解,“吾”字是我,“我”就是自己!寻千人,问万次,最后是自己用心领...
    辉煌Ad098阅读 240评论 0 3
  • 子谓子贱,君子哉若人,鲁无君子者,斯焉取斯? 关注公众号:文化传薪133 里面有更精彩内容 孔子大概在这里对学生们...
    文化传薪阅读 241评论 0 0