presentation-form
Augmented.js Presentation Automatic Form View Module
API
Table of Contents
- AutomaticForm
- formCompile
AutomaticForm
Extends DecoratorView
A automatic form view created from a JSON Schema
Supported options:
- schema - The JSON Schema for use with the UI and validation
- data - prepopulate the model data
- crossOrigin - Set CORS for the fetch
- uri - the uri to fetch data from
- title - the title of the form
- description - set a tooltip for the form
- display - Array of fields to display (others are hidden)
- nestedInput - label wraps the input
- submitButton - set the name of the submit button (binds to a submit method)
- submitPrimary - set the submit button to primary (default)
- resetButton - set the name of the reset button (binds to a reset method)
- legacy - set legacy rendering (older look and feel)
- large - render large input fields
Parameters
-
options
Object Options for the class
_retrieveSchema
The crossOrigin property - enables cross origin fetch
Parameters
uri
Properties
-
crossOrigin
boolean The crossOrigin property
_retrieveSchema
The URI property
Parameters
uri
Properties
-
uri
string The URI property
_retrieveSchema
The model property
Parameters
uri
Properties
-
model
Model The model property
_retrieveSchema
The initialized property
Parameters
uri
Properties
-
isInitalized
boolean The initialized property
_retrieveSchema
The title property
Parameters
uri
Properties
-
title
string The title of the form
_retrieveSchema
The name property
Parameters
uri
Properties
-
name
string The name of the form
_retrieveSchema
The description property
Parameters
uri
Properties
-
description
string The description of the form
_retrieveSchema
Parameters
uri
Properties
-
display
array Fields to display - null will display all
_retrieveSchema
Parameters
uri
Properties
-
nestedInput
boolean Sets the input field as a chile of the label (defaults to false)
_retrieveSchema
Parameters
uri
Properties
-
submitButton
string The name of the submit button (defaults to null)
_retrieveSchema
Parameters
uri
Properties
-
resetButton
string The name of the reset button (defaults to null)
_retrieveSchema
Parameters
uri
Properties
-
legacy
boolean set legacy rendering
setURI
Sets the URI
Parameters
-
uri
string The URI
Meta
- deprecated: Use property
setSchema
Sets the schema
Parameters
-
schema
object The JSON schema of the dataset
showProgressBar
Enable/Disable the progress bar
Parameters
-
show
boolean Show or Hide the progress bar
showMessage
Show a message related to the form
Parameters
-
message
string Some message to display
validate
Validate the form
Returns boolean Returns true on success of validation
isValid
Is the form valid
Returns boolean Returns true if valid
render
Render the form
Returns object Returns the view context ('this')
reset
Reset the form
Returns object Returns the view context ('this')
populate
Populate the form
Parameters
-
data
object Data to fill in
Returns object Returns the view context ('this')
remove
Remove the form and all binds
formCompile
Parameters
-
name
string Name of the form -
description
string A description -
fields
object Object of fields with types (see JSON scheme properties format) -
model
object Data for the fields by key -
required
array Array of requires fields -
binding
string Name of the binding function -
display
array Array of fields to display -
nestedInput
Dom Dom tree of nested markup -
submitButton
string Name of the Submit button -
resetButton
string Name of the reset button -
style
string Name of styles -
tagName
string Name of tag -
legacy
boolean Set old markup style (optional, defaultfalse
) -
large
(optional, defaultfalse
) -
submitPrimary
boolean Set submit to primary (optional, defaulttrue
)
Returns Dom Dom tree of form elements