NyForm class

NyForm is a class that helps in managing forms To create a form, you need to extend the NyFormData class Example:

class RegisterForm extends NyFormData {
 @override
 fields() => [
    Field.text("Name", validate: FormValidator().notEmpty()),
    Field.email("Email", validate: FormValidator.email()),
 ];
}

RegisterForm form = RegisterForm();

NyForm(
 form: form,
);

To submit the form, you can call the submit method Example:

form.submit(onSuccess: (data) {});
// or
NyForm.submit("RegisterForm", onSuccess: (data) {});

To get the data from the form, you can call the data method Example:

form.data();

Learn more: https://nylo.dev/docs/6.x/forms

Inheritance

Available extensions

Constructors

NyForm({Key? key, required NyFormData form, double crossAxisSpacing = 10, double mainAxisSpacing = 10, Map<String, dynamic>? initialData, dynamic onChanged(String field, Map<String, dynamic> data)?, bool validateOnFocusChange = false, Widget? header, Widget? footer, double headerSpacing = 10, double footerSpacing = 10, @Deprecated('Use loadingStyle instead') Widget? loading, LoadingStyle? loadingStyle, bool locked = false})
NyForm.list({Key? key, required NyFormData form, required List<Widget>? children, double crossAxisSpacing = 10, double mainAxisSpacing = 10, Map<String, dynamic>? initialData, dynamic onChanged(String field, Map<String, dynamic> data)?, bool validateOnFocusChange = false, Widget? header, Widget? footer, double headerSpacing = 10, double footerSpacing = 10, @Deprecated('Use loadingStyle instead') Widget? loading, LoadingStyle? loadingStyle, bool locked = false}): Create a form with children Example:

Properties

children → List<Widget>?: The child widgets
final
crossAxisSpacing → double: final
footer → Widget?: The footer widget
final
footerSpacing → double: The footer spacing
final
form → NyFormData: final
hashCode → int: The hash code for this object.
no setterinherited
header → Widget?: The header widget
final
headerSpacing → double: The header spacing
final
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
loading → Widget?: The loading widget, defaults to skeleton
final
loadingStyle → LoadingStyle: The loading style
final
locked → bool: final
mainAxisSpacing → double: final
onChanged → dynamic Function(String field, Map<String, dynamic> data)?: final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
type → String: The type of form
final
validateOnFocusChange → bool: final

Methods

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
faderBottom(int strength, {Color color = Colors.black}) → NyFader: Available on StatefulWidget, provided by the NyStateful extension
Make gradient fader from the bottom of the widget.
faderFrom(int strength, {Color color = Colors.black, List<AlignmentGeometry> alignment = const [Alignment.topCenter, Alignment.bottomCenter]}) → NyFader: Available on StatefulWidget, provided by the NyStateful extension
fader from bottom
faderLeft(int strength, {Color color = Colors.black}) → NyFader: Available on StatefulWidget, provided by the NyStateful extension
Make gradient fader from the left of the widget.
faderRight(int strength, {Color color = Colors.black}) → NyFader: Available on StatefulWidget, provided by the NyStateful extension
Make gradient fader from the right of the widget.
faderTop(int strength, {Color color = Colors.black}) → NyFader: Available on StatefulWidget, provided by the NyStateful extension
Make gradient fader from the top of the widget.
flexible({Key? key, int flex = 1, FlexFit fit = FlexFit.loose}) → Flexible: Available on StatefulWidget, provided by the NyStateful extension
Make a StatefulWidget Flexible. Example:
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
pullable({required Future<void> onRefresh()?, PullableConfig? pullableConfig}) → Widget: Available on Widget, provided by the NyWidget extension
Make a widget pullable using the Pullable widget.
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode: Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toSkeleton({Key? key, bool? ignoreContainers, bool? justifyMultiLineText, Color? containersColor, bool ignorePointers = true, bool enabled = true, PaintingEffect? effect, TextBoneBorderRadius? textBoneBorderRadius}) → Skeletonizer: Available on Widget, provided by the NyWidget extension
Make a widget a skeleton using the Skeletonizer package.
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

state(String stateName) → String: Get the state name
stateClearData(String stateName) → void: Refresh the state of the form
stateRefresh(String stateName) → void: Refresh the state of the form
stateRefreshForm(String stateName) → void: Refresh the state of the form
stateSetOptions(String stateName, String key, dynamic value) → void: Set field in the form
stateSetValue(String stateName, String key, dynamic value) → void: Set field in the form
submit(String name, {required dynamic onSuccess(dynamic value), dynamic onFailure(Exception exception)?, bool showToastError = true}) → void: Submit the form