FlutterJsonSchemaForm class

A widget that displays a form based on a JSON Schema.

Inheritance

Constructors

FlutterJsonSchemaForm({Key? key, required JsonSchema jsonSchema, required FlutterJsonSchemaFormController controller, String? buttonText, Widget? fileWidget, Function? onSubmit, dynamic onChanged(dynamic)?, bool isInnerField = false, bool disabled = false, List<String> path = const [], Map<String, dynamic> formState = const {}})
const

Properties

buttonText String?
final
controller FlutterJsonSchemaFormController
Controller to use to manage the form.
final
disabled bool
When to disable the form input.
final
fileWidget Widget?
Widget to use to input a file
final
formState Map<String, dynamic>
Current state of the form.
final
hashCode int
The hash code for this object.
no setterinherited
isInnerField bool
final
jsonSchema → JsonSchema
JSON Schema to use to generate the form.
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onChanged → (dynamic Function(dynamic)?)
Callback to execute when the form is changed.
This callback should call state management methods.
final
onSubmit Function?
Callback to execute when the form is submitted.
final
path List<String>
List of keys that must be followed to find this form on a nested form.
For the root form on an nested form structure, it is usually an empty list.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

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}) 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