Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace MouseLeave

It's common that popup2 triggered from an existing popup1, later when mouse moved to popup2, popup1 should disappear because mouse leaves. This is not correct, so we implemented a mouse popup stack and keep parent visible when child still having mouse inside.

Caution: never forget to unregister mouse leave binding before elements disconnected.

Index

Functions

Functions

inUse

  • inUse(el: Element): boolean
  • Check if element or any of it's ancestors was kept to be visible. If element is not kept, you can destroy or reuse it immediately. It also allows el equals to controller element.

    Parameters

    • el: Element

      Element to check.

    Returns boolean

keep

  • keep(els: Element | Element[]): () => void
  • Make sure elements and all their ancestors can't trigger mouse leave callback and becomes invisible. Normally used for contextmenu to keep parent popup visible.

    Parameters

    • els: Element | Element[]

      Array of elements to keep.

    Returns () => void

      • (): void
      • Returns void

on

  • on(els: Element | Element[], callback: () => void, options?: MouseLeaveOptions): () => void
  • Call callback after mouse leaves all of the elements for ms milliseconds. It's very usefull to handle mouse hover event in menu & submenu.

    Parameters

    • els: Element | Element[]

      Single element or element array to capture leaves at.

    • callback: () => void

      The callback to call after mouse leaves all the elements.

        • (): void
        • Returns void

    • Optional options: MouseLeaveOptions

      Leave control options.

    Returns () => void

      • (): void
      • Returns void

once

  • once(els: Element | Element[], callback: () => void, options?: MouseLeaveOptions): () => void
  • Call callback after mouse leaves all of the elements for ms milliseconds, only trigger callback for once. It's very usefull to handle mouse event in menu & submenu.

    Parameters

    • els: Element | Element[]

      els Single element or element array to capture leaves at.

    • callback: () => void

      The callback to call after mouse leaves all the elements.

        • (): void
        • Returns void

    • Optional options: MouseLeaveOptions

      Leave control options.

    Returns () => void

      • (): void
      • Returns void

Generated using TypeDoc