Theia API Documentation v1.65.0
    Preparing search index...

    Further options for opening a new Mini Browser widget.

    interface MiniBrowserOpenerOptions {
        iconClass?: string;
        mode?: WidgetOpenMode;
        name?: string;
        openFor?: "source" | "preview";
        resetBackground?: boolean;
        sandbox?: MiniBrowserProps.SandboxOptions[];
        startPage?: string;
        toolbar?: "show" | "hide" | "read-only";
        widgetOptions?: ApplicationShell.WidgetOptions;
    }

    Hierarchy (View Summary)

    Index

    Properties

    iconClass?: string

    The optional icon class for the widget.

    Determines whether the widget should be only opened, revealed or activated. By default is activate.

    name?: string

    The desired name of the widget.

    openFor?: "source" | "preview"

    Controls how the mini-browser widget should be opened.

    • source: editable source.
    • preview: rendered content of the source.
    resetBackground?: boolean

    true if the iFrame's background has to be reset to the default white color. Otherwise, false. false is the default.

    Sandbox options for the underlying iframe. Defaults to SandboxOptions#DEFAULT if not provided.

    startPage?: string

    If defined, the browser will load this page on startup. Otherwise, it show a blank page.

    toolbar?: "show" | "hide" | "read-only"

    show if the toolbar should be visible. If read-only, the toolbar is visible but the address cannot be changed and it acts as a link instead.
    hide if the toolbar should be hidden. show by default. If the startPage is not defined, this property is always show.

    Specify how an opened widget should be added to the shell. By default to the main area.