jsdoc

$.ui.simplicityFlyout

Namespace $.ui.simplicityFlyout

Flyout UI effect. A flyout widget that can open and close.

Automatically applies the bgiframe plugin to the element if available.
Defined in: ui.simplicityFlyout.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
<static>  
$.ui.simplicityFlyout.options
Widget options.
Method Summary
Method Attributes Method Name and Description
<static>  
$.ui.simplicityFlyout.close()
Closes the flyout, does nothing it it is already closed.
<static>  
$.ui.simplicityFlyout.isOpen()
Returns true if the flyout is currently open, false otherwise.
<static>  
$.ui.simplicityFlyout.open()
Opens the flyout, does nothing it it is already open.
<static>  
$.ui.simplicityFlyout.toggle()
Toggles the open/close state of this flyout.
Namespace Detail
$.ui.simplicityFlyout
  <div id="flyout">
    <ul>
      <li>one</li>
      <li>two</li>
      <li>three</li>
    </ul>
  <div>
  <button id="toggle">Toggle</button>
  <script type="text/javascript">
    $('#flyout').simplicityFlyout({
      // All of these options are optional
      effect: 'slide',
      effectOptions: {
        duration: 1000
      },
      position: {
        my: 'left top',
        at: 'right top',
        of: '#toggle',
        collision: 'none'
      }
    });
    $('#toggle').click(function () {
      $('#flyout').simplicityFlyout('toggle');
    });
  </script>
Field Detail
<static> $.ui.simplicityFlyout.options
Widget options.
effect
The jQuery UI effect to use when hiding or showing the flyout. Must be one compatible with show/hide/toggle (see http://docs.jquery.com/UI/Effects). Possible options are blind, clip, drop, explode, fade, fold, puff, slide and scale. Defaults to 'show'.
effectOptions
Optional options for the configured effect. If set to '' then no special options are passed in, otherwise it should be an object containing effect options. Defaults to ''
position
Optional positioning options. If set to '' then no positioning is performed, otherwise it should be an object containing options for the jQuery UI position plugin (see http://jqueryui.com/demos/position/).
css
Optional css overrides. If set to '' then no overrides are performed, otherwise it should be an object containing css that is valid for calls to $.css (see http://api.jquery.com/css/). Defaults to ''
hiddenAccessible
Boolean option to enable or disable ui-helper-hidden-accessible support. When enabled the flyout has this class applied to it and is made visible before positioning. Defaults to true
closeSelector
Selector that click events are bound to to close the flyout. Defaults to '.flyout-close'.
Method Detail
<static> $.ui.simplicityFlyout.close()
Closes the flyout, does nothing it it is already closed.

<static> $.ui.simplicityFlyout.isOpen()
Returns true if the flyout is currently open, false otherwise.

<static> $.ui.simplicityFlyout.open()
Opens the flyout, does nothing it it is already open.

<static> $.ui.simplicityFlyout.toggle()
Toggles the open/close state of this flyout.

Documentation generated by JsDoc Toolkit 2.4.0