API Docs for: 0.0.8-0
Show:

PopupBase Class

An abstract representation of the popup definition that potentially references many Popup instances. Handl and target properties might use selectors.

Methods

_getActualHandle

(
  • [selector]
)
private

Finds and returns actual DOM nodes of popup handles, one or more. Used selector

Parameters:

  • [selector] JQuery optional

    A JQuery of the actual handle.

Returns:

result An array of one or more jQuery objects that works as popup handles

_spawnPopups

(
  • [selector]
)
#crossLink "Popup" private

Finds and returns an array of Popup objects, one or more, identified in the PopupBase.

Parameters:

  • [selector] JQuery optional

    A JQuery of the actual handle.

Returns:

#crossLink "Popup":

popups An array of one or more }{{/crossLink}} objects

close

(
  • [selector]
)

Closes all the popups described by this PopupBase instance.

Parameters:

  • [selector] JQuery optional

    A JQuery of the actual handle.

isOpen

(
  • [selector]
)

Checks if any of the popups described by this PopupBase is closed.

Parameters:

  • [selector] JQuery optional

    A JQuery of the actual handle.

Returns:

result True if any of the descripte popups are open; false otherwise

open

(
  • [selector]
)

Opens all the popups described by this PopupBase instance.

Parameters:

  • [selector] JQuery optional

    A JQuery of the actual handle.

setTargetAttr

(
  • [visible]
)

Sets the appropriate aria-* attributes to the popup nodes according to the supplied visible parameter or with the internal state of the popup.

Parameters:

  • [visible] Boolean optional

    Indicating the internal state of the popup

toggle

(
  • [selector]
)

Toggles all the popups described by this PopupBase instance.

Parameters:

  • [selector] JQuery optional

    A JQuery of the actual handle.

Properties

_attr

PopupBaseSettings private

Properties object of the PopupBase.