Categories

.progressbar()

Categories: UI

.progressbar( [ options ] )

Plugin: jQuery.ui.progressbar

Description: Apply the Progressbar widget for each element in the set of matched elements

  • .progressbar( [ options ] )

    version added: 1.0

    options   A map of additional options pass to the widget.

The progress bar is designed to simply display the current % complete for a process. The bar is coded to be flexibly sized through CSS and will scale to fit inside it's parent container by default.

This is a determinate progress bar, meaning that it should only be used in situations where the system can accurately update the current status complete. A determinate progress bar should never fill from left to right, then loop back to empty for a single process -- if the actual percent complete status cannot be calculated, an indeterminate progress bar (coming soon) or spinner animation is a better way to provide user feedback.

  • disabled

    Disables (true) or enables (false) the progressbar. Can be set when initialising (first creating) the progressbar.

    Default: false

  • value

    The value of the progressbar.

  • create

    This event is triggered when progressbar is created.

  • change

    This event is triggered when the value of the progressbar changes.

  • complete

    This event is triggered when the value of the progressbar reaches the maximum value of 100.

  • destroy

    • .progressbar( "destroy" )

      version added: 1.0

    Remove the progressbar functionality completely. This will return the element back to its pre-init state.

  • disable

    • .progressbar( "disable" )

      version added: 1.0

    Disable the progressbar.

  • enable

    • .progressbar( "enable" )

      version added: 1.0

    Enable the progressbar.

  • option

    • .progressbar( "option" , optionName , [value] )

      version added: 1.0

    Get or set any progressbar option. If no value is specified, will act as a getter.

  • option

    • .progressbar( "option" , options )

      version added: 1.0

    Set multiple progressbar options at once by providing an options object.

  • widget

    • .progressbar( "widget" )

      version added: 1.0

    Returns the .ui-progressbar element.

  • value

    • .progressbar( "value" , [value] )

      version added: 1.0

    This method gets or sets the current value of the progressbar.