From 96ab05c933559c8016d5f03b0755edcc2e825825 Mon Sep 17 00:00:00 2001 From: Reiss Cashmore Date: Mon, 30 Oct 2023 14:18:09 +0000 Subject: [PATCH] Update docs formatting --- docs/widgets/services/iframe.md | 72 +++++++++++++++++++-------------- mkdocs.yml | 1 + 2 files changed, 42 insertions(+), 31 deletions(-) diff --git a/docs/widgets/services/iframe.md b/docs/widgets/services/iframe.md index e96be2b1..d1cc7eb7 100644 --- a/docs/widgets/services/iframe.md +++ b/docs/widgets/services/iframe.md @@ -1,46 +1,56 @@ --- title: iFrame -description: Add a custom iFrame Widget +Description: Add a custom iFrame Widget --- -name -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 +### name +**Type:** string -src -Type: string (URL) -Description: URL of the content to load within the iFrame +**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 -sizes -Type: object {"xs": '60', "sm": "60", "md": "80", "lg": "80", "xl": "80", "2xl": "80"} -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 +### src +**Type:** string (URL) -referrerpolicy -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 +**Description:** URL of the content to load within the iFrame -allowfullscreen -Type: boolean [true | false] -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 +### sizes +**Type:** object {"xs": '60', "sm": "60", "md": "80", "lg": "80", "xl": "80", "2xl": "80"} -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 +**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 -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 +### referrerpolicy +**Type:** string ["no-referrer" | "no-referrer-when-downgrade" | "origin" | "origin-when-cross-origin" | "same-origin" | "strict-origin-when-cross-origin" | "unsafe-url"] -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 +**Description:** https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy -refreshInterval -Type: number (in milliseconds) -Description: This will refresh the iframe on an interval +### allowfullscreen +**Type:** boolean [true | false] -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 +**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 +**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 widget: diff --git a/mkdocs.yml b/mkdocs.yml index 4dc382f9..f356c150 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -63,6 +63,7 @@ nav: - widgets/services/healthchecks.md - widgets/services/homeassistant.md - widgets/services/homebridge.md + - widgets/services/iframe.md - widgets/services/immich.md - widgets/services/jackett.md - widgets/services/jdownloader.md