Textfield

The <sdpi-textfield> component provides a styled wrapper of <input type="text">.

Example

Property Inspector HTML

<sdpi-item label="Textfield">
    <sdpi-textfield
        setting="first_name"
        pattern="/^[a-z ,.'-]+$/i"
        placeholder="First name"
        required>
    </sdpi-textfield>
</sdpi-item>

Result

value

The value of <sdpi-textfield> is represented as a boolean.

{
    "first_name": "Richard"
}

Configuration

The component supports the following configuration.

Name	Type	Description
disabled	boolean	Determines whether the input is disabled.
maxlength	number	Optional maximum length of the value.
pattern	string	Optional regular expression used to validate the input.
placeholder	string	Optional placeholder text shown in the input.
required	boolean	When present, an icon is shown in the input if the value is empty.
value	string	The value of the component, and the persisted setting.

Persistence

The value of the component can be automatically persisted to the Stream Deck with the following configuration.

Name	Type	Description
global	boolean	When present, the value will be persisted to the global settings.
setting	string	The path of the property where the value should be persisted in the settings.

setting

The setting represents the path of a property. If required, this path can denote a nested property within the settings, e.g. if the setting were foo.bar.prop, the value would be saved to:

{
    "foo": {
        "bar": {
            "prop": <value>
        }
    }
}