PostMessage RPC API Documentation - v0.2.2
    Preparing search index...

    Interface FullscreenPlugin

    The interface returned by initFullscreenPlugin

    interface FullscreenPlugin {
        container: HTMLDivElement;
        src: string;
        methods: Record<string, Method>;
        showSplashScreen: () => void | Promise<void>;
        hideSplashScreen: () => void;
        show: (options?: AnimationOptions) => void;
        hide: () => void | Promise<void>;
        destroy: () => Promise<void>;
    }
    Index

    Properties

    container src methods showSplashScreen hideSplashScreen show hide destroy

    Properties

    container: HTMLDivElement
    src: string
    methods: Record<string, Method>

    Map of method names to async method implementations

    showSplashScreen: () => void | Promise<void>

    Show the splash screen if configured

    hideSplashScreen: () => void

    Hide the splash screen

    show: (options?: AnimationOptions) => void

    Show the plugin with animation

    hide: () => void | Promise<void>

    Hide the plugin with animation

    destroy: () => Promise<void>

    Hide and remove the plugin from DOM

    Settings

    Member Visibility

    On This Page

    Properties