childScaffold<TBuildContext extends AFBuildContext<AFFlexibleStateView, AFRouteParam>> method

Widget childScaffold<TBuildContext extends AFBuildContext<AFFlexibleStateView, AFRouteParam>>({
  1. Key? key,
  2. required AFStateProgrammingInterface<AFComponentState, AFBuildContext<AFFlexibleStateView, AFRouteParam>, AFFunctionalTheme> spi,
  3. AFConnectedUIBase<AFComponentState, AFFunctionalTheme, AFFlexibleStateView, AFRouteParam, AFStateProgrammingInterface<AFComponentState, AFBuildContext<AFFlexibleStateView, AFRouteParam>, AFFunctionalTheme>>? contextSource,
  4. PreferredSizeWidget? appBar,
  5. Widget? drawer,
  6. required Widget body,
  7. Widget? bottomNavigationBar,
  8. Widget? floatingActionButton,
  9. Color? backgroundColor,
  10. FloatingActionButtonLocation? floatingActionButtonLocation,
  11. FloatingActionButtonAnimator? floatingActionButtonAnimator,
  12. List<Widget>? persistentFooterButtons,
  13. Widget? endDrawer,
  14. Widget? bottomSheet,
  15. bool? resizeToAvoidBottomPadding,
  16. bool? resizeToAvoidBottomInset,
  17. bool primary = true,
  18. DragStartBehavior drawerDragStartBehavior = DragStartBehavior.start,
  19. bool extendBody = false,
  20. bool extendBodyBehindAppBar = false,
  21. Color? drawerScrimColor,
  22. double? drawerEdgeDragWidth,
  23. bool drawerEnableOpenDragGesture = true,
  24. bool endDrawerEnableOpenDragGesture = true,
})

A method used to create a standard scaffold, please use this instead of creating you scaffold manually with return Scaffold(...

This method does a few nice things for you:

  • It automatically attaches the AFib prototype drawer in prototype mode.

You will most likely want to create one or more app-specific version of this method in your own app's conceptual theme, which might fill in many of the parameters (e.g. appBar) with standard values, rather than duplicating them on every screen.

Implementation

Widget childScaffold<TBuildContext extends AFBuildContext>({
  Key? key,
  required AFStateProgrammingInterface spi,
  AFConnectedUIBase? contextSource,
  PreferredSizeWidget? appBar,
  Widget? drawer,
  required Widget body,
  Widget? bottomNavigationBar,
  Widget? floatingActionButton,
  Color? backgroundColor,
  FloatingActionButtonLocation? floatingActionButtonLocation,
  FloatingActionButtonAnimator? floatingActionButtonAnimator,
  List<Widget>? persistentFooterButtons,
  Widget? endDrawer,
  Widget? bottomSheet,
  bool? resizeToAvoidBottomPadding,
  bool? resizeToAvoidBottomInset,
  bool primary = true,
  DragStartBehavior drawerDragStartBehavior = DragStartBehavior.start,
  bool extendBody = false,
  bool extendBodyBehindAppBar = false,
  Color? drawerScrimColor,
  double? drawerEdgeDragWidth,
  bool drawerEnableOpenDragGesture = true,
  bool endDrawerEnableOpenDragGesture = true
}) {

    return Scaffold(
      key: key,
      drawer: childDebugDrawerBegin(drawer),
      body: body,
      appBar: appBar,
      bottomNavigationBar: bottomNavigationBar,
      floatingActionButton: floatingActionButton,
      floatingActionButtonLocation: floatingActionButtonLocation,
      floatingActionButtonAnimator: floatingActionButtonAnimator,
      backgroundColor: backgroundColor,
      persistentFooterButtons: persistentFooterButtons,
      bottomSheet: bottomSheet,
      resizeToAvoidBottomInset: resizeToAvoidBottomInset,
      primary: primary,
      drawerDragStartBehavior: drawerDragStartBehavior,
      extendBody: extendBody,
      extendBodyBehindAppBar: extendBodyBehindAppBar,
      drawerScrimColor: drawerScrimColor,
      drawerEdgeDragWidth: drawerEdgeDragWidth,
      drawerEnableOpenDragGesture: drawerEnableOpenDragGesture,
      endDrawer: childDebugDrawerEnd(endDrawer),
    );
}