UiPageLayout class

Semantic page pattern built on UiPageScaffold.

Use this when a screen has common page parts (title, actions, filters, primary content, and optional secondary content) and the kit should own their responsive placement. Lower-level screens can still use UiPageScaffold directly when they need full manual control.

Inheritance

Constructors

UiPageLayout({Key? key, required Widget body, String? title, String? subtitle, UiBrand? brand, Widget? leading, List<Widget> actions = const <Widget>[], Widget? filters, Widget? secondary, Widget? bottomBar, Color? backgroundColor, UiSafeViewportMode safeViewportMode = UiSafeViewportMode.all, EdgeInsets safeAreaMinimum = EdgeInsets.zero, bool syncSystemBars = true, bool leftSafeInset = true, bool rightSafeInset = true, bool showTopDivider = true, bool showBottomDivider = true, UiBreakpoints breakpoints = UiBreakpoints.standard, double filtersPaneWidth = 280, double secondaryPaneWidth = 360, double minBodyWidth = 320, Future<void> onRefresh()?, UiRefresherController? refreshController, UiRefreshIndicatorBuilder? refreshIndicatorBuilder})
const

Properties

actions → List<Widget>
Trailing page actions. The wrapper keeps these in the page chrome.
final
backgroundColor → Color?
final
body → Widget
Main page content. This is always the primary flexible region.
final
bottomBar → Widget?
Bottom chrome, passed through to UiPageScaffold.
final
brand → UiBrand?
Brand configuration used by the generated top bar.
final
breakpoints → UiBreakpoints
final
filters → Widget?
Filtering or navigation controls. On compact viewports this is placed above body; on larger viewports it becomes a left pane.
final
filtersPaneWidth → double
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
leading → Widget?
Leading top-bar affordance, usually a back button or menu trigger.
final
leftSafeInset → bool
final
minBodyWidth → double
Minimum body width before optional panes move above/below the body.
final
onRefresh → Future<void> Function()?
Page-owned pull-to-refresh. See UiPageScaffold.onRefresh.
final
refreshController → UiRefresherController?
final
refreshIndicatorBuilder → UiRefreshIndicatorBuilder?
final
rightSafeInset → bool
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
safeAreaMinimum → EdgeInsets
final
safeViewportMode → UiSafeViewportMode
Safe-area policy for the generated page chrome and body.
final
secondary → Widget?
Inspector/detail content. On compact viewports this is placed below the primary body region; on larger viewports it becomes a right pane.
final
secondaryPaneWidth → double
final
showBottomDivider → bool
final
showTopDivider → bool
final
subtitle → String?
Optional supporting text rendered below title.
final
syncSystemBars → bool
final
title → String?
Page title rendered in the generated top bar.
final

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
createElement() → StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited