Add example usage for State

hacktons · Feb 18, 2020 · 81164c6 · 81164c6
1 parent 8b709f9
commit 81164c6
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,7 +1,8 @@
-## [2.1.0-beta]
+## [2.1.0-beta+1]
 
 * Add controller for Appbar to change tab index programmaticlly;
 * Support with framework's DefaultTabController and TabController;
+* Enable access to the ConvexAppBarState;
 
 ## [2.0.3]
 

diff --git a/doc/issue-change-active-tab-index.md b/doc/issue-change-active-tab-index.md
@@ -46,3 +46,15 @@ DefaultTabController(
   bottomNavigationBar: ConvexAppBar(controller: _tabController/* some config*/),
 );
 ``` 
+## The raw way
+If you don't use TabController at all, then you have to update tab index manually through `ConvexAppBarState`.
+This usually requires a defined `GlobalKey` set with `ConvexAppBar`:
+
+```dart
+// define field instance
+GlobalKey<ConvexAppBarState> _appBarKey = GlobalKey<ConvexAppBarState>();
+// construct with key
+ConvexAppBar(key: _appBarKey, /* ... */);
+// access related State when necessary such as onPageChanged
+_appBarKey.currentState.animateTo(2/* index*/);
+```
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,6 +1,6 @@
 name: convex_bottom_bar
 description: A Flutter package which implements a ConvexAppBar to show a convex tab in the bottom bar. Theming supported.
-version: 2.1.0-beta
+version: 2.1.0-beta+1
 homepage: https://github.com/hacktons/convex_bottom_bar
 
 environment: