Update docs formatting
This commit is contained in:
parent
a791530bcc
commit
96ab05c933
@ -1,46 +1,56 @@
|
|||||||
---
|
---
|
||||||
title: iFrame
|
title: iFrame
|
||||||
description: Add a custom iFrame Widget
|
Description: Add a custom iFrame Widget
|
||||||
---
|
---
|
||||||
name
|
### name
|
||||||
Type: string
|
**Type:** string
|
||||||
Description: Important to allow the iframe to be unique on the page and helps if you would like to target the iframe with a button
|
|
||||||
|
|
||||||
src
|
**Description:** Important to allow the iframe to be unique on the page and helps if you would like to target the iframe with a button
|
||||||
Type: string (URL)
|
|
||||||
Description: URL of the content to load within the iFrame
|
|
||||||
|
|
||||||
sizes
|
### src
|
||||||
Type: object {"xs": '60', "sm": "60", "md": "80", "lg": "80", "xl": "80", "2xl": "80"}
|
**Type:** string (URL)
|
||||||
Description: Controls the height of the iframe (width is always 100%) The value for each breakpoint size must map directly to a field in the Tailwind Height CSS classes - https://tailwindcss.com/docs/height
|
|
||||||
|
|
||||||
referrerpolicy
|
**Description:** URL of the content to load within the iFrame
|
||||||
Type: string ["no-referrer" | "no-referrer-when-downgrade" | "origin" | "origin-when-cross-origin" | "same-origin" | "strict-origin-when-cross-origin" | "unsafe-url"]
|
|
||||||
Description: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy
|
|
||||||
|
|
||||||
allowfullscreen
|
### sizes
|
||||||
Type: boolean [true | false]
|
**Type:** object {"xs": '60', "sm": "60", "md": "80", "lg": "80", "xl": "80", "2xl": "80"}
|
||||||
Description: Controls whether you can interact with a fullscreen button from within the iframe content and have the content expand into fullscreen - https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#allowfullscreen
|
|
||||||
|
|
||||||
loading
|
**Description:** Controls the height of the iframe (width is always 100%) The value for each breakpoint size must map directly to a field in the Tailwind Height CSS classes - https://tailwindcss.com/docs/height
|
||||||
Type: string ["eager" | "lazy"]
|
|
||||||
Description: Changes the loading style of the iframe, delaying the loading until other assets are finished - https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#loading
|
|
||||||
|
|
||||||
allowScrolling
|
### referrerpolicy
|
||||||
Type: string ["yes" | "no"]
|
**Type:** string ["no-referrer" | "no-referrer-when-downgrade" | "origin" | "origin-when-cross-origin" | "same-origin" | "strict-origin-when-cross-origin" | "unsafe-url"]
|
||||||
Description: Will disable scrolling and visible scrollbars. Deprecated, but still implemented by major browsers (for now) - https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#scrolling
|
|
||||||
|
|
||||||
border
|
**Description:** https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy
|
||||||
Type: number
|
|
||||||
Description: Will remove the small border present on some browsers. Deprecated, but still implemented by major browsers (for now) - https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#frameborder
|
|
||||||
|
|
||||||
refreshInterval
|
### allowfullscreen
|
||||||
Type: number (in milliseconds)
|
**Type:** boolean [true | false]
|
||||||
Description: This will refresh the iframe on an interval
|
|
||||||
|
|
||||||
allowPolicy
|
**Description:** Controls whether you can interact with a fullscreen button from within the iframe content and have the content expand into fullscreen - https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#allowfullscreen
|
||||||
Type: string
|
|
||||||
Description: Allows you to control some of the permissions and functionality that is allowed within the iFrame content. You can combine as many directives from the following list into a single string separated by space characters - https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Permissions-Policy
|
### loading
|
||||||
|
**Type:** string ["eager" | "lazy"]
|
||||||
|
|
||||||
|
**Description:** Changes the loading style of the iframe, delaying the loading until other assets are finished - https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#loading
|
||||||
|
|
||||||
|
### allowScrolling
|
||||||
|
**Type:** string ["yes" | "no"]
|
||||||
|
|
||||||
|
**Description:** Will disable scrolling and visible scrollbars. Deprecated, but still implemented by major browsers (for now) - https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#scrolling
|
||||||
|
|
||||||
|
### border
|
||||||
|
**Type:** number
|
||||||
|
|
||||||
|
**Description:** Will remove the small border present on some browsers. Deprecated, but still implemented by major browsers (for now) - https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#frameborder
|
||||||
|
|
||||||
|
### refreshInterval
|
||||||
|
**Type:** number (in milliseconds)
|
||||||
|
|
||||||
|
**Description:** This will refresh the iframe on an interval
|
||||||
|
|
||||||
|
### allowPolicy
|
||||||
|
**Type:** string
|
||||||
|
|
||||||
|
**Description:** Allows you to control some of the permissions and functionality that is allowed within the iFrame content. You can combine as many directives from the following list into a single string separated by space characters - https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Permissions-Policy
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
widget:
|
widget:
|
||||||
|
|||||||
@ -63,6 +63,7 @@ nav:
|
|||||||
- widgets/services/healthchecks.md
|
- widgets/services/healthchecks.md
|
||||||
- widgets/services/homeassistant.md
|
- widgets/services/homeassistant.md
|
||||||
- widgets/services/homebridge.md
|
- widgets/services/homebridge.md
|
||||||
|
- widgets/services/iframe.md
|
||||||
- widgets/services/immich.md
|
- widgets/services/immich.md
|
||||||
- widgets/services/jackett.md
|
- widgets/services/jackett.md
|
||||||
- widgets/services/jdownloader.md
|
- widgets/services/jdownloader.md
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user