API Reference
Quick reference for all public types in vyuh_feature_forms and vyuh_form_editor.
Form Containers
| Type | Schema | Description |
|---|---|---|
Form | vyuh.form | Top-level form with FormGroup, validation, and listeners |
FormRowBlock | vyuh.form.row | Structural row containing {field, span} row items |
FormSection | vyuh.form.section | Visual grouping with title, collapse, and rules |
RepeatingSection | vyuh.form.repeating_section | Dynamic array of field groups |
StepForm | vyuh.stepForm | Multi-step wizard with sequential navigation |
Field Types
| Type | Schema | Control Type |
|---|---|---|
TextField | vyuh.formfield.text | FormControl<String> |
NumberField | vyuh.formfield.number | FormControl<num> |
SelectField | vyuh.formfield.select | FormControl<String> / FormControl<List<String>> |
BooleanField | vyuh.formfield.boolean | FormControl<bool> |
DateTimeField | vyuh.formfield.datetime | FormControl<DateTime> |
SliderField | vyuh.formfield.slider | FormControl<double> |
RangeSliderField | vyuh.formfield.rangeSlider | FormControl<RangeValues> |
PhoneNumberField | vyuh.formfield.phoneNumber | FormControl<String> |
ImagePickerField | vyuh.formfield.imagePicker | FormControl<List<XFile>?> |
FilePickerField | vyuh.formfield.filePicker | FormControl<List<PlatformFile>?> |
FormulaField | vyuh.formfield.formula | Computed |
ReferenceField | vyuh.formfield.reference | FormControl<String> / FormControl<List<String>> |
Validations
| Type | Schema | Category |
|---|---|---|
RequiredValidation | formfield.validation.required | Sync |
EmailValidation | formfield.validation.text.email | Sync |
UrlValidation | formfield.validation.text.url | Sync |
PatternValidation | formfield.validation.pattern | Sync |
TextLengthValidation | formfield.validation.text.length | Sync |
MinLengthValidation | formfield.validation.minLength | Sync |
MaxLengthValidation | formfield.validation.maxLength | Sync |
NumberRangeValidation | formfield.validation.numberRange | Sync |
DateRangeValidation | formfield.validation.dateRange | Sync |
CreditCardValidation | formfield.validation.text.creditCard | Sync |
IpAddressValidation | formfield.validation.text.ipAddress | Sync |
FutureDateValidation | formfield.validation.futureDate | Sync |
PastDateValidation | formfield.validation.pastDate | Sync |
BusinessHoursValidation | formfield.validation.businessHours | Sync |
DateDependencyValidation | formfield.validation.dateDependency | Context-Aware |
SoftRangeValidation | formfield.validation.softRange | Soft |
CustomAsyncValidation | async | Async |
Rules
| Conditions | Schema |
|---|---|
BooleanCondition | vyuh.form.condition.boolean |
StringCondition | vyuh.form.condition.string |
NumericCondition | vyuh.form.condition.numeric |
DateCondition | vyuh.form.condition.date |
EmptyCondition | vyuh.form.condition.empty |
CompoundCondition | vyuh.form.condition.compound |
| Actions | Schema |
|---|---|
VisibilityAction | vyuh.form.action.visibility |
EnabledAction | vyuh.form.action.enabled |
SetValueAction | vyuh.form.action.setValue |
FocusAction | vyuh.action.focus |
ValidationAction | vyuh.action.validation |
CompoundAction | vyuh.action.compound |
FormBuilder DSL
| Method | Returns | Description |
|---|---|---|
FormBuilder(title: ...) | FormBuilder | Start building a form |
.text(name, title:) | TextFieldBuilder | Add a text field |
.number(name, title:) | NumberFieldBuilder | Add a number field |
.select(name, title:) | SelectFieldBuilder | Add a select field |
.boolean(name, title:) | BooleanFieldBuilder | Add a boolean field |
.dateTime(name, title:) | DateTimeFieldBuilder | Add a date/time field |
.slider(name, title:, ...) | SliderFieldBuilder | Add a slider field |
.phone(name, title:) | PhoneFieldBuilder | Add a phone field |
.file(name, title:) | FileFieldBuilder | Add a file picker field |
.image(name, title:) | ImageFieldBuilder | Add an image picker field |
.formula(name, title:, expression:) | FormulaFieldBuilder | Add a formula field |
.reference(name, title:) | ReferenceFieldBuilder | Add a reference field |
.section(title, configure) | FormBuilder | Add a section |
.build() | Form | Build the form |
Editor (vyuh_form_editor)
| Type | Description |
|---|---|
FormEditor | Main editor widget |
FormEditorStore | MobX state store |
FormEditorRegistry | Type registry and compositor |
FormEditorDescriptor | Declarative editor configuration |
FieldType | Abstract base for field type definitions |
FieldInstance | Configured field in the editor |
BlockContainer | Shared editor-side container mixin for form, row, section, and repeating section instances |
RowInstance | Editor-side row whose child fields carry 12-column spans |