Hello friends, sometime back one of the readers commented on my story asking me to write about TabBar and TabBarView widgets. So here it is, we will be talking about these two widgets, and also we will be discussing the DefaultTabBarController and TabController as well.
If you are coming from Android Development you might agree with me on this that creating a Tabbed layout in Android is not as easy as it is in Flutter. I am an Android Developer as well, and around 2 years back I started with Flutter development, well I struggled a bit at the start but when you compare it to Android development it is very easy to learn and I was actually zapped by the customizations you can do in Flutter. We will go through it all and a lot more in this story on TabBar and TabBarView.
Look at the image below to get an overview of how a TabBar works.
Now let us look at the constructor of TabBar first, which is long, but I will bifurcate it into 3 parts so that it is easier to understand.
// indicator properties
TabBar(
indicatorColor: Colors.white,
indicatorWeight: 2.0,
indicatorPadding: EdgeInsets.zero,
indicatorSize: TabBarIndicatorSize.label,
indicator: BoxDecoration(),
------------------------------------------------
// label properties
labelColor: Colors.white,
labelStyle: TextStyle(),
labelPadding: EdgeInsets.only(top: 10.0),
unselectedLabelColor: Colors.grey,
unselectedLabelStyle: TextStyle(),
------------------------------------------------
// behavior properties
isScrollable: false,
// only if DefaultTabContoller is not used.
controller: _tabController,
dragStartBehavior: DragStartBehavior.start,
mouseCursor: SystemMouseCursors.noDrop,
physics: ScrollPhysics(parent: AlwaysScrollableScrollPhysics()),
onTap: (){},
tabs: [Tab(),] // @required list of TabsIf you look closely at the constructor above I have grouped it into three parts, there are five properties pertaining to the indicator and another five related to labels, and the last 7 properties are applicable to the behavior of the TabBar.
Step 1:
Now to build the TabBar layout in your application the first thing you will need is the Controller. There are two ways to do it: either you can use the DefaultTabController or you can build your own TabController.
tip: if you are using a stateless widget then using the DefaultTabController is the best approach. If you are using a stateful widget then you should be building your own TabController.
The DefaultTabController has 3 parameters and you need to wrap your Scaffold inside the DefaultTabController.
return DefaultTabController(
initialIndex: 1, // default is 0
length: 3, // Number of Tabs
child: Scaffold() // Main Layout
);Step 2:
The next step is the TabBar itself which I discussed earlier, customize your TabBar the way that best suits you according to the parameters mentioned above in the constructor. In the above TabBar constructor, I have mentioned what value each takes in or what widget needs to be used along with that property. Additionally, the onTap() function can be used if you want to alert users by showing a dialogBox or a snackBar or route to another page.
Step 3:
As a required property of TabBar is a list of Tabs, it basically means how many pages you want to create, accordingly, you need to add the Tabs and customize the Icon and Label of the Tabs with the constructor given below and refer to the image of TabBar layout overview.
Tab(
text: 'Radio', // label of the Tab
icon: Icon( // Icon above the label
Icons.radio,
color: Colors.white,),
iconMargin: EdgeInsets.only(bottom: 10.0), // default margin
child: ), // add child widgettip: there are three main parameters of the Tab widget, the text, icon, and iconMargin. If you would like to further customize your Tab then you can use the child property, for example, add an image instead of text and icon. The child property can only be used if you haven’t mentioned text and icon, otherwise, your app will throw an error.
Tab(
child: Image.asset('images/android.png'),
),
Tab(
text: 'Radio',
icon: Icon(
Icons.radio,
color: Colors.white,
),
iconMargin: EdgeInsets.only(bottom: 10.0),
),
Tab(
text: 'Gift',
icon: Icon(
Icons.card_giftcard,
color: Colors.white,
),
iconMargin: EdgeInsets.only(bottom: 10.0),
),Step 4:
The next step is the TabBarView, this is where you will be creating the layout for each Tab, where you will be adding all your other widgets, basically setting up the page that you want to display when each Tab is selected. The important thing to remember here is that you need to be careful about the index. The children in the TabBarView should be added according to the Tabs created. For example, if you look at the image above, the Tab says Radio and it is at index 1, then the child at index 1 inside the TabBarView should be about Radio as well, otherwise, your Tab will mention something and the page that is being displayed will be different. Let me explain with some code…
--------------------------- Constructor ------------------------
TabBarView({
children: [],
controller: _tabController, // only if DefaultTabController is not used
physics: ScrollPhysics(parent: AlwaysScrollableScrollPhysics()),
dragStartBehavior: DragStartBehavior.start, // default
})
-------------------- Related to above Tab Code ------------------
TabBarView(
children: [
Center(
child: Text(
'This is Android Image Tab', /// Index:0
style: TextStyle(fontSize: 32),
)),
Center(
child: Text(
'This is Radio Tab', /// Index:1
style: TextStyle(fontSize: 32),
)),
Center(
child: Text(
'This is Gift Tab', /// Index:2
style: TextStyle(fontSize: 32),
)),
],
),Compare closely the code between the Tab and children of TabBarView, the index of every child widget in TabBarView is in accordance with the index of the Tab.
Until now all the above code was written using the DefaultTabController. Now if you want to create your own Controller then, first you need a stateful widget and TabController object which will be then initialized inside the controller property of TabBar and TabBarView.
TabBar & TabBarView with Custom TabController
Create a Stateful Widget with SingleTickerProviderStateMixin.
/// Flutter code sample for TabController in a stateful widget
class TabBarControllerWidget extends StatefulWidget {
const TabBarControllerWidget({Key key}) : super(key: key);
@override
_TabBarControllerWidgetState createState() => _TabBarControllerWidgetState();
}
class _TabBarControllerWidgetState extends State<TabBarControllerWidget> with SingleTickerProviderStateMixin {
}Create a List of Tabs and create an object of TabController.
// List of Tabs
final List<Tab> myTabs = <Tab>[
Tab(text: 'LEFT'),
Tab(text: 'MIDDLE'),
Tab(text: 'RIGHT'),
];
// controller object
TabController _tabController;Override initState and initialize the tabController and also override dispose to dispose of the tabController.
@override
void initState() {
super.initState();
_tabController = TabController(vsync: this, length: myTabs.length);
}
@override
void dispose() {
_tabController.dispose();
super.dispose();
}Finally, build the layout using the TabBar and TabBarView.
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
bottom: TabBar(
controller: _tabController,
tabs: myTabs,
),
),
body: TabBarView(
controller: _tabController,
children: myTabs.map((Tab tab) {
final String label = tab.text.toLowerCase();
return Center(
child: Text(
'This is the $label tab',
style: const TextStyle(fontSize: 36),
),
);
}).toList(),
),
);
}After all the hard work this will be the result of it.
note: The above code that I have posted is from the official documentation provided on the Flutter website.
----------------------------------------------------------------------------------------------
I am posting the complete code of both the examples that I have written in this story so that you can just copy it into your editor and further experiment with it.
With DefaultTabController
class TabBarViewWidget extends StatelessWidget {
@override
Widget build(BuildContext context) {
return DefaultTabController(
initialIndex: 1,
length: 3,
child: Scaffold(
appBar: AppBar(
backgroundColor: Colors.blueGrey.shade500,
title: Text('TabBar Widget'),
bottom: TabBar(
indicatorColor: Colors.lime,
indicatorWeight: 5.0,
labelColor: Colors.white,
labelPadding: EdgeInsets.only(top: 10.0),
unselectedLabelColor: Colors.grey,
tabs: [
Tab(
text: 'Cake',
icon: Icon(
Icons.cake,
color: Colors.white,
),
iconMargin: EdgeInsets.only(bottom: 10.0),
),
//child: Image.asset('images/android.png'),
Tab(
text: 'Radio',
icon: Icon(
Icons.radio,
color: Colors.white,
),
iconMargin: EdgeInsets.only(bottom: 10.0),
),
Tab(
text: 'Gift',
icon: Icon(
Icons.card_giftcard,
color: Colors.white,
),
iconMargin: EdgeInsets.only(bottom: 10.0),
),
],
),
),
body: TabBarView(
children: [
Center(
child: Text(
'This is Cake Tab',
style: TextStyle(fontSize: 32),
)),
Center(
child: Text(
'This is Radio Tab',
style: TextStyle(fontSize: 32),
)),
Center(
child: Text(
'This is Gift Tab',
style: TextStyle(fontSize: 32),
)),
],
),
),
);
}
}With Custom TabController
class TabBarControllerWidget extends StatefulWidget {
const TabBarControllerWidget({Key key}) : super(key: key);
@override
_TabBarControllerWidgetState createState() => _TabBarControllerWidgetState();
}
class _TabBarControllerWidgetState extends State<TabBarControllerWidget>
with SingleTickerProviderStateMixin {
final List<Tab> myTabs = <Tab>[
Tab(text: 'LEFT'),
Tab(text: 'MIDDLE'),
Tab(text: 'RIGHT'),
];
TabController _tabController;
@override
void initState() {
super.initState();
_tabController = TabController(vsync: this, length: myTabs.length);
}
@override
void dispose() {
_tabController.dispose();
super.dispose();
}
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
bottom: TabBar(
controller: _tabController,
tabs: myTabs,
),
),
body: TabBarView(
controller: _tabController,
children: myTabs.map((Tab tab) {
final String label = tab.text.toLowerCase();
return Center(
child: Text(
'This is the $label tab',
style: const TextStyle(fontSize: 36),
),
);
}).toList(),
),
);
}
}That covers it all, I have tried to write in as much detail as possible, and if you have anything to add to it feel free to write to me and give your suggestions. If you feel you have learned something new leave positive feedback by clapping for me. Stay safe and keep experimenting and discovering new ways to use flutter widgets as I always say Discovery requires Experimentation.