From 35a53870107563a6d147257e3933a9aad3ce0088 Mon Sep 17 00:00:00 2001 From: Reiss Cashmore Date: Mon, 30 Oct 2023 14:32:15 +0000 Subject: [PATCH] Improve docs --- docs/widgets/services/iframe.md | 80 ++++++++++++++++++++------------- 1 file changed, 50 insertions(+), 30 deletions(-) diff --git a/docs/widgets/services/iframe.md b/docs/widgets/services/iframe.md index d1cc7eb7..303d8e7c 100644 --- a/docs/widgets/services/iframe.md +++ b/docs/widgets/services/iframe.md @@ -3,54 +3,74 @@ title: iFrame 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 +**Type:** string
+**Default:** null
+**Required:** Yes
+**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
+**Example:** "myIframe" ### src -**Type:** string (URL) - -**Description:** URL of the content to load within the iFrame +**Type:** string (URL)
+**Default:** null
+**Required:** Yes
+**Description:** URL of the content to load within the iFrame
+**Example:** "http://example.com" ### 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 +**Type:** object
+**Default:** {"xs": '60', "sm": "60", "md": "80", "lg": "80", "xl": "80", "2xl": "80"}
+**Required:** No
+**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 - [Tailwind Docs](https://tailwindcss.com/docs/height)
+**Example:** "{"xs": '32', "sm": "12", "md": "44", "lg": "60", "xl": "72", "2xl": "80"}" ### 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 +**Type:** string ["no-referrer" | "no-referrer-when-downgrade" | "origin" | "origin-when-cross-origin" | "same-origin" | "strict-origin-when-cross-origin" | "unsafe-url"]
+**Default:** null
+**Required:** No
+**Description:** [MSDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy)
+**Example:** "no-referrer" ### 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 +**Type:** boolean [true | false]
+**Default:** null
+**Required:** No
+**Description:** Controls whether you can interact with a fullscreen button from within the iframe content and have the content expand into fullscreen - [MSDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#allowfullscreen)
+**Example:** false ### 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 +**Type:** string ["eager" | "lazy"]
+**Default:** null
+**Required:** No
+**Description:** Changes the loading style of the iframe, delaying the loading until other assets are finished - [MSDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#loading)
+**Example:** "lazy" ### 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 +**Type:** string ["yes" | "no"]
+**Default:** null
+**Required:** No
+**Description:** Will disable scrolling and visible scrollbars. Deprecated, but still implemented by major browsers (for now) - [MSDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#scrolling)
+**Example:** "no" ### 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 +**Type:** number
+**Default:** null
+**Required:** No
+**Description:** Will remove the small border present on some browsers. Deprecated, but still implemented by major browsers (for now) - [MSDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#frameborder)
+**Example:** 2 ### refreshInterval -**Type:** number (in milliseconds) - -**Description:** This will refresh the iframe on an interval +**Type:** number (in milliseconds)
+**Default:** null
+**Required:** No
+**Description:** This will refresh the iframe on an interval
+**Example:** 2000 ### 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 +**Type:** string
+**Default:** null
+**Required:** No
+**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 - [MSDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Permissions-Policy)
+**Example:** "autoplay fullscreen gamepad" ```yaml widget: