Input Box

Image

Property JSON

{
    "type": "InputBox",
    "properties": {
        "labelName": "Button Text:",
        "shortPropertyName": "",
        "disabled": false,
        "type": "Text",
        "min": 0,
        "max": 0,
        "step": 1,
        "allowBinding": true,
        "allowCounter": false,
        "allowManualEntry": true,
        "spellcheck": false,
        "placeholder": "",
        "textArea": false,
        "textAreaRows": 5,
        "liveUpdate": false,
        "bindingPropertyName": "buttonText"
    }
}

State definition

The property name needs to match the string specified in bindingPropertyName property. The value will be the default value to show in the input box.

{
    "buttonText": "Get Data"
}

This element has a large number of configurable properties. If a property has a default value then you do not need to provide it in the propertyPanel.json file unless you want to specify a value different to the default.

Configurable properties

bindingPropertyName

string - the property name from defaultState with which to connect to.

mandatory

labelName

string - the text to display above the input box as a title

mandatory

shortPropertyName

string - the text to display inside and on the right of the text input box.

defaults to an empty string

disabled

bool - if set to true this will disable the input box for interaction

defaults to false

type

string ( Text | Integer | Decimal | Currency | Percent | Password | URL )

defaults to Text

min

number - the minimum value allowed to be entered

For Integer, Decimal, Currency and Percent types

defaults to 0

max

number - the maximum value allowed to be entered

For Integer, Decimal, Currency and Percent types

defaults to 0

step

number - the size of increments a number increases in when using allowCounter

For Integer, Decimal, Currency and Percent types

defaults to 0

allowBinding

bool - specifies whether you want the input field to be bindable or not

defaults to true

allowManualEntry

bool - specifies whether you want people to be able to type values into the input box

defaults to true

allowCounter

bool - specifies whether to add up and down stepper arrows to the input box

For Integer, Decimal, Currency and Percent types

defaults to false

spellcheck

bool - specifies whether you want the browser to highlight incorrect spelling in text within the text input box

defaults to true

placeholder

string - what placeholder text to display in the empty input box

defaults to empty string

textArea

bool - specifies whether the input box is a single line text input, or a multi-line text area input

defaults to false

textAreaRows

number - specifies how many rows tall to make the text area input

defaults to 5

liveUpdate

bool - specifies whether you want each key press in the input box to trigger an update in state. Note this will trigger communication to the addon for each key press

defaults to false