M3EFocusRing class

Draws the Material 3 Expressive keyboard focus ring around child.

When focused is true, the ring is outset around child. A transparent PhysicalModel with elevation lifts the ring above opaque siblings (e.g. dropdown / list rows) without changing layout spacing between items.

Always uses a stable Stack so toggling focused does not remount child (important for EditableText text-input clients).

Inheritance

Constructors

M3EFocusRing({required BorderRadius radius, required Widget child, bool focused = false, Duration animationDuration = Duration.zero, Color? color, double? width, double? gap, Key? key})
Creates a focus ring decorator.
const

Properties

animationDuration Duration
Optional animation for ring appearance.
final
child Widget
Content to wrap.
final
color Color?
Optional color override; defaults to M3EFocusRingTheme.resolveColor.
final
focused bool
Whether the keyboard focus ring should be painted.
final
gap double?
Optional gap override between surface and ring.
final
hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
radius BorderRadius
Outer border radius of the focused surface.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
width double?
Optional stroke width override.
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

Static Methods

indicatorsEnabledOf(BuildContext context) bool
Whether the ambient theme allows keyboard focus ring / state chrome.
outsetOf(BuildContext context) double
Theme outset (gap + width) for layout clearance.
shouldShow(FocusNode node, [BuildContext? context]) bool
Whether node should show a keyboard focus ring.
themeOf(BuildContext context) M3EFocusRingTheme
Theme tokens for the ambient M3ETheme.