homepage/docs/widgets/services/iframe.md
Reiss Cashmore fb8d85b070 Update docs
2023-10-30 17:20:39 +00:00

2.4 KiB

title Description
iFrame Add a custom iFrame Widget

Basic Example

widget:
  type: iframe
  name: myIframe # string - required - Also helps if you would like to target the iframe with a button
  src: "http://example.com" # string - required - URL of the content to load within the iFrame

Full Example

widget:
  type: iframe
  name: myIframe # string - required - Also helps if you would like to target the iframe with a button
  src: "http://example.com" # string - required - URL of the content to load within the iFrame
  sizes: { "xs": "60", "sm": "60", "md": "80", "lg": "80", "xl": "80", "2xl": "80" } # optional - 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
  referrerPolicy: "same-origin" # string - optional - no default
  allowPolicy: "autoplay fullscreen gamepad" # string - optional - no default - Control the permissions for the iFrame content
  allowFullscreen: false # boolean - optional - default: true - Controls whether you can interact with a fullscreen button from within the iframe content and have the content expand into fullscreen
  loadingStrategy: "eager" # string - optional - default: "eager" - Make the iframe lazy load
  allowScrolling: "no" # string - optional - default: "yes" - Will disable scrolling and visible scrollbars. Deprecated, but still implemented by major browsers (for now)
  border: 0 # number - optional - default: 1 - Will remove the small border present on some browsers. Deprecated, but still implemented by major browsers (for now)
  refreshInterval: 2000 # number - optional - no default - This will refresh the iframe on an interval

Available Sizes

Tailwind Docs

References

referrerPolicy MSDN Reference allowFullscreen MSDN Reference loading MSDN Reference scrolling MSDN Reference border MSDN Reference allowPolicy MSDN Reference