Contents:
jQuery.widget( name [, base ], prototype )
Description: Create stateful jQuery plugins using the same abstraction as all jQuery UI widgets.
-
jQuery.widget( name [, base ], prototype )
-
nameType: StringThe name of the widget to create, including the namespace.
-
baseType: Function()The base widget to inherit from. This must be a constructor that can be instantiated with the `new` keyword. Defaults to
jQuery.Widget
. -
prototypeType: PlainObjectThe object to use as a prototype for the widget.
-
You can create new widgets from scratch, using just the $.Widget
object as a base to inherit from, or you can explicitly inherit from existing jQuery UI or third-party widgets. Defining a widget with the same name as you inherit from even allows you to extend widgets in place.
jQuery UI contains many widgets that maintain state and therefore have a slightly different usage pattern than typical jQuery plugins. All of jQuery UI's widgets use the same patterns, which is defined by the widget factory. So if you learn how to use one widget, then you'll know how to use all of them.
Note: This documentation shows examples using the progressbar widget but the syntax is the same for every widget.
Initialization
In order to track the state of the widget, we must introduce a full life cycle for the widget. The life cycle starts when the widget is initalized. To initialize a widget, we simply call the plugin on one or more elements.
1
|
|
This will initialize each element in the jQuery object, in this case the element with an id of "elem"
. Because we called the progressbar()
method with no parameters, the widget is initialized with its default options. We can pass a set of options during initialization in order to override the default options.
1
|
|
We can pass as many or as few options as we want during initialization. Any options that we don't pass will just use their default values.
The options are part of the widget's state, so we can set options after initialization as well. We'll see this later with the option method.
Methods
Now that the widget is initialized, we can query its state or perform actions on the widget. All actions after initialization take the form of a method call. To call a method on a widget, we pass the name of the method to the jQuery plugin. For example, to call the value()
method on our progressbar widget, we would use:
1
|
|
If the method accepts parameters, we can pass them after the method name. For example, to pass the parameter 40
to the value()
method, we can use:
1
|
|
Just like other methods in jQuery, most widget methods return the jQuery object for chaining.
1
2
3
|
|
Each widget will have its own set of methods based on the functionality that the widget provides. However, there are a few methods that exist on all widgets, which are documented below.
Events
All widgets have events associated with their various behaviors to notify you when the state is changing. For most widgets, when the events are triggered, the names are prefixed with the widget name. For example, we can bind to progressbar's change
event which is triggered whenever the value changes.
1
2
3
|
|
Each event has a corresponding callback, which is exposed as an option. We can hook into progressbar's change
callback instead of binding to the progressbarchange
event, if we want to.
1
2
3
4
5
|
|
All widgets have a create
event which is triggered upon instantiation.
Base Widget
Description: The base widget used by the widget factory.
Options
disabled
false
true
.Initialize the widget with the disabled
option specified:
1
2
3
|
|
Get or set the disabled
option, after initialization:
1
2
3
4
5
|
|
hide
null
-
Boolean:
When set to
false
, no animation will be used and the element will be hidden immediately. When set totrue
, the element will fade out with the default duration and the default easing. - Number: The element will fade out with the specified duration and the default easing.
-
String:
The element will be hidden using the specified effect.
The value can either be the name of a built-in jQuery animateion method, such as
"slideUp"
, or the name of a jQuery UI effect, such as"fold"
. In either case the effect will be used with the default duration and the default easing. -
Object: If the value is an object, then
effect
,duration
, andeasing
properties may be provided. If theeffect
property contains the name of a jQuery method, then that method will be used; otherwise it is assumed to be the name of a jQuery UI effect. When using a jQuery UI effect that supports additional settings, you may include those settings in the object and they will be passed to the effect. Ifduration
oreasing
is omitted, then the default values will be used. Ifeffect
is omitted, then"fadeOut"
will be used.
Initialize the widget with the hide
option specified:
1
2
3
|
|
Get or set the hide
option, after initialization:
1
2
3
4
5
|
|
show
null
-
Boolean:
When set to
false
, no animation will be used and the element will be shown immediately. When set totrue
, the element will fade in with the default duration and the default easing. - Number: The element will fade in with the specified duration and the default easing.
-
String:
The element will be shown using the specified effect.
The value can either be the name of a built-in jQuery animation method, such as
"slideDown"
, or the name of a jQuery UI effect, such as"fold"
. In either case the effect will be used with the default duration and the default easing. -
Object: If the value is an object, then
effect
,duration
, andeasing
properties may be provided. If theeffect
property contains the name of a jQuery method, then that method will be used; otherwise it is assumed to be the name of a jQuery UI effect. When using a jQuery UI effect that supports additional settings, you may include those settings in the object and they will be passed to the effect. Ifduration
oreasing
is omitted, then the default values will be used. Ifeffect
is omitted, then"fadeIn"
will be used.
Initialize the widget with the show
option specified:
1
2
3
|
|
Get or set the show
option, after initialization:
1
2
3
4
5
|
|
Methods
_create()Returns: jQuery (plugin only)
_create()
method is the widget's constructor.
There are no parameters, but this.element
and this.options
are already set.
- This method does not accept any arguments.
Invoke the _create method:
1
|
|
_delay( fn [, delay ] )Returns: Number
this
context correct. Essentially setTimeout()
.
Returns the timeout ID for use with clearTimeout()
.
-
fnThe function to invoke. Can also be the name of a method on the widget.
-
delayType: NumberThe number of milliseconds to wait before invoking the function. Deafults to
0
.
Invoke the _delay method:
1
|
|
_destroy()Returns: jQuery (plugin only)
destroy()
method cleans up all common data, events, etc. and then delegates out to _destroy()
for custom, widget-specific, cleanup.
- This method does not accept any arguments.
Invoke the _destroy method:
1
|
|
_focusable( element )Returns: jQuery (plugin only)
element
to apply the ui-state-focus
class on focus.
The event handlers are automatically cleaned up on destroy.
-
elementType: jQueryThe element(s) to apply the focusable behavior to.
Invoke the _focusable method:
1
|
|
_getCreateEventData()Returns: Object
create
event. By default, no data is provided in the event, but this method can return an object which will be passed as the create
event's data.
- This method does not accept any arguments.
Invoke the _getCreateEventData method:
1
|
|
_getCreateOptions()Returns: Object
- This method does not accept any arguments.
Invoke the _getCreateOptions method:
1
|
|
_hide( element, option [, callback ] )Returns: jQuery (plugin only)
option
values.
-
elementType: jQueryThe element(s) to hide.
-
optionType: ObjectThe settings defining how to hide the element.
-
callbackType: Function()Callback to invoke after the element has been fully hidden.
Invoke the _hide method:
1
|
|
_hoverable( element )Returns: jQuery (plugin only)
element
to apply the ui-state-hover
class on hover.
The event handlers are automatically cleaned up on destroy.
-
elementType: jQueryThe element(s) to apply the hoverable behavior to.
Invoke the _hoverable method:
1
|
|
_init()Returns: jQuery (plugin only)
Note: Initialization should only be handled if there is a logical action to perform on successive calls to the widget with no arguments.
- This method does not accept any arguments.
Invoke the _init method:
1
|
|
_off( element, eventName )Returns: jQuery (plugin only)
-
elementType: jQueryThe element(s) to unbind the event handlers from. Unlike the
_on()
method, the elements are required for_off()
. -
eventNameType: StringOne or more space-separated event types.
Invoke the _off method:
1
|
|
_on( [element ], handlers )Returns: jQuery (plugin only)
click .foo
". The _on()
method provides several benefits of direct event binding:
- Maintains proper
this
context inside the handlers. - Automatically handles disabled widgets: If the widget is disabled or the event occurs on an element with the
ui-state-disabled
class, the event handler is not invoked. - Event handlers are automatically namespaced and cleaned up on destroy.
-
elementType: jQueryWhich element(s) to bind the event handlers to. If no element is provided,
this.element
is used. -
handlersType: ObjectA map in which the string keys represent the event type and optional selector for delegation, and the values represent a handler function to be called for the event.
Invoke the _on method:
1
|
|
_setOption( key, value )Returns: jQuery (plugin only)
_setOptions()
method for each individual option. Widget state should be updated based on changes.
Invoke the _setOption method:
1
|
|
_setOptions( options )Returns: jQuery (plugin only)
option()
method is called, regardless of the form in which the option()
method was called.
Overriding this is useful if you can defer processor-intensive changes for multiple option changes.
-
optionsType: ObjectA map of option-value pairs to set.
Invoke the _setOptions method:
1
|
|
_show( element, option [, callback ] )Returns: jQuery (plugin only)
option
values.
-
elementType: jQueryThe element(s) to show.
-
optionType: ObjectThe settings defining how to show the element.
-
callbackType: Function()Callback to invoke after the element has been fully shown.
Invoke the _show method:
1
|
|
_super()Returns: jQuery (plugin only)
.call()
.
- This method does not accept any arguments.
Invoke the _super method:
1
|
|
_superApply( arguments )Returns: jQuery (plugin only)
.apply()
.
-
argumentsType: ArrayArray of arguments to pass to the parent method.
Invoke the _superApply method:
1
|
|
_trigger( type [, event ] [, data ] )Returns: jQuery (plugin only)
The option with the name equal to type is invoked as the callback.
The event name is the widget name + type.
Note: When providing data, you must provide all three parameters. If there is no event to pass along, just pass null
.
-
typeType: StringThe
type
should match the name of a callback option. The full event type will be generated automatically. -
eventType: EventThe original event that caused this event to occur; useful for providing context to the listener.
-
dataType: ObjectA hash of data associated with the event.
Invoke the _trigger method:
1
|
|
destroy()Returns: jQuery (plugin only)
- This method does not accept any arguments.
Invoke the destroy method:
1
|
|
disable()Returns: jQuery (plugin only)
- This method does not accept any arguments.
Invoke the disable method:
1
|
|
enable()Returns: jQuery (plugin only)
- This method does not accept any arguments.
Invoke the enable method:
1
|
|
option( optionName )Returns: Object
optionName
.-
optionNameType: StringThe name of the option to get.
Invoke the method:
1
|
|
option()Returns: PlainObject
- This signature does not accept any arguments.
Invoke the method:
1
|
|
option( optionName, value )Returns: jQuery (plugin only)
optionName
.-
optionNameType: StringThe name of the option to set.
-
valueType: ObjectA value to set for the option.
Invoke the method:
1
|
|
option( options )Returns: jQuery (plugin only)
-
optionsType: ObjectA map of option-value pairs to set.
Invoke the method:
1
|
|
widget()Returns: jQuery
jQuery
object containing the original element or other relevant generated element.
- This method does not accept any arguments.
Invoke the widget method:
1
|
|
Events
create( event, ui )Type: widgetcreate
Note: The ui
object is empty but included for consistency with other events.
Initialize the widget with the create callback specified:
1
2
3
|
|
Bind an event listener to the widgetcreate event:
1
|
|