Interface IUiIframe

interface IUiIframe {
    getTheme: (() => Promise<{
        lightMode: "light" | "dark" | "auto";
        radius: number;
        theme:
            | "zinc"
            | "slate"
            | "stone"
            | "gray"
            | "neutral"
            | "red"
            | "rose"
            | "orange"
            | "green"
            | "blue"
            | "yellow"
            | "violet";
    }>);
    goBack: (() => Promise<void>);
    hideBackButton: (() => Promise<void>);
    hideMoveButton: (() => Promise<void>);
    hideRefreshButton: (() => Promise<void>);
    internalToggleMaximize: (() => Promise<void>);
    registerDragRegion: (() => Promise<void>);
    reloadPage: (() => Promise<void>);
    setTransparentWindowBackground: ((transparent: boolean) => Promise<void>);
    showBackButton: ((position?: Position) => Promise<void>);
    showMoveButton: ((position?: Position) => Promise<void>);
    showRefreshButton: ((position?: Position) => Promise<void>);
    startDragging: (() => Promise<void>);
    toggleMaximize: (() => Promise<void>);
}

Properties

getTheme goBack hideBackButton hideMoveButton hideRefreshButton internalToggleMaximize registerDragRegion reloadPage setTransparentWindowBackground showBackButton showMoveButton showRefreshButton startDragging toggleMaximize

Properties

getTheme

getTheme: (() => Promise<{
    lightMode: "light" | "dark" | "auto";
    radius: number;
    theme:
        | "zinc"
        | "slate"
        | "stone"
        | "gray"
        | "neutral"
        | "red"
        | "rose"
        | "orange"
        | "green"
        | "blue"
        | "yellow"
        | "violet";
}>)

goBack

goBack: (() => Promise<void>)

hideBackButton

hideBackButton: (() => Promise<void>)

hideMoveButton

hideMoveButton: (() => Promise<void>)

hideRefreshButton

hideRefreshButton: (() => Promise<void>)

internalToggleMaximize

internalToggleMaximize: (() => Promise<void>)

registerDragRegion

registerDragRegion: (() => Promise<void>)

reloadPage

reloadPage: (() => Promise<void>)

setTransparentWindowBackground

setTransparentWindowBackground: ((transparent: boolean) => Promise<void>)

showBackButton

showBackButton: ((position?: Position) => Promise<void>)

position can be "top-left" | "top-right" | "bottom-left" | "bottom-right" | CustomPosition CustomPosition is an object with optional top, right, bottom, left properties Each property is a number, with rem unit, and will be applied to css top, right, bottom, left properties

Type declaration

    • (position?): Promise<void>

    • Parameters

      • Optionalposition: Position

        "top-left" | "top-right" | "bottom-left" | "bottom-right" | CustomPosition

      Returns Promise<void>

Example

ui.showBackButton({ top: 2, left: 2 })
ui.showBackButton('top-right')

showMoveButton

showMoveButton: ((position?: Position) => Promise<void>)

position can be "top-left" | "top-right" | "bottom-left" | "bottom-right" | CustomPosition CustomPosition is an object with optional top, right, bottom, left properties Each property is a number, with rem unit, and will be applied to css top, right, bottom, left properties

Type declaration

    • (position?): Promise<void>

    • Parameters

      • Optionalposition: Position

        "top-left" | "top-right" | "bottom-left" | "bottom-right" | CustomPosition

      Returns Promise<void>

Example

ui.showBackButton({ top: 2, left: 2 })
ui.showBackButton('top-right')

showRefreshButton

showRefreshButton: ((position?: Position) => Promise<void>)

startDragging

startDragging: (() => Promise<void>)

toggleMaximize

toggleMaximize: (() => Promise<void>)

Settings

Member Visibility

On This Page

Properties