Form

Form

A Form object as defined in the JSON schema

Constructor

new Form(props)

Instantiates a new Form

Parameters:
Name Type Description
props object

Properties to initialize the Form with

Properties
Name Type Attributes Default Description
body Array.<FormItem>

Sets Form#body
method 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' 'POST'

Sets Form#method
path string

Sets Form#path
header string <optional>

Sets Form#header
footer string <optional>

Sets Form#footer
meta FormMeta <optional>

Sets Form#meta
Source:

Members

body :Array.<FormItem>

Sequence of FormItem objects used to acquire information from user

Source:

The footer of the form. It can be overwritten by each body component.

Source:

The header of the form. It can be overwritten by each body component.

Source:

meta :FormMeta

FormMeta` object. Contains configuration flags.

Source:

method :string

HTTP method indicating how to trigger the callback path. Defaults to "POST".

Default Value:
  • "POST"
Source:

path :string

The callback path used to send the serialized form data.

Source:

(readonly) type :string

Indicates the type of the object, defaults to "form"

Default Value:
  • "form"
Source:

Methods

(static) fromTag(formTag) → {Form}

Creates a Form from a FormTag

Parameters:
Name Type Description
formTag FormTag
Source: