home-assistant.io/source/_components/configurator.markdown
Alok Saboo 1aca7b08cf Misc fixes: e.g. -> e.g., and proper case for Home Assistant (#4942)
* e.g. to e.g., and proper case for Home Assistant

* Instructions how to -> Instructions on how to
2018-03-17 20:20:37 +01:00

27 lines
1.1 KiB
Markdown

---
layout: page
title: "Configurator"
description: "Instructions on how to integrate the configurator in your components."
date: 2015-03-15 00:51
sidebar: true
comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Other
---
<p class='note'>
This component is intended for developers.
</p>
The configurator component allows components to request information from the user. It is currently implemented as the minimum viable product:
- It supports showing a text, image and 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 component in [the demo](/demo) and Plex are implemented using the configurator. See [the source of the demo component](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/demo.py#L132) for a simple example.
See [the source](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/configurator.py#L39) for more details on how to use the configurator component.