The iFrame component embeds an external web page or application in a sandboxed inline frame. Use it to display third-party content, dashboards, or web apps directly in a module.
How to read settings tables
The tables below describe each configurable option as it displays in the Unqork IDE. Values are formatted as follows:
inline code— a value to type exactly as shown | Bold — a value selected from a drop-down, radio button, tab, or choice chip | ON/OFF — toggle state | ✓ — checkbox checked | ☐ — checkbox unchecked
General Settings
| Setting | Field | Type | Default | Description |
|---|---|---|---|---|
| Property ID | key |
Text input | iframe |
The unique identifier for this component instance. |
Display Settings
Default State Options
| Setting | Field | Type | Default | Description |
|---|---|---|---|---|
| Hide Field | hidden |
Toggle | OFF | Hides the iFrame from end-users but always displays in the Module Builder. |
Formatting
| Setting | Field | Type | Default | Description |
|---|---|---|---|---|
| URL | options.src |
Text input | — | The URL of the external page or application to embed. |
| Width | options.width |
Number input | — | The width of the iFrame in pixels (px). |
| Height | options.height |
Number input | — | The height of the iFrame in pixels (px). |
| custom CSS class | customClass |
Text input | — | A CSS class applied to the iFrame for custom styling. |
Accessibility Settings
For details on each setting, its options, and when to use it, see Accessibility Settings Reference.
| Setting | Field | Type | Default | Description |
|---|---|---|---|---|
| Title | title |
Text input | — | A descriptive title for the iFrame that accurately conveys its contents to users navigating with assistive technology. |
Operations Builder
This component supports the Operations Builder in Vega modules. When the module or panel runtime is set to Vega (2.0), an Event Handlers section displays in the settings panel for configuring event-driven operations.
Changelog
| Date | Change |
|---|---|
| — | Initial publication. |