Documentation generator: JsDoc Toolkit 2.3.2
Template: Codeview 1.3
Generated on:

Class jQuery.fn

jQuery Library (www.jquery.com)

Class Summary
Constructor Attributes Constructor Name and Description
 
jQuery functions namespace.

Method Summary

Method Attributes Method Name and Description
<static>  
jQuery.fn.onoPager(arg_config, animationConfig)
Creates a widget that enables the user to navigate through a list ofelements (like an <ul>).
<static>  
jQuery.fn.onoPagerSwipe(arg_config)
Handles swipe events on mobile phones and desktops.

Class Detail

jQuery.fn()
jQuery functions namespace.

Method Detail

  • <static> {jQuery} jQuery.fn.onoPager(arg_config, animationConfig)
    Creates a widget that enables the user to navigate through a list ofelements (like an <ul>). It provides different types ofpaging navigation. These are called animation objects and reside in theonoPager.animation namespace.
    The onoPager library consist of many types of animations like "slides","linear" and "linearScroller". The onoPager is built in such a way thatit's easy to add your own animation objects without having to rewrite thebasic paging functionality.
    Check out some configuration examples.
    // Simple example:// More examples on: http://www.thebrightlines.com/onopager/website/jQuery('#list1').onoPager({  cssClass: 'onoPager_greyscale',  pagePerItem: true,  doesLoop: false,  listContainer: {    width: '280px',    height: ''  },  listItems: {    width: '260px',    height: '80px'  },  status: {    active: false  },  pageByArrowKey: {    active: true,    preventDefault: false  },  pageByNumber: {    hideThreshold: 1  },  swipeTriggersPage: true,  animationType: 'linear',  animationEasing: 'easeOutCubic',  orientation: 'horizontal',  animationSpeed: 1000});
    Parameters:
    {Object} arg_config
    Configuration object.
    {Object} animationConfig
    Optional extra configuration object for the animation object.
    {String} arg_config.cssClass
    Ads CSS class to the root of the pager.
    {Boolean} arg_config.pagePerItem
    If true, each page will be as long as one list item. If false, each page will be as long as the list container, which may span multiple list items.
    {Boolean} arg_config.lockDuringTransition
    Disable paging controls during a transition when true. Default is false.
    {Boolean} arg_config.doesLoop
    If true, the pager scrolls back to the first item after the last item.
    {String} arg_config.listContainer.width
    Width of list container, like '200px'.
    {String} arg_config.listContainer.height
    Height of list container, like '200px'.
    {String} arg_config.listContainer.maxHeight
    Maximum height of list container, like '200px'. The maximum height will also be applied to all list Items.
    {Boolean} arg_config.listContainer.adjustHeightToListItem.active
    If you also set pagePerItem to true, the height of the list container will adjust to the height of the visible list item. Default value is true.
    {Boolean} arg_config.listContainer.adjustHeightToListItem.animate
    If true, the container will animatie to its new height. Default value is true.
    {String} arg_config.ListItems.width
    Width of list items, like '200px'.
    {String} arg_config.ListItems.height
    Height of list items, like '200px'.
    {Number} arg_config.activeIndex
    Sets initial visible page. By default the pager starts at index 0.
    {Boolean} arg_config.autoPage.active
    Activates auto pager.
    {Number} arg_config.autoPage.interval
    The interval between autopaging. Time value is set in milliseconds.
    {Boolean} arg_config.autoPage.active
    Activates auto pager.
    {String} arg_config.autoPage.autoPageAnimationType
    The type of animation that will indicate the time the time between transitions.
    {Object} arg_config.autoPage.extraConfig
    A configuration object for the autopage indicator.
    {Boolean} arg_config.autoPage.pauseOnHover
    Stops the pager when the mouse cursor hovers above the pager.
    {String} arg_config.labels.next
    text for the 'next'-button.
    {String} arg_config.labels.previous
    Text for the 'previous'-button.
    {Boolean} arg_config.status.active
    Activates the status box.
    {String} arg_config.status.prependText
    Text that appears before the page index number.
    {String} arg_config.status.seperationText
    Text that appears between the page index number and the total pages number.
    {String} arg_config.status.appendText
    Text that appears after the total pages number.
    {Boolean} arg_config.scroller.active
    Activates a Javascript scrollbar. Default is true.
    {Number} arg_config.pixelMove
    The amount of pixels the pager scrolls after each frame.
    {Boolean} arg_config.pageByNumber.active
    Activates the bar with all pages, defined by number. Default is true.
    {Boolean} arg_config.pageByNumber.enableClick
    Disables paging behaviour onclick. The makes the 'Page by number'-box essentially a status box rather than a navigation control. Default is true.
    {Array} arg_config.pageByNumber.labels
    Replaces the default content of the page-by-number links with the string values in the array.
    {Number} arg_config.pageByNumber.hideThreshold
    Defines how many links may appear in the pageByNumber box. If you set the value to 2, you'll see 2 links on the left and 2 on the right of the active item. A negative value cancels this functionality. Default value is -1.
    {Array} arg_config.pageByNumber.links
    Overrides the default click behavior of the page-by-number links. If you supply an array of URL's, they will behave like standard links that point to an URL.
    {Boolean} arg_config.pageByNumber.enableHover
    Initiates a page when the mouse is hovered over a page by number item.
    {Boolean} arg_config.pageByArrowKey.active
    Enables paging by using the keyboard arrow keys. Default is false.
    {Boolean} arg_config.pageByArrowKey.preventDefault
    Disables or activates the default behaviour of the arrow key. If set to true, the user won't be able to scroll the page or a textarea with the arrow keys. Default is false for that reason.
    {Boolean} arg_config.swipeTriggersPage
    Activates page navigation by swiping on the screen. Default is true.
    {String} arg_config.swipePlatforms
    Determines on what platforms the user is able to page by swiping. 'touch' activates swiping only on touch devices. 'all' will activates swiping on touch devices and desktop. Swiping on the desktop is done with mouse gestures. Default value is 'touch'.
    {String} arg_config.animationType
    Determines which animation object will be used. The following animation types are available by default: 'linear', 'linearScroller' and 'slides'. Custom animation objects can be created and used after the plugin is loaded. Default value is 'linear'.
    {String} arg_config.animationEasing
    Determines the easing type to be used by the animation object. Default value is 'linear'. If 'easeOutCubic' is available, it will use that as default value.
    {String} arg_config.orientation
    Determines on what axis the animation moves. Possible values are 'horizontal' and 'vertical' though it's possible to use other values as long as the animation object supports that value. Default value is 'horizontal'.
    {Number} arg_config.animationSpeed
    Determines the speed at which the animations take place.

    Returns:
    {jQuery} chainable jQuery class.
  • <static> {Object} jQuery.fn.onoPagerSwipe(arg_config)
    Handles swipe events on mobile phones and desktops. The code is based onthe QuickGestures jQuery plugin of Anders Zakrisson.
    Defined in: jquery.onopagerswipe.js.
    Parameters:
    {Object|Null} arg_config
    Swipe config.
    {Function} arg_config.dragLeft
    Handles drag left event.
    {Function} arg_config.dragRight
    Handles drag right event.
    {Function} arg_config.dragUp
    Handles drag up event.
    {Function} arg_config.dragDown
    Handles drag down event.
    {Number} arg_config.threshold
    Number of pixels that have to be dragged before something is considered a swipe.
    {String} arg_config.platform
    Determines on what platforms the user is able to page by swiping. 'touch' activates swiping only on touch devices. 'all' will activates swiping on touch devices and desktop. Swiping on the desktop is done with mouse gestures. Default value is 'touch'.

    Returns:
    {Object} chainable jQuery class.