XScreen class
A page scaffold with safe-area, keyboard dismissal, responsive padding, loading overlay, and error overlay support.
Every state remains externally controlled, so XScreen can be used with any navigation and state-management architecture.
- Inheritance
Constructors
- XScreen({required Widget body, Key? key, PreferredSizeWidget? appBar, Color? backgroundColor, Widget? floatingActionButton, FloatingActionButtonLocation? floatingActionButtonLocation, Widget? drawer, Widget? endDrawer, bool safeArea = true, bool safeAreaTop = true, bool safeAreaBottom = true, bool dismissKeyboardOnTap = true, EdgeInsetsGeometry? padding, double? maxContentWidth, bool isLoading = false, WidgetBuilder? loadingBuilder, Color loadingBarrierColor = const Color(0x66000000), Object? error, XScreenErrorBuilder? errorBuilder, VoidCallback? onRetry, bool? resizeToAvoidBottomInset, bool extendBody = false, bool extendBodyBehindAppBar = false})
-
const
Properties
- appBar → PreferredSizeWidget?
-
final
- backgroundColor → Color?
-
final
- body → Widget
-
Main page content.
final
-
final
- dismissKeyboardOnTap → bool
-
Unfocuses the active input when the page background is tapped.
final
- drawer → Widget?
-
final
- endDrawer → Widget?
-
final
- error → Object?
-
Shows an error overlay when non-null.
final
- errorBuilder → XScreenErrorBuilder?
-
Builds custom error overlay content.
final
- extendBody → bool
-
final
- extendBodyBehindAppBar → bool
-
final
- floatingActionButton → Widget?
-
final
- floatingActionButtonLocation → FloatingActionButtonLocation?
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- isLoading → bool
-
Shows a modal loading overlay above the body.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- loadingBarrierColor → Color
-
final
- loadingBuilder → WidgetBuilder?
-
Builds custom loading overlay content.
final
- maxContentWidth → double?
-
Centers and constrains content on wide screens.
final
- onRetry → VoidCallback?
-
Retry callback supplied to the error overlay.
final
- padding → EdgeInsetsGeometry?
-
Padding around page content.
final
- resizeToAvoidBottomInset → bool?
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- safeArea → bool
-
Wraps content in SafeArea.
final
- safeAreaBottom → bool
-
final
- safeAreaTop → bool
-
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