core/popover_region_controller

Controls the popover region element.

See template: core/popover_region

Source:

lib/amd/src/popover_region_controller.js, line 16

Since:

Copyright:

2015 Ryan Wyllie

License:

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Methods

(inner) closeMenu()

Source:

lib/amd/src/popover_region_controller.js, line 115

Hide the popover.

Note: This triggers the menuClosed event.

(inner) contentItemHasFocus() → {bool}

Source:

lib/amd/src/popover_region_controller.js, line 213

Check if a content item has focus.

Returns:

Type: bool

(inner) focusContentItem(item)

Source:

lib/amd/src/popover_region_controller.js, line 241

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

Parameters:

Name	Type	Description
`item`	object	The content item jQuery element

(inner) focusFirstContentItem()

Source:

lib/amd/src/popover_region_controller.js, line 256

Set focus on the first content item in the list.

(inner) focusLastContentItem()

Source:

lib/amd/src/popover_region_controller.js, line 265

Set focus on the last content item in the list.

(inner) focusMenuToggle()

Source:

lib/amd/src/popover_region_controller.js, line 204

Sets the focus on the menu toggle.

(inner) focusNextContentItem()

Source:

lib/amd/src/popover_region_controller.js, line 274

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

(inner) focusPreviousContentItem()

Source:

lib/amd/src/popover_region_controller.js, line 288

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

(inner) getContent() → {jQuery}

Source:

lib/amd/src/popover_region_controller.js, line 82

Return the content element.

Returns:

object

Type: jQuery

(inner) getContentContainer() → {jQuery}

Source:

lib/amd/src/popover_region_controller.js, line 72

Return the container element for the content element.

Returns:

object

Type: jQuery

(inner) getContentItemWithFocus() → {jQuery}

Source:

lib/amd/src/popover_region_controller.js, line 223

Return the currently focused content item.

Returns:

object

Type: jQuery

(inner) isMenuOpen() → {bool}

Source:

lib/amd/src/popover_region_controller.js, line 92

Checks if the popover is displayed.

Returns:

Type: bool

(inner) openMenu()

Source:

lib/amd/src/popover_region_controller.js, line 135

Show the popover.

Note: This triggers the menuOpened event.

(inner) registerBaseEventListeners()

Source:

lib/amd/src/popover_region_controller.js, line 302

(inner) registerListNavigationEventListeners()

Source:

lib/amd/src/popover_region_controller.js, line 340

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

(inner) startLoading()

Source:

lib/amd/src/popover_region_controller.js, line 176

Set the loading state on this popover.

Note: This triggers the startLoading event.

(inner) stopLoading()

Source:

lib/amd/src/popover_region_controller.js, line 190

Undo the loading state on this popover.

Note: This triggers the stopLoading event.

(inner) toggleMenu()

Source:

lib/amd/src/popover_region_controller.js, line 102

Toggle the visibility of the popover.

(inner) updateButtonAriaLabel()

Source:

lib/amd/src/popover_region_controller.js, line 159

Set the appropriate aria label on the popover toggle.