DesignPasswordReveal class

Holds whether a password shows and gives the field and its toggle what they need. The field keeps its focus and caret as it flips; with hideOnBlur a shown password hides again when focus leaves the field.

DesignPasswordReveal(builder: (context, password) => Text(password.toggleLabel))
Inheritance

Constructors

DesignPasswordReveal({Key? key, required Widget builder(BuildContext context, DesignPasswordDetails password), DesignPasswordController? controller, FocusNode? focusNode, bool hideOnBlur = false, String? showLabel, String? hideLabel})
A reveal for one password field.
const

Properties

builder → Widget Function(BuildContext context, DesignPasswordDetails password)
Paints the field and its toggle.
final
controller → DesignPasswordController?
Holds whether it shows, when the caller watches it. The caller disposes it; null: the reveal makes its own and disposes it.
final
focusNode → FocusNode?
The field's focus, for hideOnBlur and to keep focus on the field as the toggle flips it. The caller's, who disposes it; the reveal only listens to it.
final
hashCode → int
The hash code for this object.
no setterinherited
hideLabel → String?
The toggle's label while shown; null: DesignLocalizations.hidePasswordLabel.
final
hideOnBlur → bool
Whether a shown password hides when focus leaves the field.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showLabel → String?
The toggle's label while hidden; null: DesignLocalizations.showPasswordLabel.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<DesignPasswordReveal>
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.
override
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