简述

https://api.flutter.dev/flutter/material/Scaffold-class.html
一个完整的路由页可能会包含导航栏、抽屉菜单(Drawer)以及底部Tab导航菜单等。如果每个路由页面都需要开发者自己手动去实现这些,这会是一件非常麻烦且无聊的事。幸运的是,Flutter Material组件库提供了一些现成的组件来减少我们的开发任务。Scaffold是一个路由页的骨架,我们使用它可以很容易地拼装出一个完整的页面。

此类提供了用于显示drawer、snackbar和底部sheet等的API。

  1. Scaffold({
  2. Key key,
  3. this.appBar, //显示在界面顶部的一个 AppBar。
  4. this.body, //当前界面所显示的主要内容 Widget。
  5. this.floatingActionButton,
  6. this.floatingActionButtonLocation,
  7. this.floatingActionButtonAnimator,
  8. this.persistentFooterButtons,
  9. this.drawer, //抽屉菜单控件。
  10. this.endDrawer,
  11. this.bottomNavigationBar,
  12. this.bottomSheet,
  13. this.backgroundColor,
  14. this.resizeToAvoidBottomPadding,
  15. this.resizeToAvoidBottomInset,
  16. this.primary = true,
  17. this.drawerDragStartBehavior = DragStartBehavior.start,
  18. this.extendBody = false,
  19. this.extendBodyBehindAppBar = false,
  20. this.drawerScrimColor,
  21. this.drawerEdgeDragWidth,
  22. this.drawerEnableOpenDragGesture = true,
  23. this.endDrawerEnableOpenDragGesture = true,
  24. })

示例:

我们实现一个页面,它包含:

  1. 一个导航栏
  2. 导航栏右边有一个分享按钮
  3. 有一个抽屉菜单
  4. 有一个底部导航
  5. 右下角有一个悬浮的动作按钮

image.png

  1. import 'package:flutter/material.dart';
  2. import "./MyDrawer.dart";
  3. class ScaffoldDemo extends StatefulWidget {
  4. @override
  5. _ScaffoldDemoState createState() => _ScaffoldDemoState();
  6. }
  7. class _ScaffoldDemoState extends State<ScaffoldDemo> {
  8. int _selectedIndex = 1;
  9. List _list = ['home', 'business', 'school'];
  10. @override
  11. Widget build(BuildContext context) {
  12. return Scaffold(
  13. body: Text(_list[_selectedIndex]),
  14. // 顶部导航栏
  15. appBar: AppBar(
  16. title: Text('scaffold demo'), //导航栏标题
  17. actions: [
  18. //导航栏右侧分享
  19. IconButton(icon: Icon(Icons.share), onPressed: () {}),
  20. ],
  21. ),
  22. //侧栏
  23. drawer: MyDrawer(),
  24. // 底部导航栏
  25. bottomNavigationBar: BottomNavigationBar(
  26. items: [
  27. BottomNavigationBarItem(icon: Icon(Icons.home), label: 'home'),
  28. BottomNavigationBarItem(icon: Icon(Icons.business), label: 'business'),
  29. BottomNavigationBarItem(icon: Icon(Icons.school), label: 'school'),
  30. ],
  31. currentIndex: _selectedIndex,
  32. onTap: (index) {
  33. setState(() {
  34. _selectedIndex = index;
  35. });
  36. },
  37. ),
  38. // 悬浮按钮
  39. floatingActionButton: FloatingActionButton(
  40. child: Text('悬浮'),
  41. onPressed: () {},
  42. ),
  43. );
  44. }
  45. }


TabBar

下面我们通过“bottom”属性来添加一个导航栏底部Tab按钮组,将要实现的效果如图5-21所示:
Scaffold - 图2
Material组件库中提供了一个TabBar组件,它可以快速生成Tab菜单,下面是上图对应的源码:

  1. class _ScaffoldRouteState extends State<ScaffoldRoute> with SingleTickerProviderStateMixin {
  2. TabController _tabController; //需要定义一个Controller
  3. List tabs = ["新闻", "历史", "图片"];
  4. @override
  5. void initState() {
  6. super.initState();
  7. // 创建Controller
  8. _tabController = TabController(length: tabs.length, vsync: this);
  9. }
  10. @override
  11. Widget build(BuildContext context) {
  12. return Scaffold(
  13. appBar: AppBar(
  14. bottom: TabBar( //生成Tab菜单
  15. controller: _tabController,
  16. tabs: tabs.map((e) => Tab(text: e)).toList()
  17. ),
  18. ),
  19. }

上面代码首先创建了一个TabController ,它是用于控制/监听Tab菜单切换的。接下来通过TabBar生成了一个底部菜单栏,TabBartabs属性接受一个Widget数组,表示每一个Tab子菜单,我们可以自定义,也可以像示例中一样直接使用Tab 组件,它是Material组件库提供的Material风格的Tab菜单。

Tab组件有三个可选参数,除了可以指定文字外,还可以指定Tab菜单图标,或者直接自定义组件样式。Tab组件定义如下:

  1. Tab({
  2. Key key,
  3. this.text, // 菜单文本
  4. this.icon, // 菜单图标
  5. this.child, // 自定义组件样式
  6. })

TabBarView

通过TabBar我们只能生成一个静态的菜单,真正的Tab页还没有实现。由于Tab菜单和Tab页的切换需要同步,我们需要通过TabController去监听Tab菜单的切换去切换Tab页,代码如:

  1. _tabController.addListener((){
  2. switch(_tabController.index){
  3. case 1: ...;
  4. case 2: ... ;
  5. }
  6. });

如果我们Tab页可以滑动切换的话,还需要在滑动过程中更新TabBar指示器的偏移!显然,要手动处理这些是很麻烦的,为此,Material库提供了一个TabBarView组件,通过它不仅可以轻松的实现Tab页,而且可以非常容易的配合TabBar来实现同步切换和滑动状态同步,示例如下:

  1. Scaffold(
  2. appBar: AppBar(
  3. ... //省略无关代码
  4. bottom: TabBar(
  5. controller: _tabController,
  6. tabs: tabs.map((e) => Tab(text: e)).toList()),
  7. ),
  8. drawer: new MyDrawer(),
  9. body: TabBarView(
  10. controller: _tabController,
  11. children: tabs.map((e) { //创建3个Tab页
  12. return Container(
  13. alignment: Alignment.center,
  14. child: Text(e, textScaleFactor: 5),
  15. );
  16. }).toList(),
  17. ),
  18. ... // 省略无关代码
  19. )

运行后效果如图:
Scaffold - 图3

现在,无论是点击导航栏Tab菜单还是在页面上左右滑动,Tab页面都会切换,并且Tab菜单的状态和Tab页面始终保持同步!那它们是如何实现同步的呢?细心的读者可能已经发现,上例中TabBarTabBarViewcontroller是同一个!正是如此,TabBarTabBarView正是通过同一个controller来实现菜单切换和滑动状态同步的,有关TabController的详细信息,我们不在本书做过多介绍,使用时读者直接查看SDK即可。

另外,Material组件库也提供了一个PageView 组件,它和TabBarView功能相似,读者可以自行了解一下。

Drawer

ScaffolddrawerendDrawer属性可以分别接受一个Widget来作为页面的左、右抽屉菜单。如果开发者提供了抽屉菜单,那么当用户手指从屏幕左(或右)侧向里滑动时便可打开抽屉菜单。

示例

image.png

  1. import 'package:flutter/material.dart';
  2. class MyDrawer extends StatelessWidget {
  3. const MyDrawer({Key key}) : super(key: key);
  4. @override
  5. Widget build(BuildContext context) {
  6. return Drawer(
  7. child: MediaQuery.removePadding(
  8. context: context,
  9. //移除抽屉菜单顶部默认留白
  10. removeTop: true,
  11. child: Column(
  12. crossAxisAlignment: CrossAxisAlignment.start,
  13. children: <Widget>[
  14. Padding(
  15. padding: const EdgeInsets.only(top: 38.0),
  16. child: Row(
  17. children: <Widget>[
  18. Padding(
  19. padding: const EdgeInsets.symmetric(horizontal: 16.0),
  20. child: ClipOval(
  21. child: Image.asset(
  22. "assets/images/avatar.jpg",
  23. width: 80,
  24. ),
  25. ),
  26. ),
  27. Text(
  28. "Wendux",
  29. style: TextStyle(fontWeight: FontWeight.bold),
  30. )
  31. ],
  32. ),
  33. ),
  34. Expanded(
  35. child: ListView(
  36. children: <Widget>[
  37. ListTile(
  38. leading: const Icon(Icons.add),
  39. title: const Text('Add account'),
  40. ),
  41. ListTile(
  42. leading: const Icon(Icons.settings),
  43. title: const Text('Manage accounts'),
  44. ),
  45. ],
  46. ),
  47. ),
  48. ],
  49. ),
  50. ),
  51. );
  52. }
  53. }

抽屉菜单通常将Drawer组件作为根节点,它实现了Material风格的菜单面板,MediaQuery.removePadding可以移除Drawer默认的一些留白(比如Drawer默认顶部会留和手机状态栏等高的留白),读者可以尝试传递不同的参数来看看实际效果。抽屉菜单页由顶部和底部组成,顶部由用户头像和昵称组成,底部是一个菜单列表,用ListView实现,关于ListView我们将在后面“可滚动组件”一节详细介绍。

FloatingActionButton

FloatingActionButton是Material设计规范中的一种特殊Button,通常悬浮在页面的某一个位置作为某种常用动作的快捷入口,如本节示例中页面右下角的”➕”号按钮。我们可以通过ScaffoldfloatingActionButton属性来设置一个FloatingActionButton,同时通过floatingActionButtonLocation属性来指定其在页面中悬浮的位置,这个比较简单,不再赘述。

底部Tab导航栏

我们可以通过ScaffoldbottomNavigationBar属性来设置底部导航,如本节开始示例所示,我们通过Material组件库提供的BottomNavigationBarBottomNavigationBarItem两种组件来实现Material风格的底部导航栏。可以看到上面的实现代码非常简单,所以不再赘述,但是如果我们想实现如图5-23所示效果的底部导航栏应该怎么做呢?
image.png
Material组件库中提供了一个BottomAppBar 组件,它可以和FloatingActionButton配合实现这种“打洞”效果,源码如下:

  1. bottomNavigationBar: BottomAppBar(
  2. color: Colors.white,
  3. shape: CircularNotchedRectangle(), // 底部导航栏打一个圆形的洞
  4. child: Row(
  5. children: [
  6. IconButton(icon: Icon(Icons.home)),
  7. SizedBox(), //中间位置空出
  8. IconButton(icon: Icon(Icons.business)),
  9. ],
  10. mainAxisAlignment: MainAxisAlignment.spaceAround, //均分底部导航栏横向空间
  11. ),
  12. )

可以看到,上面代码中没有控制打洞位置的属性,实际上,打洞的位置取决于FloatingActionButton的位置,上面FloatingActionButton的位置为:

  1. floatingActionButtonLocation: FloatingActionButtonLocation.centerDocked,

所以打洞位置在底部导航栏的正中间。
BottomAppBarshape属性决定洞的外形,CircularNotchedRectangle实现了一个圆形的外形,我们也可以自定义外形,比如,Flutter Gallery示例中就有一个“钻石”形状的示例,读者感兴趣可以自行查看。