Reusable Accessible Mapping Platform

API Docs for: 2.0.0
Show:

Popup Class

Defined in: src\js\RAMP\Utils\popupManager.js:296
Module: Utils

A concrete instance of popup referencing actual DOM nodes as its handle and target.

Methods

_performAction

(
  • action
  • cssAction
  • callback
)
private

Defined in src\js\RAMP\Utils\popupManager.js:439

Performs actions like closing and opening on this Popup.

Parameters:

  • action Function

    Open or close action on this Popup

  • cssAction Function

    Function setting style properties on this Popup

  • callback Function

    The callback to be executed

close

()

Defined in src\js\RAMP\Utils\popupManager.js:405

Closes this Popup.

isOpen

() Boolean

Defined in src\js\RAMP\Utils\popupManager.js:376

Checks if this Popup is open.

Returns:

Boolean:

True if open, false otherwise

open

()

Defined in src\js\RAMP\Utils\popupManager.js:386

Opens this Popup.

setTargetAttr

(
  • [visible]
)

Defined in src\js\RAMP\Utils\popupManager.js:473

Sets the appropriate aria-* attributes to this 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

(
  • [state]
)

Defined in src\js\RAMP\Utils\popupManager.js:424

Toggles this Popup.

Parameters:

  • [state] Boolean optional

    Indicates if the popup should be toggled on or off. true - open; false - close;

Properties

_isAnimating

Boolean private

Defined in src\js\RAMP\Utils\popupManager.js:303

Indicates if the Popup target is being animated.

activeClass

String

Defined in src\js\RAMP\Utils\popupManager.js:331

The CSS class to be applied to the handle of the popup when the popup opens.

Default: null

closeHandler

Function

Defined in src\js\RAMP\Utils\popupManager.js:322

The function to execute when the popup closes.

Default: null

handle

JQuery

Defined in src\js\RAMP\Utils\popupManager.js:358

An actual JQuery of the handle's DOM node.

Default: null

openHandler

Function

Defined in src\js\RAMP\Utils\popupManager.js:313

The function to execute when the popup opens.

Default: null

setClassBefore

String

Defined in src\js\RAMP\Utils\popupManager.js:340

Indicates whether activeClass should be applied before openHandler function completes or after.

Default: null

target

JQuery

Defined in src\js\RAMP\Utils\popupManager.js:367

An actual JQuery of the targets's DOM node.

Default: null

useAria

Boolean

Defined in src\js\RAMP\Utils\popupManager.js:349

Indicates whether to apply aria-* attributes to DOM nodes.

Default: true