3.0 KiB
type, title, sidebar_label, description, related
type | title | sidebar_label | description | related | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
card | Webpage card | Webpage | The webpage card allows you to embed your favorite webpage right into Home Assistant. |
|
The webpage card allows you to embed your favorite webpage right into Home Assistant. You can also embed files stored in your <config-directory>/www
folder and reference them using /local/<file>
.
The webpage card is used on the Webpage dashboard.
Windy weather radar as webpage.
{% include dashboard/edit_dashboard.md %}
All options for this card can be configured via the user interface.
Note that not every webpage can be embedded due to security restrictions that some sites have in place. These restrictions are enforced by your browser and prevent embedding them into a Home Assistant dashboard.
{% important %} You can't embed sites using HTTP if you are using HTTPS for your Home Assistant. {% endimportant %}
YAML configuration
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
{% configuration %}
type:
required: true
description: "iframe
"
type: string
url:
required: true
description: Website URL.
type: string
aspect_ratio:
required: false
description: 'Forces the height of the image to be a ratio of the width. Valid formats: Height percentage value (23%
) or ratio expressed with colon or "x" separator (16:9
or 16x9
). For a ratio, the second element can be omitted and will default to "1" (1.78
equals 1.78:1
).'
type: string
default: "50%"
allow_open_top_navigation:
required: false
description: 'Allow the user to open iframe content links by opening the default browser in the Home Assistant mobile app. It is false by default because it adds allow-top-navigation-by-user-activation on the iframe sandbox attribute which is less secure. So set it to true if you need it and are confident with the iframe content.'
type: boolean
default: false
title:
required: false
description: The card title.
type: string
allow:
required: false
description: The Permissions Policy of the iframe, that is, the value of the allow
attribute.
type: string
default: "fullscreen"
disable_sandbox:
required: false
description: Disables the sandbox attribute of the iframe, e.g. required for Chrome when viewing PDFs. This is less secure and should only be used if you trust the content of the iframe.
type: boolean
default: false
{% endconfiguration %}
Examples
type: iframe
url: https://www.home-assistant.io
aspect_ratio: 75%