{"id":13789822,"url":"https://github.com/hacktons/convex_bottom_bar","last_synced_at":"2025-05-15T19:06:27.089Z","repository":{"id":35227452,"uuid":"214997177","full_name":"hacktons/convex_bottom_bar","owner":"hacktons","description":"A Flutter package which implements a ConvexAppBar to show a convex tab in the bottom bar. Theming supported.","archived":false,"fork":false,"pushed_at":"2023-11-20T10:32:48.000Z","size":19566,"stargazers_count":842,"open_issues_count":30,"forks_count":159,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-04-08T00:37:13.661Z","etag":null,"topics":["appbar","bottomappbar","flutter","navigationbar","notchedtabbar"],"latest_commit_sha":null,"homepage":"https://bar.hacktons.cn","language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hacktons.png","metadata":{"files":{"readme":"README-zh.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":"hacktons","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2019-10-14T09:05:35.000Z","updated_at":"2025-04-06T08:43:26.000Z","dependencies_parsed_at":"2024-06-18T13:43:58.829Z","dependency_job_id":null,"html_url":"https://github.com/hacktons/convex_bottom_bar","commit_stats":null,"previous_names":[],"tags_count":33,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hacktons%2Fconvex_bottom_bar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hacktons%2Fconvex_bottom_bar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hacktons%2Fconvex_bottom_bar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hacktons%2Fconvex_bottom_bar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hacktons","download_url":"https://codeload.github.com/hacktons/convex_bottom_bar/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254404357,"owners_count":22065641,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["appbar","bottomappbar","flutter","navigationbar","notchedtabbar"],"created_at":"2024-08-03T22:00:33.540Z","updated_at":"2025-05-15T19:06:27.063Z","avatar_url":"https://github.com/hacktons.png","language":"Dart","readme":"\u003cp align=\"center\"\u003e\u003cimg src=\"https://github.com/hacktons/convex_bottom_bar/raw/master/doc/preview.png\" alt=\"appBar preview\"\u003e\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://pub.dev/packages/convex_bottom_bar\"\u003e\u003cimg src=\"https://img.shields.io/pub/v/convex_bottom_bar.svg\" alt=\"pub.dev\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/hacktons/convex_bottom_bar\"\u003e\u003cimg src=\"https://img.shields.io/badge/platform-flutter-ff69b4.svg\" alt=\"github\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://coveralls.io/github/hacktons/convex_bottom_bar\"\u003e\u003cimg src=\"https://coveralls.io/repos/github/hacktons/convex_bottom_bar/badge.svg?branch=master\" alt=\"coverage\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://pub.dev/packages/convex_bottom_bar/score\"\u003e\u003cimg src=\"https://img.shields.io/pub/likes/convex_bottom_bar.svg\" alt=\"likes\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://pub.dev/packages/convex_bottom_bar/score\"\u003e\u003cimg src=\"https://img.shields.io/pub/popularity/convex_bottom_bar.svg\" alt=\"popularity\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://codemagic.io/apps/5db10f597d3edb001a6ede16/5db10f597d3edb001a6ede15/latest_build\"\u003e\u003cimg src=\"https://api.codemagic.io/apps/5db10f597d3edb001a6ede16/5db10f597d3edb001a6ede15/status_badge.svg\" alt=\"build status\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/hacktons/convex_bottom_bar/raw/LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/github/license/hacktons/convex_bottom_bar.svg\" alt=\"license\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/hacktons/convex_bottom_bar/blob/master/README.md\"\u003eEnglish\u003c/a\u003e\n    | \u003ca href=\"https://github.com/hacktons/convex_bottom_bar/blob/master/README-zh.md\"\u003e简体中文\u003c/a\u003e\n\u003c/p\u003e\n\n---\n\nConvexBottomBar是一个底部导航栏组件，用于展现凸起的TAB效果，支持多种内置样式与动画交互。你可以在[https://appbar.codemagic.app](https://appbar.codemagic.app)上找到在线样例。 \n\n**convex_bottom_bar 现在是一个 [Flutter Favorite](https://flutter.dev/docs/development/packages-and-plugins/favorites) 插件库!**\n\n\u003ca href=\"https://flutter.dev/docs/development/packages-and-plugins/favorites\"\u003e\n \u003cimg height=\"128\" src=\"https://github.com/hacktons/convex_bottom_bar/raw/master/doc/flutter-favorite.png\"\u003e\n\u003c/a\u003e\n\n以下是一些支持的预定义样式：\n\n|             **fixed**             |            **react**             |      **badge chip**       |\n|:---------------------------------:|:--------------------------------:|:-------------------------:|\n|     ![](doc/appbar-fixed.gif)     |    ![](doc/appbar-react.gif)     | ![](doc/appbar-badge.gif) |\n|          **fixedCircle**          |         **reactCircle**          |         **flip**          |\n| ![](doc/appbar-fixed-circle.gif)  | ![](doc/appbar-react-circle.gif) | ![](doc/appbar-flip.gif)  |\n|            **textIn**             |            **titled**            |       **tab image**       |\n|    ![](doc/appbar-textIn.gif)     |    ![](doc/appbar-titled.gif)    | ![](doc/appbar-image.gif) |\n|            **button**             |         **fixed corner**         |                           |\n| ![](doc/appbar-single-button.png) | ![](doc/appbar-corner-fixed.png) |                           |\n\n## 快速上手\n\n通常ConvexAppBar可以通过设置bottomNavigationBar与Scaffold一起使用。\n\nConvexAppBar具有两个构造函数，ConvexAppBar()将使用默认样式来简化选项卡的创建。\n\n将此添加到您程序包的pubspec.yaml文件中，注意使用最新版本[![Pub](https://img.shields.io/pub/v/convex_bottom_bar.svg)](https://pub.dartlang.org/packages/convex_bottom_bar):\n\n```yaml\ndependencies:\n  convex_bottom_bar: ^latest_version\n```\n\n```dart\nimport 'package:convex_bottom_bar/convex_bottom_bar.dart';\n\nScaffold(\n  bottomNavigationBar: ConvexAppBar(\n    items: [\n      TabItem(icon: Icons.home, title: 'Home'),\n      TabItem(icon: Icons.map, title: 'Discovery'),\n      TabItem(icon: Icons.add, title: 'Add'),\n      TabItem(icon: Icons.message, title: 'Message'),\n      TabItem(icon: Icons.people, title: 'Profile'),\n    ],\n    onTap: (int i) =\u003e print('click index=$i'),\n  )\n);\n```\n\n**Flutter Version Support**\n由于Flutter迭代非常快。SDK本身有可能出现不兼容的API变更，我们将继续支持flutter稳定版本，非稳定的beta、dev channel\n通过单独版本号进行兼容。\n\n| **Stable Flutter Version** | **Package Version** |                  **More**                  |\n|:--------------------------:|:-------------------:|:------------------------------------------:|\n|          \u003e=3.7.0           |       \u003e=3.2.0       | 从v3.7.0版本DefaultTabController的API有变更   |\n|           \u003e=1.20           |       \u003e=2.4.0       | 从 v1.20开始, Stack组件的API发送不兼容变更      |\n|           \u003c1.20            |       \u003c2.4.0        | v1.20稳定版发布后，我们对老版本如v1.17, v1.12 的支持将不再继续更新 |\n\n如果你只需要一个单独的按钮，不妨试试 `ConvexButton`.\n\n## 功能\n\n* 提供多种内部样式\n* 能够更改AppBar的主题\n* 提供Builder API以自定义新样式\n* 在AppBar上添加徽章\n* 支持优雅的过渡动画\n* 提供Hook API来重载一些内部样式\n* RTL布局支持\n\n## Table of contents\n\n- [主题](#主题)\n- [角标](#角标)\n- [单独按钮](#单独按钮)\n- [样式重载](#样式重载)\n- [RTL支持](#RTL支持)\n- [自定义样例](#自定义样例)\n- [常见问题](#常见问题)\n- [支持](#支持)\n\n## 角标\n如果需要在TAB上添加徽章/角标，请使用`ConvexAppBar.badge`来构建。\n\n[![badge demo](doc/badge-demo-preview.gif)](doc/badge-demo.mp4 \"badge demo\")\n\n```dart\nConvexAppBar.badge({0: '99+', 1: Icons.assistant_photo, 2: Colors.redAccent},\n  items: [\n    TabItem(icon: Icons.home, title: 'Home'),\n    TabItem(icon: Icons.map, title: 'Discovery'),\n    TabItem(icon: Icons.add, title: 'Add'),\n  ],\n  onTap: (int i) =\u003e print('click index=$i'),\n);\n```\n\n`badge()`方法接受一个角标数组； 角标是带有选项卡项的映射，每个条目的值可以是String，IconData，Color或Widget。\n\n## 单独按钮\n![button](doc/appbar-single-shape.png)\n\n```dart\nScaffold(\n  appBar: AppBar(title: const Text('ConvexButton Example')),\n  body: Center(child: Text('count $count')),\n  bottomNavigationBar: ConvexButton.fab(\n    onTap: () =\u003e setState(() =\u003e count++),\n  ),\n);\n```\n\n## 主题\nAppBar默认使用内置样式，您可能需要为其设置主题。 以下是一些支持的属性：\n\n![](doc/appbar-theming.png)\n\n| Attributes      | Description                                            |\n|-----------------|--------------------------------------------------------|\n| backgroundColor | AppBar 背景                                             |\n| gradient        | 渐变属性，可以覆盖backgroundColor                         |\n| height          | AppBar 高度                                             |\n| color           | icon/text 的颜色值                                       |\n| activeColor     | icon/text 的**选中态**颜色值                              |\n| curveSize       | 凸形大小                                                 |\n| top             | 凸形到AppBar上边缘的距离                                   |\n| style           | 支持的样式: **fixed, fixedCircle, react, reactCircle**, ... |\n| chipBuilder     | 角标构造器builder,  **ConvexAppBar.badge**会使用默认样式     |\n\n## 样式重载\n重载Tab内置样式。 该API与`ConvexAppBar.builder`不同，为了满足您可能需要更新选项卡样式而不定义新的选项卡样式。\n**温馨提示:**  \n则此Hook能力是有限的，如果您提供的尺寸与内部样式不匹配，并且可能导致`overflow broken`。\n\n```dart\nStyleProvider(\n  style: Style(),\n  child: ConvexAppBar(\n    initialActiveIndex: 1,\n    height: 50,\n    top: -30,\n    curveSize: 100,\n    style: TabStyle.fixedCircle,\n    items: [\n      TabItem(icon: Icons.link),\n      TabItem(icon: Icons.import_contacts),\n      TabItem(title: \"2020\", icon: Icons.work),\n    ],\n    backgroundColor: _tabBackgroundColor,\n  ),\n)\nclass Style extends StyleHook {\n  @override\n  double get activeIconSize =\u003e 40;\n\n  @override\n  double get activeIconMargin =\u003e 10;\n\n  @override\n  double get iconSize =\u003e 20;\n\n  @override\n  TextStyle textStyle(Color color) {\n    return TextStyle(fontSize: 20, color: color);\n  }\n}\n```\n\n## RTL支持\nRTL的内部适配，如果你配置了Directionality，将自动支持ltf和rtl两种布局风格。\n```dart\nDirectionality(\n  textDirection: TextDirection.rtl,\n  child: Scaffold(body:ConvexAppBar(/*TODO ...*/)),\n)\n```\n\n## 自定义样例\n\n如果默认样式与您的情况不符，请尝试使用`ConvexAppBar.builder()`，它可以让您自定义几乎所有TAB样式。\n```dart\nScaffold(\n  bottomNavigationBar: ConvexAppBar.builder(\n    count: 5,\n    backgroundColor: Colors.blue,\n    itemBuilder: Builder(),\n  )\n);\n\n/*user defined class*/\nclass Builder extends DelegateBuilder {\n  @override\n  Widget build(BuildContext context, int index, bool active) {\n    return Text('TAB $index');\n  }\n}\n```\n\n完整的自定义示例可以在[example](example)中找到。\n\n## 常见问题\n如您在使用过程中有新功能建议或者遇到问题，请移步至[issue tracker](https://github.com/hacktons/convex_bottom_bar/issues)提交。\n\n* [如何拦截Tab事件](doc/how-to-block-tab-event.md)\n* [Flutter dev/beta channel运行崩溃](doc/issue-crash-on-flutter-dev-channel.md)\n* [动态修改选中的TAB](doc/issue-change-active-tab-index.md)\n* [如何给TAB添加图片而不是ICON](doc/issue-image-for-actionitem.md)\n* [如何移除AppBar的边缘阴影](doc/issue-remove-elevation.md) \n\n## 支持\n如果对你有帮助，微信扫码请作者喝杯咖啡 :)\n\n![donate](doc/donate-wechat.jpeg)","funding_links":["https://ko-fi.com/hacktons"],"categories":["Packages"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhacktons%2Fconvex_bottom_bar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhacktons%2Fconvex_bottom_bar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhacktons%2Fconvex_bottom_bar/lists"}