core/popover_region_controller

Description:

  • Controls the popover region element.

    See template: core/popover_region

Source:
Since:
  • 3.2
Copyright:
  • 2015 Ryan Wyllie
License:
  • http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Controls the popover region element.

See template: core/popover_region

Methods

(inner) closeMenu()

Description:

  • Hide the popover.

    Note: This triggers the menuClosed event.

Source:

(inner) contentItemHasFocus() → {bool}

Description:

  • Check if a content item has focus.

Source:
Returns:
Type
bool

(inner) focusContentItem(item)

Description:

  • Focus the given content item or the first focusable element within the content item.

Source:
Parameters:
Name Type Description
item object

The content item jQuery element

(inner) focusFirstContentItem()

Description:

  • Set focus on the first content item in the list.

Source:

(inner) focusLastContentItem()

Description:

  • Set focus on the last content item in the list.

Source:

(inner) focusMenuToggle()

Description:

  • Sets the focus on the menu toggle.

Source:

(inner) focusNextContentItem()

Description:

  • Set focus on the content item after the item that currently has focus in the list.

Source:

(inner) focusPreviousContentItem()

Description:

  • Set focus on the content item preceding the item that currently has focus in the list.

Source:

(inner) getContent() → {jQuery}

Description:

  • Return the content element.

Source:
Returns:

object

Type
jQuery

(inner) getContentContainer() → {jQuery}

Description:

  • Return the container element for the content element.

Source:
Returns:

object

Type
jQuery

(inner) getContentItemWithFocus() → {jQuery}

Description:

  • Return the currently focused content item.

Source:
Returns:

object

Type
jQuery

(inner) isMenuOpen() → {bool}

Description:

  • Checks if the popover is displayed.

Source:
Returns:
Type
bool

(inner) openMenu()

Description:

  • Show the popover.

    Note: This triggers the menuOpened event.

Source:

(inner) registerBaseEventListeners()

Description:

  • Register the minimal amount of listeners for the popover to function.

Source:

(inner) registerListNavigationEventListeners()

Description:

  • Set up the event listeners for keyboard navigating a list of content items.

Source:

(inner) startLoading()

Description:

  • Set the loading state on this popover.

    Note: This triggers the startLoading event.

Source:

(inner) stopLoading()

Description:

  • Undo the loading state on this popover.

    Note: This triggers the stopLoading event.

Source:

(inner) toggleMenu()

Description:

  • Toggle the visibility of the popover.

Source:

(inner) updateButtonAriaLabel()

Description:

  • Set the appropriate aria label on the popover toggle.

Source:

(inner) updateFocusItemTabIndex()

Description:

  • Set the appropriate tabindex attribute on the popover toggle.

Source: