For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /api/elements/built-in/overlay-API.md.
Lynx
  • English
  • Attributes

    ios-enable-swipe-back

    iOS
    // @defaultValue: false
    'ios-enable-swipe-back'?: boolean;

    When overlay is displayed, 'true' allows swiping right to close the current page, 'false' does not allow it

    level

    Android
    iOS
    Desktop
    Harmony
    // @defaultValue: 1
    level?: 4 | 2 | 1 | 3;

    Introduces the concept of layers, which are divided into four levels. The larger the layer, the closer it is to the bottom. By default, it is the first level. The layers are arranged in order from 1 to 4. The displayed layer is specified and is not affected by the order of display. Within each layer, the arrangement is based on the 'last in, first out' logic. The layer cannot be dynamically adjusted when the overlay is displayed, and can only be adjusted when it is hidden. *

    mode

    iOS
    // @defaultValue: 'window'
    mode?: string;

    Specifies the level at which the overlay content resides on iOS. window: Mounted on the window, the top level of the app; top: Mounted on the topViewController; page: Mounted on UINavigationController; others: customize the name of class in the client.

    visible

    Android
    iOS
    Desktop
    Harmony
    // @defaultValue: false
    visible?: boolean;

    Control whether the overlay is displayed

    Events

    Frontend can bind corresponding event callbacks to listen for runtime behaviors of the element, as shown below.

    binddismissoverlay

    Android
    iOS
    Desktop
    Harmony
    binddismissoverlay = (e: BaseEvent) => {};

    Callback when the overlay is hidden.

    binderror

    Android
    2.18
    binderror = (e: OverlayErrorEvent) => {};
    FieldTypeOptionalDefaultPlatformsSinceDescription
    errorCodestringNo
    Android
    Error code: 0 - Display normally; non-0 - Unable to display, you can try to solve it by using the preloading scheme mentioned below for adapting containers.
    errorMsgstringNo
    Android
    Error message

    Callback when touch on the overlay

    bindoverlaytouch

    Android
    iOS
    Desktop
    bindoverlaytouch = (e: OverlayTouchEvent) => {};
    FieldTypeOptionalDefaultPlatformsSinceDescription
    stateOverlayTouchStateNo
    Android
    iOS
    Desktop
    Touch state
    xnumberNo
    Android
    iOS
    Desktop
    x position relative to the window, in px
    ynumberNo
    Android
    iOS
    Desktop
    y position relative to the window, in px

    Callback when touch on the overlay

    bindrequestclose

    Android
    Desktop
    Harmony
    bindrequestclose = (e: BaseEvent) => {};

    Callback when the back button is clicked.

    bindshowoverlay

    Android
    iOS
    Desktop
    Harmony
    bindshowoverlay = (e: BaseEvent) => {};

    Callback when the overlay is displayed

    Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.