Type Alias PerseusIFrameWidgetOptions

Options for the iframe widget. Embeds external content in an iframe.

type PerseusIFrameWidgetOptions = {
    allowFullScreen: boolean;
    allowTopNavigation?: boolean;
    height: number | string;
    settings?: PerseusCSProgramSetting[];
    static: boolean;
    url: string;
    width: number | string;
}

Properties

allowFullScreen: boolean

Whether to allow the IFrame to become full-screen (like a video)

allowTopNavigation?: boolean

Whether to allow the iframe content to redirect the page

height: number | string

The height of the widget

Settings that you add here are available to the program as an object returned by Program.settings()

static: boolean

Always false

url: string

A URL to display OR a CS Program ID

width: number | string

The width of the widget