Skip to content

Commit 29ff750

Browse files
committed
reorder the instruction in README
1 parent 33d3834 commit 29ff750

File tree

6 files changed

+53
-33
lines changed

6 files changed

+53
-33
lines changed

README-zh.md

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,26 @@
1-
![preview](doc/preview.png)
1+
<p align="center"><img src="https://github.com/hacktons/convex_bottom_bar/raw/master/doc/preview.png" alt="appBar preview"></p>
2+
<p align="center">
3+
<a href="https://pub.dartlang.org/packages/convex_bottom_bar"><img src="https://img.shields.io/pub/v/convex_bottom_bar.svg" alt="pub.dev"></a>
4+
<a href="https://github.com/hacktons/convex_bottom_bar"><img src="https://img.shields.io/badge/platform-flutter-ff69b4.svg" alt="github"></a>
5+
<a href="https://codemagic.io/apps/5db10f597d3edb001a6ede16/5db10f597d3edb001a6ede15/latest_build"><img src="https://api.codemagic.io/apps/5db10f597d3edb001a6ede16/5db10f597d3edb001a6ede15/status_badge.svg" alt="build status"></a>
6+
<a href="https://coveralls.io/github/hacktons/convex_bottom_bar"><img src="https://coveralls.io/repos/github/hacktons/convex_bottom_bar/badge.svg" alt="coverage status"></a>
7+
<a href="https://github.com/hacktons/convex_bottom_bar/raw/LICENSE"><img src="https://img.shields.io/github/license/hacktons/convex_bottom_bar.svg" alt="license"></a>
8+
</p>
9+
<p align="center">
10+
<a href="https://github.com/hacktons/convex_bottom_bar/raw/master/README.md">English</a>
11+
|<a href="https://github.com/hacktons/convex_bottom_bar/raw/master/README-zh.md">简体中文</a>
12+
</p>
13+
14+
---
15+
16+
ConvexBottomBar是一个底部导航栏组件,用于展现凸起的TAB效果,支持多种内置样式与动画交互。你可以在[https://appbar.codemagic.app](https://appbar.codemagic.app)上找到在线样例。
217

3-
语言: [English](README.md)|[简体中文](README-zh.md)
4-
# convex_bottom_bar
5-
6-
[![Pub](https://img.shields.io/pub/v/convex_bottom_bar.svg)](https://pub.dartlang.org/packages/convex_bottom_bar)
7-
[![github](https://img.shields.io/badge/platform-flutter-ff69b4.svg)](https://github.com/hacktons/convex_bottom_bar)
8-
[![Codemagic build status](https://api.codemagic.io/apps/5db10f597d3edb001a6ede16/5db10f597d3edb001a6ede15/status_badge.svg)](https://codemagic.io/apps/5db10f597d3edb001a6ede16/5db10f597d3edb001a6ede15/latest_build)
9-
[![Coverage Status](https://coveralls.io/repos/github/hacktons/convex_bottom_bar/badge.svg)](https://coveralls.io/github/hacktons/convex_bottom_bar)
18+
**convex_bottom_bar 现在是一个 [Flutter Favorite](https://flutter.dev/docs/development/packages-and-plugins/favorites) 插件库!**
1019

1120
<a href="https://flutter.dev/docs/development/packages-and-plugins/favorites">
12-
<img height="128" src="https://github.com/hacktons/convex_bottom_bar/raw/master/doc/flutter-favorite.png">
21+
<img height="128" src="https://github.com/hacktons/convex_bottom_bar/raw/master/doc/flutter-favorite.png">
1322
</a>
1423

15-
**convex_bottom_bar 现在是一个 [Flutter Favorite](https://flutter.dev/docs/development/packages-and-plugins/favorites) 插件库!**
16-
17-
官方的BottomAppBar只能显示带有凹形FAB的导航栏,有时我们需要凸形FAB。 ConvexAppBar的开发受BottomAppBar和NotchShape的实现启发。
18-
19-
可以在[https://appbar.codemagic.app](https://appbar.codemagic.app)上找到在线示例。
20-
2124
以下是一些支持的预定义样式:
2225

2326
| **fixed** | **react** | **badge chip** |
@@ -91,10 +94,11 @@ Scaffold(
9194
- [RTL支持](#RTL支持)
9295
- [自定义样例](#自定义样例)
9396
- [常见问题](#常见问题)
94-
- [贡献](#贡献)
97+
- [支持](#支持)
9598

9699
## 角标
97100
如果需要在TAB上添加徽章/角标,请使用`ConvexAppBar.badge`来构建。
101+
98102
[![badge demo](doc/badge-demo-preview.gif)](doc/badge-demo.mp4 "badge demo")
99103

100104
```dart
@@ -111,7 +115,7 @@ ConvexAppBar.badge({0: '99+', 1: Icons.assistant_photo, 2: Colors.redAccent},
111115
`badge()`方法接受一个角标数组; 角标是带有选项卡项的映射,每个条目的值可以是String,IconData,Color或Widget。
112116

113117
## 单独按钮
114-
![button](https://github.com/hacktons/convex_bottom_bar/raw/stable/doc/appbar-single-shape.png)
118+
![button](doc/appbar-single-shape.png)
115119

116120
```dart
117121
Scaffold(
@@ -140,8 +144,6 @@ AppBar默认使用内置样式,您可能需要为其设置主题。 以下是
140144
| style | 支持的样式: **fixed, fixedCircle, react, reactCircle**, ... |
141145
| chipBuilder | 角标构造器builder, **ConvexAppBar.badge**会使用默认样式 |
142146

143-
![](doc/appbar-demo.gif)
144-
145147
## 样式重载
146148
重载Tab内置样式。 该API与`ConvexAppBar.builder`不同,为了满足您可能需要更新选项卡样式而不定义新的选项卡样式。
147149
**温馨提示:**
@@ -217,11 +219,12 @@ class Builder extends DelegateBuilder {
217219
## 常见问题
218220
如您在使用过程中有新功能建议或者遇到问题,请移步至[issue tracker](https://github.com/hacktons/convex_bottom_bar/issues)提交。
219221

222+
* [Flutter dev/beta channel运行崩溃](doc/issue-crash-on-flutter-dev-channel.md)
220223
* [动态修改选中的TAB](doc/issue-change-active-tab-index.md)
221224
* [如何给TAB添加图片而不是ICON](doc/issue-image-for-actionitem.md)
222225
* [如何移除AppBar的边缘阴影](doc/issue-remove-elevation.md)
223226

224227
## 支持
225228
如果对你有帮助,微信扫码请作者喝杯咖啡 :)
226229

227-
![donate](doc/donate-wechat.png)
230+
![donate](doc/donate-wechat.jpeg)

README.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,28 @@
1-
![preview](doc/preview.png)
1+
<p align="center"><img src="https://github.com/hacktons/convex_bottom_bar/raw/master/doc/preview.png" alt="appBar preview"></p>
2+
<p align="center">
3+
<a href="https://pub.dartlang.org/packages/convex_bottom_bar"><img src="https://img.shields.io/pub/v/convex_bottom_bar.svg" alt="pub.dev"></a>
4+
<a href="https://github.com/hacktons/convex_bottom_bar"><img src="https://img.shields.io/badge/platform-flutter-ff69b4.svg" alt="github"></a>
5+
<a href="https://codemagic.io/apps/5db10f597d3edb001a6ede16/5db10f597d3edb001a6ede15/latest_build"><img src="https://api.codemagic.io/apps/5db10f597d3edb001a6ede16/5db10f597d3edb001a6ede15/status_badge.svg" alt="build status"></a>
6+
<a href="https://coveralls.io/github/hacktons/convex_bottom_bar"><img src="https://coveralls.io/repos/github/hacktons/convex_bottom_bar/badge.svg" alt="coverage status"></a>
7+
<a href="https://github.com/hacktons/convex_bottom_bar/raw/LICENSE"><img src="https://img.shields.io/github/license/hacktons/convex_bottom_bar.svg" alt="license"></a>
8+
</p>
9+
<p align="center">
10+
<a href="https://github.com/hacktons/convex_bottom_bar/raw/master/README.md">English</a>
11+
|<a href="https://github.com/hacktons/convex_bottom_bar/raw/master/README-zh.md">简体中文</a>
12+
</p>
13+
14+
---
215

3-
Languages: [English](README.md)|[简体中文](README-zh.md)
4-
# convex_bottom_bar
16+
The official BottomAppBar can only display a notch FAB with app bar, sometimes we need a convex FAB. This ConvexAppBar is inspired by BottomAppBar and NotchShape's implementation.
517

6-
[![Pub](https://img.shields.io/pub/v/convex_bottom_bar.svg)](https://pub.dartlang.org/packages/convex_bottom_bar)
7-
[![github](https://img.shields.io/badge/platform-flutter-ff69b4.svg)](https://github.com/hacktons/convex_bottom_bar)
8-
[![Codemagic build status](https://api.codemagic.io/apps/5db10f597d3edb001a6ede16/5db10f597d3edb001a6ede15/status_badge.svg)](https://codemagic.io/apps/5db10f597d3edb001a6ede16/5db10f597d3edb001a6ede15/latest_build)
9-
[![Coverage Status](https://coveralls.io/repos/github/hacktons/convex_bottom_bar/badge.svg)](https://coveralls.io/github/hacktons/convex_bottom_bar)
18+
Online example can be found at [https://appbar.codemagic.app](https://appbar.codemagic.app).
19+
20+
**convex_bottom_bar is now a [Flutter Favorite](https://flutter.dev/docs/development/packages-and-plugins/favorites) package!**
1021

1122
<a href="https://flutter.dev/docs/development/packages-and-plugins/favorites">
1223
<img height="128" src="https://github.com/hacktons/convex_bottom_bar/raw/master/doc/flutter-favorite.png">
1324
</a>
1425

15-
**convex_bottom_bar is now a [Flutter Favorite](https://flutter.dev/docs/development/packages-and-plugins/favorites) package!**
16-
17-
The official BottomAppBar can only display a notch FAB with app bar, sometimes we need a convex FAB. This ConvexAppBar is inspired by BottomAppBar and NotchShape's implementation.
18-
19-
Online example can be found at [https://appbar.codemagic.app](https://appbar.codemagic.app).
20-
2126
Here are some supported style:
2227

2328
| **fixed** | **react** | **badge chip** |
@@ -221,6 +226,7 @@ Full custom example can be found at [example](example).
221226
## FAQ
222227
Please file feature requests and bugs at the [issue tracker](https://github.com/hacktons/convex_bottom_bar/issues).
223228

229+
* [Crash on flutter dev/beta channel](doc/issue-crash-on-flutter-dev-channel.md)
224230
* [Change active tab index programmatically](doc/issue-change-active-tab-index.md)
225231
* [Using an image instead of an icon for actionItem](doc/issue-image-for-actionitem.md)
226232
* [Is there anyway to remove elevation in the bottom bar?](doc/issue-remove-elevation.md)

doc/appbar-single-shape.png

-1.65 KB
Loading

doc/donate-wechat.jpeg

47 KB
Loading

doc/donate-wechat.png

-47.7 KB
Binary file not shown.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Crash on Flutter dev/beta channel
2+
3+
As Flutter is developing fast. There can be breaking changes, we will trying to support the
4+
stable version and beta version through different package version.
5+
6+
If you're using unstable Flutter channel, please follow the table bellow to use the proper package version.
7+
8+
| **Stable Flutter Version** | **Package Version** | **More** |
9+
| :------------------------: | :-----------------: | :----------------------------------------------------------: |
10+
| >=1.20 | >=2.4.0 | Since v1.20, the stable version changed the Stack api |
11+
| <1.20 | <=2.3.0 | Support for stable version such as v1.17, v1.12 is not going to be updated |

0 commit comments

Comments
 (0)