JsonFormBuilder class
A widget that builds a dynamic form from a JSON configuration.
Supports all major field types, custom theming, validation, conditional logic, sections, and custom fields.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- JsonFormBuilder
Constructors
-
JsonFormBuilder({Key? key, required dynamic config, ValueChanged<
Map< ? onChanged, ValueChanged<String, dynamic> >Map< ? onValidation, ValueChanged<String, String?> >Map< ? onSubmit, FormTheme? theme, bool autoSave = false, String? persistenceKey, Map<String, dynamic> >String, FieldWidgetBuilder> ? customFieldBuilders}) -
Creates a JsonFormBuilder widget.
const
-
JsonFormBuilder.fromJsonString(String jsonString, {Key? key, ValueChanged<
Map< ? onChanged, ValueChanged<String, dynamic> >Map< ? onValidation, ValueChanged<String, String?> >Map< ? onSubmit, FormTheme? theme, bool autoSave = false, String? persistenceKey, Map<String, dynamic> >String, FieldWidgetBuilder> ? customFieldBuilders}) -
Creates a JsonFormBuilder from a JSON string.
factory
Properties
- autoSave → bool
-
Whether to auto-save form data (not implemented).
final
- config → dynamic
-
The JSON config for the form. Can be a Map or a FormConfig.
final
-
customFieldBuilders
→ Map<
String, FieldWidgetBuilder> ? -
Map of custom field builders for user-defined field types.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
onChanged
→ ValueChanged<
Map< ?String, dynamic> > -
Callback when any field value changes. Returns the current form data.
final
-
onSubmit
→ ValueChanged<
Map< ?String, dynamic> > -
Callback when the form is submitted and valid. Returns the form data.
final
-
onValidation
→ ValueChanged<
Map< ?String, String?> > -
Callback when any field validation changes. Returns the current error map.
final
- persistenceKey → String?
-
Optional key for persisting form data (not implemented).
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- theme → FormTheme?
-
The theme to use for the form and fields.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< JsonFormBuilder> -
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
-
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
Static Methods
-
fromAsset(
String assetPath, {Key? key, ValueChanged< Map< ? onChanged, ValueChanged<String, dynamic> >Map< ? onValidation, ValueChanged<String, String?> >Map< ? onSubmit, FormTheme? theme, bool autoSave = false, String? persistenceKey, Map<String, dynamic> >String, FieldWidgetBuilder> ? customFieldBuilders}) → Future<JsonFormBuilder> - Creates a JsonFormBuilder from an asset file.