FLabel class final
A label that describes a form field with a label, description, and error message (if any).
There are two different Axis variants for labels:
- Axis.horizontal - Used in FCheckbox.
|--------------------------|
| [child] [label] |
| [description] |
| [error] |
|--------------------------|
- Axis.vertical - Used in FTextField.
|-----------------|
| [label] |
| [child] |
| [description] |
| [error] |
|-----------------|
See:
- https://forui.dev/docs/form/label for working examples.
- FLabelStyles for customizing a label's appearance.
- Inheritance
Constructors
- FLabel({required Axis axis, required Widget child, FLabelStyle? style, Widget? label, Widget? description, Widget? error, FLabelState state = FLabelState.enabled, Key? key})
-
Creates a FLabel.
const
Properties
- axis → Axis
-
The axis that represents.
final
- child → Widget
-
The child.
final
- description → Widget?
-
The description that elaborates on the label.
final
- error → Widget?
-
The error message.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- label → Widget?
-
The label that describes the form field.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- state → FLabelState
-
The state of the label.
final
- style → FLabelStyle?
-
The label's style. Defaults to the appropriate style in FThemeData.labelStyles.
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.
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