M3ESideSheetLayout class
Places a side sheet next to (standard) or over (modal) body.
When a standard sheet opens, body shrinks to make room for it and
keeps a 24 margin on its trailing edge. In M3ESideSheetLayoutMode
.adaptive the sheet is modal on compact windows (below 600) and
standard on medium and wider ones; crossing the breakpoint while open
morphs between the two with a spatial spring.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- M3ESideSheetLayout
Constructors
-
M3ESideSheetLayout({required Widget body, required M3ESideSheet sheet, M3ESideSheetController? controller, M3ESideSheetLayoutMode mode = M3ESideSheetLayoutMode.adaptive, bool initiallyOpen = false, bool isDismissible = true, ValueChanged<
bool> ? onOpenChanged, Key? key}) -
M3ESideSheetLayout.
const
Properties
- body → Widget
-
Main content.
final
- controller → M3ESideSheetController?
-
Opens and closes the sheet.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- initiallyOpen → bool
-
Whether the sheet starts open.
final
- isDismissible → bool
-
Whether tapping the scrim closes a modal sheet.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- mode → M3ESideSheetLayoutMode
-
Standard, modal, or chosen by window width.
final
-
onOpenChanged
→ ValueChanged<
bool> ? -
Called when the sheet opens or closes.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sheet → M3ESideSheet
-
The side sheet. Its variant is chosen by mode.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< M3ESideSheetLayout> -
Creates the mutable state for this widget at a given location in the tree.
override
-
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