foo-webview-sdk
    Preparing search index...

    Interface WebviewGetSourceSuccess

    Successful response from webview.getSource.

    interface WebviewGetSourceSuccess {
        activeTemplateName: string;
        directory?: string;
        source:
            | "url"
            | "devServer"
            | "panelTemplate"
            | "activeTemplate"
            | "componentDirectory"
            | "defaultTemplate"
            | "builtInPage";
        success: true;
        templateName?: string;
        templatesDirectory: string;
        url?: string;
    }
    Index
    activeTemplateName directory? source success templateName? templatesDirectory url?
    activeTemplateName: string

    The global active template as configured now, which can differ from the one loaded.

    directory?: string

    Folder mapped to https://foo-ui-webview2.local/; present for the four folder sources.

    source:
        | "url"
        | "devServer"
        | "panelTemplate"
        | "activeTemplate"
        | "componentDirectory"
        | "defaultTemplate"
        | "builtInPage"

    Where the page came from. devServer: the development server. url: a URL from the panel's configuration, or an absolute URL passed to window.createPopup. panelTemplate: the panel's own template. activeTemplate: the global active template. componentDirectory: foo_ui_webview2_resources\dist in the component's folder. defaultTemplate: webview-ui\default, reached because the folders before it had no index.html. builtInPage: the page shown when no folder had an index.html.

    success: true

    Always true here; a failed call resolves with ApiFailure instead.

    templateName?: string

    Name of the template folder that was loaded; present for panelTemplate, activeTemplate and defaultTemplate.

    templatesDirectory: string

    Folder that holds the templates, webview-ui under the foobar2000 profile.

    url?: string

    Address the host navigated to; present for devServer and url.

    Settings
    Member Visibility

    On This Page
    Properties