Text Input¶

A simple text input field.

Tag¶

"type": "input"

Values¶

The input type supports the following values:

`placeholder`¶

A text which will be displayed in the input field before any input.

`required`¶

A boolean which defaults to false. When set to true, the input field may not be left empty. As long as it is empty, the send button is disabled.

Note

A required input which is also disabled will not block the send button.

`default`¶

A value which pre-fills the input field. It will also be passed to the device when the user does not change the input.

Argument Passed to the Device¶

This section describes the value (VALUE_FROM_THE_USER) which will get passed to the device. Read the Parameters section of the device.execute method for the general structure of the argument.

The value will be the text entered.

Example¶

This example shows how this type of option will look in the webapp.

Option configuration¶

{
    "name": "Enter a message to display on the devices screen",
    "type": "input",
    "id": "input-1",
    "values": {
        "placeholder": "Message",
        "required": true,
        "default": "Hello World!"
    }
}

Result¶

input example

passed value:

{
    "id": "input-1",
    "value": "<VALUE_ENTERED>"
}

VALUE_ENTERED will be the message which is entered in the application by the user - for example “Hello World!”