API Docs for version 1.2.6002

FormControl

Module: Circuit

Summary

Object to define a form control

Properties

action

Syntax

action

String

Summary

Click action for buttons. Possible values are: 'submit' (submits form), 'reset' (resets form), 'submit_reset' (submit and then resets form). 'submit' is the default.

defaultValue

Syntax

defaultValue

String

Summary

Default value of the control. For dropdown for example this can be used to preselect a value. Not applicable to buttons.

name

Syntax

name

String

Summary

Name of the control

notification

Syntax

notification

String

Summary

Notification message shown to user when performing an action (clicking a button)

options

Syntax

options

FormOption[]

Summary

Options of a group control. Applicable for type 'BUTTON', 'RADIO', 'CHECKBOX', e.g. individual buttons of a radio button control. Note that buttons or checkboxes can also be define as single control without using options.

rows

Syntax

rows

Number

Summary

Number of rows for input fields

size

Syntax

size

String

Summary

Width of input field. 'small', 'medium' or 'large'. Applicable for input control only. Defaults to medium. For rows > 1, defaults to large.

text

Syntax

text

String

Summary

Text of the control. The displayed text/label of the control. For input fields this is the placeholder, for checkbox its the label, for buttons the button text, etc

title

Syntax

title

String

Summary

Title of the control

value

Syntax

value

String

Summary

Initial value of control. E.g. initial populated value for input field.

value

Syntax

value

String

Summary

Initial value of control. E.g. initial populated value for input field.