panel_custom support allows you to add additional panels to your Home Assistant frontend. The panels are listed in the sidebar if wished and can be highly customized. See the developer documentation on instructions how to build your own panels.
To enable customized panels in your installation, add the following to your
# Example configuration.yaml entry panel_custom: - name: my-panel sidebar_title: TodoMVC sidebar_icon: mdi:work url_path: my-todomvc js_url: /local/my-panel.js config: who: world
Store your custom panels in
<config>/www to make them available in the frontend at the path
- name (Required): Name of the web component that renders your panel.
- sidebar_title (Optional): Friendly title for the panel in the sidebar. Omitting it means no sidebar entry (but still accessible through the URL).
sidebar_icon (Optional): Icon for entry. Pick an icon that you can find on materialdesignicons.com to use for your input and prefix the name with
mdi:. For example
- url_path (Optional): The URL your panel will be available on in the frontend. If omitted will default to the panel name.
- config (Optional): Configuration to be passed into your web component when being instantiated.
embed_iframe (Optional): Set to
trueto embed panel in iframe. This is necessary if the panel is panel is using the React framework or if it contains conflicting web components.
trust_external_script (Optional): By default the user has to confirm before loading a script from an external source. Setting this to
truewill omit this confirmation.
webcomponent_path (Optional DEPRECATED): The HTML path to your component. If omitted will default to
<config dir>/panels/<component name>.html