SunnyFormField<T> class

Similar to FormField, but extended to work with Sunny metadata and styling.

A SunnyFormField represents a form control that manages data at a path attribute. This widget renders the control, label, and error widgets. The underlying value is tracked within SunnyFormFieldState / but if there is a FormController in the other scope, this field will publish any changes there.

Inheritance
Implementers
Available extensions

Constructors

SunnyFormField.new({Key? key, String discriminator = "", required dynamic label, required dynamic attribute, dynamic placeholder, required bool isRequired, Producer<String>? onLabelTap, ValueChanged<String>? onLabelChange, InputDecoration? decoration, FieldConverter<T?>? converter, required SunnyFormFieldBuilder<T>? builder, bool? captureNestedPaths, bool? enabled = true, bool? isReadOnly = false, FocusNode? focusNode, AttributeAccepter<T?>? onReadOnlyTapped, T? initialValue, FormValueChanged<T?>? onChange, FormController? form, List<SunnyFormFieldValidator>? validators})
SunnyFormField.meta(BuildContext context, {Key? key, String? label, String? fallbackLabel, String? placeholder, dynamic basePath, MetaFormContext? formMetadata, required dynamic attribute, bool? captureNestedPaths, bool isReadOnly = false, bool? isRequired, AttributeAccepter<T?>? onReadOnlyTapped, FormValueChanged<T?>? onChange})
This constructor expects form metadata to be the source for the field rendering, as well as a SunnyForm to be present.
factory

Properties

attribute → JsonPath<T>
final
builder → SunnyFormFieldBuilder<T>?
This builder should only build the raw input, without any extra stuff, like errors, help text, labels, or otherwise
final
captureNestedPaths → bool
final
converter → FieldConverter<T?>?
final
decoration → InputDecoration?
final
enabled → bool?
final
focusNode → FocusNode?
final
form → FormController?
final
hashCode → int
The hash code for this object.
no setterinherited
initialValue → T?
final
isReadOnly → bool?
final
isRequired → bool
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
label → dynamic
final
onChange → FormValueChanged<T?>?
final
onLabelChange → ValueChanged<String>?
final
onLabelTap → Producer<String>?
Provides a hook for handling editable labels
final
onReadOnlyTapped → AttributeAccepter<T?>?
final
placeholder → dynamic
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
validators → List<SunnyFormFieldValidator>?
final

Methods

bpad([int units = 2]) → Widget

Available on Widget, provided by the WidgetSpacingExt extension

color(Color color) → Widget

Available on Widget, provided by the WidgetSpacingExt extension

constrained({double? height, double? width}) → Widget

Available on Widget, provided by the WidgetSpacingExt extension

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

Available on Widget, provided by the WidgetSpacingExt extension

hero(String? heroTag) → Widget

Available on Widget, provided by the SunnyWidgetHeroExtensions extension

hpad([int units = 2]) → Widget

Available on Widget, provided by the WidgetSpacingExt extension

listItemCard() → Widget

Available on Widget, provided by the WidgetSpacingExt extension

listItemPad() → Widget

Available on Widget, provided by the WidgetSpacingExt extension

listItemTallPad({Key? key}) → Widget

Available on Widget, provided by the WidgetSpacingExt extension

loose() → Widget

Available on Widget, provided by the WidgetSpacingExt extension

lpad([int units = 2]) → Widget

Available on Widget, provided by the WidgetSpacingExt extension

maybeWrap(bool wrapIf, Widget wrap(Widget child)) → Widget

Available on Widget, provided by the WidgetMaybeWrap extension

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
offstage([bool offStageIf = true, bool forceWrap = false]) → Widget

Available on Widget?, provided by the WidgetOffstateExtensions extension

pad({int h = 2, int v = 1}) → Widget

Available on Widget, provided by the WidgetSpacingExt extension

reIcon({Color? color, double? size}) → Widget

Available on Widget, provided by the WidgetReIconExt extension

responsive({double maxWidth = kDefaultResponsiveWidth, ResponsiveMaxWidth? calculated}) → Widget

Available on Widget, provided by the WidgetConstraint extension

responsiveSliver({double maxWidth = kDefaultResponsiveWidth, ResponsiveSliverMaxWidth? calculated}) → Widget

Available on Widget, provided by the WidgetConstraint extension

rpad([int units = 2]) → Widget

Available on Widget, provided by the WidgetSpacingExt extension

sectionPad() → Widget

Available on Widget, provided by the WidgetSpacingExt extension

sized({double? height, double? width}) → Widget

Available on Widget, provided by the WidgetSpacingExt extension

sliverBox() → Widget

Available on Widget, provided by the WidgetSpacingExt extension

sliverFill() → Widget

Available on Widget, provided by the WidgetSpacingExt extension

tappable(VoidCallback? onTap, {double? padAmount, EdgeInsets? padding}) → Widget

Available on Widget?, provided by the WidgetOffstateExtensions extension

toBuilder() → WidgetBuilder?

Available on Widget?, provided by the WidgetOffstateExtensions extension

Converts a nullable widget to a builder
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
tpad([int units = 2]) → Widget

Available on Widget, provided by the WidgetSpacingExt extension

vpad([int units = 2]) → Widget

Available on Widget, provided by the WidgetSpacingExt extension

withDragHandle() → Widget

Available on Widget, provided by the WidgetDragHandleExt extension

Operators

operator ==(Object other) → bool
The equality operator.
inherited