NiceJsonSchemaForm class

A form widget that renders a form from a JSON Schema.

Inheritance
Available extensions

Constructors

NiceJsonSchemaForm({Key? key, required Map<String, dynamic> schema, Map<String, dynamic> uiSchema = const {}, Map<String, dynamic>? initialValues, void onChanged(Map<String, dynamic> values)?, void onSubmit(Map<String, dynamic> values)?, String? submitLabel, bool readOnly = false, int columnsPerRow = 1, bool showValidationErrors = true, Map<String, Widget Function(BuildContext, JsonSchemaProperty, dynamic, ValueChanged )> customWidgets = const {}})
const
NiceJsonSchemaForm.fromJson(String jsonSchema, {Key? key, String? uiSchemaJson, Map<String, dynamic>? initialValues, void onChanged(Map<String, dynamic> values)?, void onSubmit(Map<String, dynamic> values)?, String? submitLabel, bool readOnly = false, int columnsPerRow = 1})
Factory constructor from JSON string.
factory

Properties

columnsPerRow int
Number of columns per row (for responsive layout).
final
customWidgets Map<String, Widget Function(BuildContext, JsonSchemaProperty, dynamic, ValueChanged )>
Custom widget builders for specific fields or types.
final
hashCode int
The hash code for this object.
no setterinherited
initialValues Map<String, dynamic>?
Initial form values.
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onChanged → void Function(Map<String, dynamic> values)?
Called when any field value changes.
final
onSubmit → void Function(Map<String, dynamic> values)?
Called when form is submitted (if validation passes).
final
readOnly bool
Whether all fields are read-only.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
schema Map<String, dynamic>
JSON Schema definition (draft-07 compatible).
final
showValidationErrors bool
Whether to show validation errors inline.
final
submitLabel String?
Label for the submit button.
final
uiSchema Map<String, dynamic>
Optional UI Schema for widget overrides (react-jsonschema-form style).
final

Methods

asFocusable({FocusNode? focusNode, bool autofocus = false}) Widget

Available on Widget, provided by the NiceAccessibilityExtension extension

Mark this widget as focusable.
asSemanticButton({String? label, VoidCallback? onTap}) Widget

Available on Widget, provided by the NiceAccessibilityExtension extension

Mark this widget as a button for screen readers.
asSemanticHeading(String label) Widget

Available on Widget, provided by the NiceAccessibilityExtension extension

Mark this widget as a heading for screen readers.
createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() State<NiceJsonSchemaForm>
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
excludeFromSemantics() Widget

Available on Widget, provided by the NiceAccessibilityExtension extension

Exclude this widget from the semantic tree.
mergeSemantics() Widget

Available on Widget, provided by the NiceAccessibilityExtension extension

Merge semantics of child widgets.
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
withSemanticLabel(String label) Widget

Available on Widget, provided by the NiceAccessibilityExtension extension

Add a semantic label to this widget.

Operators

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