Scaffold

The Stac Scaffold allows you to build a Flutter scaffold widget using JSON. To know more about the scaffold widget in Flutter, refer to the official documentation.

Properties

Property	Type	Description
appBar	`StacWidget`	The app bar widget of the scaffold.
body	`StacWidget`	The body widget of the scaffold.
floatingActionButton	`StacWidget`	The floating action button widget of the scaffold.
floatingActionButtonLocation	`StacFloatingActionButtonLocation`	The location of the floating action button.
persistentFooterButtons	`List<StacWidget>`	The persistent footer buttons of the scaffold.
persistentFooterAlignment	`StacAlignmentDirectional`	The alignment of the persistent footer buttons.
drawer	`StacWidget`	The drawer widget of the scaffold.
onDrawerChanged	`StacAction`	Action called when the drawer is opened or closed.
endDrawer	`StacWidget`	The end drawer widget of the scaffold.
onEndDrawerChanged	`StacAction`	Action called when the end drawer is opened or closed.
bottomNavigationBar	`StacWidget`	The bottom navigation bar widget of the scaffold.
bottomSheet	`StacWidget`	The bottom sheet widget of the scaffold.
backgroundColor	`StacColor`	The background color of the scaffold.
resizeToAvoidBottomInset	`bool`	Whether the scaffold should resize to avoid the bottom inset.
primary	`bool`	Whether the scaffold is the primary scaffold. Defaults to `true`.
drawerDragStartBehavior	`StacDragStartBehavior`	The drag start behavior for the drawer. Defaults to `DragStartBehavior.start`.
extendBody	`bool`	Whether the body should extend into the scaffold’s bottom padding. Defaults to `false`.
extendBodyBehindAppBar	`bool`	Whether the body should extend behind the app bar. Defaults to `false`.
drawerScrimColor	`StacColor`	The color of the scrim for the drawer.
drawerEdgeDragWidth	`double`	The width of the edge drag area for the drawer.
drawerEnableOpenDragGesture	`bool`	Whether the drawer can be opened with a drag gesture. Defaults to `true`.
endDrawerEnableOpenDragGesture	`bool`	Whether the end drawer can be opened with a drag gesture. Defaults to `true`.
restorationId	`String`	The restoration ID to save and restore the state of the scaffold.

Example

Dart
JSON
Preview

StacScaffold(
  appBar: StacAppBar(
    title: StacText(data: 'App Bar Title'),
  ),
  body: StacCenter(
    child: StacText(data: 'Hello, World!'),
  ),
  floatingActionButton: StacFloatingActionButton(
    child: StacIcon(icon: 'add'),
    onPressed: {'type': 'function', 'name': 'onFabPressed'},
  ),
  backgroundColor: StacColors.white,
  drawer: StacDrawer(
    child: StacColumn(
      children: [
        StacText(data: 'Drawer Item 1'),
        StacText(data: 'Drawer Item 2'),
      ],
    ),
  ),
)

{
  "type": "scaffold",
  "appBar": {
    "type": "appBar",
    "title": {
      "type": "text",
      "data": "App Bar Title"
    }
  },
  "body": {
    "type": "center",
    "child": {
      "type": "text",
      "data": "Hello, World!"
    }
  },
  "floatingActionButton": {
    "type": "floatingActionButton",
    "child": {
      "type": "icon",
      "icon": "add"
    },
    "onPressed": {
      "type": "function",
      "name": "onFabPressed"
    }
  },
  "backgroundColor": "#FFFFFF",
  "drawer": {
    "type": "drawer",
    "child": {
      "type": "column",
      "children": [
        {
          "type": "text",
          "data": "Drawer Item 1"
        },
        {
          "type": "text",
          "data": "Drawer Item 2"
        }
      ]
    }
  }
}

Layout Widgets

Display Widgets

Interactive Widgets

Data Widgets

Properties

Example

​Properties

​Example

Properties

Example