IFrame Component
IFrames are a way to embed other websites within Dynaboard, corresponding to the HTML iframe tag.
The website will be run inside of the browser sandbox, so its inner contents will not be directly available to Dynaboard. You can customize what permissions that iframe has using the various "Allow *" properties on the node.
Properties
Visible
| Prop | isVisible |
|---|---|
| Type | boolean |
| Default | true |
Whether or not this node is visible.
Enabled
| Prop | isEnabled |
|---|---|
| Type | boolean |
| Default | true |
Whether or not this node is enabled.
Tooltip
| Prop | tooltip |
|---|---|
| Type | string |
| Default | undefined |
The tooltip text to display when hovered or focused over this node.
Top
| Prop | top |
|---|---|
| Type | number |
| Default | 1 |
The position of the node from the top side of the grid (grid-row-start).
Left
| Prop | left |
|---|---|
| Type | number |
| Default | 1 |
The position of the node from the left side of the grid (grid-column-start).
Width
| Prop | width |
|---|---|
| Type | string |
| Default | 618px |
The width of the node. When this node is in a grid layout, this should be done using unitless grid column units (specifying 4 will become grid-column-end: span 4). When this node is in a stack layout, the width can be specified using CSS units (e.g. 100px or 100%), or be left unitless to be treated as flex-grow for the node.
Min Width
| Prop | minWidth |
|---|---|
| Type | string |
| Default | undefined |
The minimum width of the node. When this node is in a grid layout, this property is ignored.
Max Width
| Prop | maxWidth |
|---|---|
| Type | string |
| Default | undefined |
The maximum width of the node. When this node is in a grid layout, this property is ignored.
Height
| Prop | height |
|---|---|
| Type | string |
| Default | 432px |
The height of the node. When this node is in a grid layout, this should be done using unitless grid row units (specifying 4 will become grid-row-end: span 4). When this node is in a stack layout, the height can be specified using CSS units (e.g. 100px or 100%), or be left unitless to be treated as flex-grow for the node.
Min Height
| Prop | minHeight |
|---|---|
| Type | string |
| Default | undefined |
The minimum height of the node. When this node is in a grid layout, this property is ignored.
Max Height
| Prop | maxHeight |
|---|---|
| Type | string |
| Default | undefined |
The minimum height of the node. When this node is in a grid layout, this property is ignored.
Overflow
| Prop | overflow |
|---|---|
| Type | Overflow ('auto' | 'visible' | 'hidden' | 'scroll') |
| Default | auto |
The strategy used to handle overflow in the horizontal and vertical axes for content that is larger than its container.
Overflow X
| Prop | overflowX |
|---|---|
| Type | Overflow ('auto' | 'visible' | 'hidden' | 'scroll') |
| Default | auto |
The strategy used to handle overflow in the horizontal axis for content that is larger than its container.
Overflow Y
| Prop | overflowY |
|---|---|
| Type | Overflow ('auto' | 'visible' | 'hidden' | 'scroll') |
| Default | auto |
The strategy used to handle overflow in the vertical axis for content that is larger than its container.
Custom Styles
| Prop | styles |
|---|---|
| Type | string |
| Default | ::component { } |
Custom CSS styles to be applied to the node. Use element.styles to refer to the current node.
Object Fit
| Prop | objectFit |
|---|---|
| Type | ObjectFit ('none' | 'contain' | 'cover' | 'fill' | 'scale-down') |
| Default | cover |
The strategy used to set how the content of a replaced element should be resized to fit its container.
URL
| Prop | url |
|---|---|
| Type | string |
| Default | https://dynaboard.com/docs/reference/nodes/components/iframe |
The URL of the external page to use as the source (src) of the iframe.
Allow Fullscreen
| Prop | allowFullscreen |
|---|---|
| Type | boolean |
| Default | true |
Whether or not to allow the iframe to become fullscreen.
Allow Camera
| Prop | allowCamera |
|---|---|
| Type | boolean |
| Default | true |
Whether or not to allow the iframe to request camera access.
Allow Microphone
| Prop | allowMicrophone |
|---|---|
| Type | boolean |
| Default | true |
Whether or not to allow the iframe to request microphone access.
Allow Forms
| Prop | allowForms |
|---|---|
| Type | boolean |
| Default | true |
Whether or not to allow forms in the iframe.
Allow Downloads
| Prop | allowDownloads |
|---|---|
| Type | boolean |
| Default | false |
Whether or not to allow downloads in the iframe.
Allow Popups
| Prop | allowPopups |
|---|---|
| Type | boolean |
| Default | false |
Whether or not to allow the iframe to open popup windows.
Allow Same Origin
| Prop | allowSameOrigin |
|---|---|
| Type | boolean |
| Default | true |
Whether or not to allow the iframe to access hosts on the same origin.
Allow Scripts
| Prop | allowScripts |
|---|---|
| Type | boolean |
| Default | true |
Whether or not to allow the iframe to run scripts (JavaScript).
Allow Top Navigation
| Prop | allowTopNavigation |
|---|---|
| Type | boolean |
| Default | true |
Whether or not to allow the iframe content to navigate its top-level browsing context.
Event Handlers
On Hover
| Handler | iframeNode.onHover |
|---|
Called when the user hovers on the node. Use this event to trigger downstream actions when this node is hovered.
On Leave
| Handler | iframeNode.onLeave |
|---|
Called when the user is not hovering over the node. Use this event to trigger downstream actions when this node is no longer hovered.