2.4 KiB
| layout | title | description | date | sidebar | comments | sharing | footer | logo | ha_category | ha_release | ha_qa_scale |
|---|---|---|---|---|---|---|---|---|---|---|---|
| page | Input Text | Instructions on how to integrate the Input Text component into Home Assistant. | 2016-03-15 06:00 | true | false | true | true | home-assistant.png | Automation | 0.53 | internal |
The input_text component allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. Changes to the value stored in the text box generate state events. These state events can be utilized as automation triggers as well. It can also be configured in password mode (obscured text).
# Example configuration.yaml entries
input_text:
text1:
name: Text 1
initial: Some Text
text2:
name: Text 2
min: 8
max: 40
text3:
name: Text 3
pattern: '[a-fA-F0-9]*'
text4:
name: Text 4
mode: password
{% configuration %}
input_text:
description: Alias for the input. Multiple entries are allowed.
required: true
type: map
keys:
name:
description: Friendly name of the text input.
required: false
type: String
min:
description: Minimum length for the text value.
required: false
type: integer
default: 0
max:
description: Maximum length for the text value.
required: false
type: integer
default: 100
initial:
description: Initial value when Home Assistant starts.
required: false
type: String
default: empty
pattern:
description: Regex pattern for client side validation.
required: false
type: String
default: empty
mode:
description: Can specify text or password. Elements of type "password" provide a way for the user to securely enter a value.
required: false
type: String
default: text
{% endconfiguration %}
{% linkable_title Restore State %}
This component will automatically restore the state it had prior to Home Assistant stopping as long as you have the recorder component enabled and your entity does not have a set value for initial. To disable this feature, set a valid value for initial. Additional information can be found in the Restore state section of the recorder component documentation.