Global

Methods

"jQuery.fn.clickFlyout"(optionsopt) → {jQuery}

jQuery plugin that creates the basic interactivity for a flyout that opens on click of trigger element
Parameters:
Name Type Attributes Description
options Object <optional>
Properties
Name Type Attributes Description
autoCollapse boolean <optional>
collapse overlay when focus exits widget (default: true)
debug boolean <optional>
print debug statements to console (default: false)
focusManagement boolean <optional>
set focus to 'none, 'overlay', 'first' or an ID (default: 'none')
overlaySelector boolean <optional>
css selector for overlay element (default: '.flyout__overlay')
triggerSelector boolean <optional>
css selector for button element (default: '.flyout__trigger')
Source:
Fires:
  • event:{object} flyoutCollapse - the flyout has collapsed
  • event:{object} flyoutExpand - the flyout has expanded
Returns:
chainable jQuery class
Type
jQuery

Events

flyoutCollapse

flyoutCollapse event
Type:
  • object
Properties:
Name Type Description
event object event object
Source:

flyoutExpand

flyoutExpand event
Type:
  • object
Properties:
Name Type Description
event object event object
Source: