Praman — Agent-First SAP UI5 Test Automation Plugin - v1.3.5
    Preparing search index...

    Class OverlayHandler

    Registers and tracks SAP overlay interruption handlers for one page.

    Handlers registered through page.addLocatorHandler() live for the lifetime of the page, so a handler must be disposed at the end of the test that registered it. dispose does that.

    ui5Overlays.register

    const overlays = new OverlayHandler({ page });
    await overlays.register({ name: 'tour', selector: '.tourPopover' });
    // ... test body ...
    await overlays.dispose();
    Index
    constructor
    detections
    dispose register registerAll
    • get detections(): readonly OverlayDetection[]

      Every overlay interruption recorded so far, in the order they occurred.

      Returns readonly OverlayDetection[]

      if (overlays.detections.length > 0) {
        logger.warn(`${overlays.detections.length} overlays interrupted this test`);
      }

    • Unregisters every rule this handler registered.

      Returns Promise<void>

      Safe to call on a closed page — removal failures are logged and swallowed, because teardown must never mask the test's own result.

      ui5Overlays.dispose

      await overlays.dispose();

    • Registers one overlay rule with Playwright.

      Parameters

      Returns Promise<void>

      PramanError with ERR_CONFIG_INVALID when the rule name is already registered.

      ui5Overlays.register

      await overlays.register({ name: 'cookie-consent', selector: '#cookieBar' });

    • Registers several overlay rules.

      Parameters

      • rules: readonly OverlayRule[]

        The overlay rules to register.

      Returns Promise<void>

      ui5Overlays.registerAll

      await overlays.registerAll(BUILT_IN_OVERLAY_RULES);

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors
    Methods