Skip to content

Commit ddb58b0

Browse files
avenwuavenwu
committed
Update version description
1 parent 6ac3622 commit ddb58b0

File tree

2 files changed

+50
-49
lines changed

2 files changed

+50
-49
lines changed

‎README-zh.md‎

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@ ConvexBottomBar是一个底部导航栏组件，用于展现凸起的TAB效果
2525

2626
以下是一些支持的预定义样式：
2727

28-
| **fixed** | **react** | **badge chip** |
29-
| :------------------------------: | :------------------------------: | :------------------------------: |
30-
| ![](doc/appbar-fixed.gif) | ![](doc/appbar-react.gif) | ![](doc/appbar-badge.gif) |
31-
| **fixedCircle** | **reactCircle** | **flip** |
32-
| ![](doc/appbar-fixed-circle.gif) | ![](doc/appbar-react-circle.gif) | ![](doc/appbar-flip.gif) |
33-
| **textIn** | **titled** | **tab image** |
34-
| ![](doc/appbar-textIn.gif) | ![](doc/appbar-titled.gif) | ![](doc/appbar-image.gif) |
35-
| **button** | **fixed corner** | |
36-
| ![](doc/appbar-single-button.png) | ![](doc/appbar-corner-fixed.png) | |
28+
| **fixed** | **react** | **badge chip** |
29+
|:---------------------------------:|:--------------------------------:|:-------------------------:|
30+
| ![](doc/appbar-fixed.gif) | ![](doc/appbar-react.gif) | ![](doc/appbar-badge.gif) |
31+
| **fixedCircle** | **reactCircle** | **flip** |
32+
| ![](doc/appbar-fixed-circle.gif) | ![](doc/appbar-react-circle.gif) | ![](doc/appbar-flip.gif) |
33+
| **textIn** | **titled** | **tab image** |
34+
| ![](doc/appbar-textIn.gif) | ![](doc/appbar-titled.gif) | ![](doc/appbar-image.gif) |
35+
| **button** | **fixed corner** | |
36+
| ![](doc/appbar-single-button.png) | ![](doc/appbar-corner-fixed.png) | |
3737

3838
## 快速上手
3939

@@ -69,10 +69,11 @@ Scaffold(
6969
由于Flutter迭代非常快。SDK本身有可能出现不兼容的API变更，我们将继续支持flutter稳定版本，非稳定的beta、dev channel
7070
通过单独版本号进行兼容。
7171

72-
| **Stable Flutter Version** | **Package Version** | **More** |
73-
| :------------------------------: | :------------------------------: | :------------------------------: |
74-
| >=1.20 | >=2.4.0 | 从 v1.20开始, Stack组件的API发送不兼容变更 |
75-
| <1.20 | <2.4.0 | v1.20稳定版发布后，我们对老版本如v1.17, v1.12 的支持将不再继续更新 |
72+
| **Stable Flutter Version** | **Package Version** | **More** |
73+
|:--------------------------:|:-------------------:|:------------------------------------------:|
74+
| >=3.7.0 | >=3.2.0 | 从v3.7.0版本DefaultTabController的API有变更 |
75+
| >=1.20 | >=2.4.0 | 从 v1.20开始, Stack组件的API发送不兼容变更 |
76+
| <1.20 | <2.4.0 | v1.20稳定版发布后，我们对老版本如v1.17, v1.12 的支持将不再继续更新 |
7677

7778
如果你只需要一个单独的按钮，不妨试试 `ConvexButton`.
7879

@@ -133,17 +134,17 @@ AppBar默认使用内置样式，您可能需要为其设置主题。 以下是
133134

134135
![](doc/appbar-theming.png)
135136

136-
| Attributes | Description |
137-
| --------------- | ------------------------------------- |
138-
| backgroundColor | AppBar 背景 |
139-
| gradient | 渐变属性，可以覆盖backgroundColor|
140-
| height | AppBar 高度 |
141-
| color | icon/text 的颜色值 |
142-
| activeColor | icon/text 的**选中态**颜色值 |
143-
| curveSize | 凸形大小 |
144-
| top | 凸形到AppBar上边缘的距离 |
145-
| style | 支持的样式: **fixed, fixedCircle, react, reactCircle**, ... |
146-
| chipBuilder | 角标构造器builder, **ConvexAppBar.badge**会使用默认样式 |
137+
| Attributes | Description |
138+
|-----------------|--------------------------------------------------------|
139+
| backgroundColor | AppBar 背景 |
140+
| gradient | 渐变属性，可以覆盖backgroundColor |
141+
| height | AppBar 高度 |
142+
| color | icon/text 的颜色值 |
143+
| activeColor | icon/text 的**选中态**颜色值 |
144+
| curveSize | 凸形大小 |
145+
| top | 凸形到AppBar上边缘的距离 |
146+
| style | 支持的样式: **fixed, fixedCircle, react, reactCircle**, ... |
147+
| chipBuilder | 角标构造器builder, **ConvexAppBar.badge**会使用默认样式 |
147148

148149
## 样式重载
149150
重载Tab内置样式。 该API与`ConvexAppBar.builder`不同，为了满足您可能需要更新选项卡样式而不定义新的选项卡样式。

‎README.md‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,15 @@ Online example can be found at [https://appbar.codemagic.app](https://appbar.cod
2727

2828
Here are some supported style:
2929

30-
| **fixed** | **react** | **badge chip** |
31-
| :------------------------------: | :------------------------------: | :------------------------------: |
32-
| ![](doc/appbar-fixed.gif) | ![](doc/appbar-react.gif) | ![](doc/appbar-badge.gif) |
33-
| **fixedCircle** | **reactCircle** | **flip** |
34-
| ![](doc/appbar-fixed-circle.gif) | ![](doc/appbar-react-circle.gif) | ![](doc/appbar-flip.gif) |
35-
| **textIn** | **titled** | **tab image** |
36-
| ![](doc/appbar-textIn.gif) | ![](doc/appbar-titled.gif) | ![](doc/appbar-image.gif) |
37-
| **button** | **fixed corner** | |
38-
| ![](doc/appbar-single-button.png) | ![](doc/appbar-corner-fixed.png) | |
39-
30+
| **fixed** | **react** | **badge chip** |
31+
|:---------------------------------:|:--------------------------------:|:-------------------------:|
32+
| ![](doc/appbar-fixed.gif) | ![](doc/appbar-react.gif) | ![](doc/appbar-badge.gif) |
33+
| **fixedCircle** | **reactCircle** | **flip** |
34+
| ![](doc/appbar-fixed-circle.gif) | ![](doc/appbar-react-circle.gif) | ![](doc/appbar-flip.gif) |
35+
| **textIn** | **titled** | **tab image** |
36+
| ![](doc/appbar-textIn.gif) | ![](doc/appbar-titled.gif) | ![](doc/appbar-image.gif) |
37+
| **button** | **fixed corner** | |
38+
| ![](doc/appbar-single-button.png) | ![](doc/appbar-corner-fixed.png) | |
4039

4140
## How to use
4241
Typically ConvexAppBar can work with `Scaffold` by setup its `bottomNavigationBar`.
@@ -71,10 +70,11 @@ Scaffold(
7170
As Flutter is developing fast. There can be breaking changes. We will be trying to support the
7271
stable version and beta version through different package versions.
7372

74-
| **Stable Flutter Version** | **Package Version** | **More** |
75-
| :------------------------------: | :------------------------------: | :------------------------------: |
76-
| >=1.20 | >=2.4.0 | Since v1.20, the stable version changed the Stack api |
77-
| <1.20 | <=2.3.0 | Support for stable version such as v1.17, v1.12 is not going to be updated |
73+
| **Stable Flutter Version** | **Package Version** | **More** |
74+
|:--------------------------:|:-------------------:|:--------------------------------------------------------------------------:|
75+
| >=3.7.0 | >=3.2.0 | Since v3.7.0, the stable version changed the DefaultTabController api |
76+
| >=1.20 | >=2.4.0 | Since v1.20, the stable version changed the Stack api |
77+
| <1.20 | <=2.3.0 | Support for stable version such as v1.17, v1.12 is not going to be updated |
7878

7979
## Features
8080
* Provide multiple internal styles
@@ -101,18 +101,18 @@ The bar will use default style, you may want to theme it. Here are some supporte
101101

102102
![](doc/appbar-theming.png)
103103

104-
| Attributes | Description |
105-
| --------------- | ------------------------------------- |
106-
| backgroundColor | AppBar background |
107-
| gradient | gradient will override backgroundColor|
108-
| height | AppBar height |
109-
| color | tab icon/text color |
110-
| activeColor | tab icon/text color **when selected** |
111-
| curveSize | size of the convex shape |
112-
| top | top edge of the convex shape relative to AppBar |
104+
| Attributes | Description |
105+
|-----------------|--------------------------------------------------------------------------------------|
106+
| backgroundColor | AppBar background |
107+
| gradient | gradient will override backgroundColor |
108+
| height | AppBar height |
109+
| color | tab icon/text color |
110+
| activeColor | tab icon/text color **when selected** |
111+
| curveSize | size of the convex shape |
112+
| top | top edge of the convex shape relative to AppBar |
113113
| cornerRadius | draw the background with topLeft and topRight corner; Only work with fixed tab style |
114-
| style | style to describe the convex shape: **fixed, fixedCircle, react, reactCircle**, ... |
115-
| chipBuilder | custom badge builder, use **ConvexAppBar.badge** for default badge |
114+
| style | style to describe the convex shape: **fixed, fixedCircle, react, reactCircle**, ... |
115+
| chipBuilder | custom badge builder, use **ConvexAppBar.badge** for default badge |
116116

117117
## Badge
118118

0 commit comments

Comments
 (0)