home-assistant.io/source/_integrations/configurator.markdown
Madelena Mak d4c03fe1be
Update the theme to match branding better (#33462)
Co-authored-by: Franck Nijhof <git@frenck.dev>
2024-06-30 13:47:01 +02:00

1.1 KiB

title description ha_category ha_release ha_quality_scale ha_codeowners ha_domain ha_integration_type
Configurator Instructions on how to integrate the configurator into your integrations.
Other
0.7 internal
@home-assistant/core
configurator system

{% caution %} This integration is intended for developers. {% endcaution %}

The Configurator {% term integration %} allows integrations to request information from the user. It is currently implemented as the minimum viable product:

  • It supports showing a text, image, and a button to the user.
  • Input fields can be defined with a description, and optional type.
  • It will trigger a callback when the button is pressed.

The Hue integration in the demo and Plex are implemented using the configurator. See the source of the demo integration for a simple example.

See the source for more details on how to use the configurator integration.