home-assistant.github.io/source/_components/input_text.markdown
cdce8p 5b873e2380 Added Restore state info + Updated config style (#4343)
* Updated input_boolean

* new Configuration style
* Linkable title Automation Examples

* Updated input_select

* new Configuration style
* Services as table
* Rearaged scenes
* small improvments

* Updated input_number

* linkformat

* Updated input_text

* New configuration style

* Update input_datetime

* New configuration style

* Updated recorder

* New configuration style

* Added Restore State Info
2018-01-05 11:53:52 +01:00

2.1 KiB

layout title description date sidebar comments sharing footer logo ha_category ha_release
page Input Text Instructions 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

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.

# 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]*'

{% 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: int default: 0 max: description: Maximum length for the text value. required: false type: int 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 {% endconfiguration %}

{% linkable_title Restore State %}

This component supports the restore_state function which restores the state value after Home Assistant has started to the value it has been before Home Assistant stopped. The use this feature please make sure that the recorder component is enabled and your entity does not have and initial value. Additional information and a list of components that support this feature can be found here recorder/#restore-state.