c0ffeeca7 473d9d3fae
Dashboards: apply sentence style caps (#29890)
* Dashboards: apply sentence-style capitalization

* Apply sentence-style capitalization, apply reuse

* Apply suggestions from code review

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>

* Apply suggestions from code review

* Add substep on dashboard control

* Remove code fence from title

- to focus on the topic of the content, rather than the code itself

* Apply suggestions from code review

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>

---------

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>
2023-11-18 11:47:45 +01:00

59 lines
1.9 KiB
Markdown

---
type: card
title: "Webpage card"
sidebar_label: Webpage
description: "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>`.
<p class='img'>
<img width="500" src='/images/dashboards/iframe.png' alt='Windy weather radar as Webpage'>
Windy weather radar as webpage.
</p>
{% include dashboard/edit_dashboard.md %}
All options for this card can be configured via the user interface.
<div class='note warning'>
You can't embed sites using HTTP if you are using HTTPS for your Home Assistant.
</div>
## 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
{% endconfiguration %}
### Examples
```yaml
type: iframe
url: https://www.home-assistant.io
aspect_ratio: 75%
```