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.
Looking for tutorials about the widget factory? Check out the articles on the jQuery Learning Center.
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 initialized. 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"
.
Options
Because progressbar()
was called with no parameters, the widget was initialized with its default options. We can pass a set of options during initialization to override the defaults:
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.
You can pass multiple options arguments. Those arguments will be merged into one object (similar to $.extend( true, target, object1, objectN )
). This is useful for sharing options between instances, while overriding some properties for each one:
1
2
3
|
|
All options passed on init are deep-copied to ensure the objects can be modified later without affecting the widget. Arrays are the only exception, they are referenced as-is. This exception is in place to support data-binding, where the data source has to be kept as a reference.
The default values are stored on the widget's prototype, therefore we have the ability to override the values that jQuery UI sets. For example, after setting the following, all future progressbar instances will default to a value of 80:
1
|
|
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 and lowercased. 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.
Instance
The widget's instance can be retrieved from a given element using the instance()
method.
1
|
|
If the instance()
method is called on an element that is not associated with the widget, undefined
is returned.
1
|
|
The instance is stored using jQuery.data()
with the widget's full name as the key. Therefore, the :data
selector can also determine whether an element has a given widget bound to it.
1
2
|
|
Unlike instance()
, :data
can be used even if the widget being tested for has not loaded.
1
2
|
|
You can also use :data
to get a list of all elements that are instances of a given widget.
1
|
|
Properties
All widgets have the following set of properties:
-
defaultElement: An element to use when a widget instance is constructed without providing an element. For example, since the progressbar's
defaultElement
is"<div>
",$.ui.progressbar({ value: 50 })
instantiates a progressbar widget instance on a newly created<div>
. -
document: A jQuery object containing the
document
that the widget's element is within. Useful if you need to interact with widgets within iframes. -
element: A jQuery object containing the element used to instantiate the widget. If you select multiple elements and call
.myWidget()
, a separate widget instance will be created for each element. Therefore, this property will always contain one element. -
namespace: The location on the global jQuery object that the widget's prototype is stored on. For example a
namespace
of"ui"
indicates that the widget's prototype is stored on$.ui
. -
options: An object containing the options currently being used by the widget. On instantiation, any options provided by the user will automatically be merged with any default values defined in
$.myNamespace.myWidget.prototype.options
. User specified options override the defaults. - uuid: A unique integer identifier for the widget.
- version: The string version of the widget. For jQuery UI widgets this will be set to the version of jQuery UI the widget is using. Widget developers have to set this property in their prototype explicitly.
-
widgetEventPrefix: The prefix prepended to the name of events fired from this widget. For example the
widgetEventPrefix
of the draggable widget is"drag"
, therefore when a draggable is created, the name of the event fired is"dragcreate"
. By default thewidgetEventPrefix
of a widget is its name. Note: This property is deprecated and will be removed in a later release. Event names will be changed to widgetName:eventName (e.g."draggable:create"
). -
widgetFullName: The full name of the widget including the namespace. For
$.widget( "myNamespace.myWidget", {} )
,widgetFullName
will be"myNamespace-myWidget"
. -
widgetName: The name of the widget. For
$.widget( "myNamespace.myWidget", {} )
,widgetName
will be"myWidget"
. -
window: A jQuery object containing the
window
that the widget's element is within. Useful if you need to interact with widgets within iframes.
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 animation 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
,delay
,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. Ifdelay
is omitted, then no delay is 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
,delay
,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. Ifdelay
is omitted, then no delay is 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.
Set the background color of the widget's element based on an option.
1
2
3
|
|
_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. Defaults to
0
.
Call the _foo()
method on the widget after 100 milliseconds.
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.
Remove a class from the widget's element when the widget is destroyed.
1
2
3
|
|
_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.
Apply focusable styling to a set of elements within the widget.
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.
Pass the widget's options to create
event handlers as an argument.
1
2
3
|
|
_getCreateOptions()Returns: Object
- This method does not accept any arguments.
Make the widget element's id attribute available as an option.
1
2
3
|
|
_hide( element, option [, callback ] )Returns: jQuery (plugin only)
option
values.
-
elementType: jQueryThe element(s) to hide.
-
optionType: ObjectThe properties defining how to hide the element.
-
callbackType: Function()Callback to invoke after the element has been fully hidden.
Pass along the hide
option for custom animations.
1
2
3
4
5
|
|
_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.
Apply hoverable styling to all <div>
s within the element on hover.
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.
Call the open()
method if the autoOpen
option is set.
1
2
3
4
5
|
|
_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.
Unbind all click events from the widget's element.
1
|
|
_on( [suppressDisabledCheck ] [, 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. Can be overridden with thesuppressDisabledCheck
parameter. - Event handlers are automatically namespaced and cleaned up on destroy.
-
suppressDisabledCheck (default:
false
)Type: BooleanWhether or not to bypass the disabled check. -
elementType: jQueryWhich element(s) to bind the event handlers to. If no element is provided,
this.element
is used for non-delegated events and the widget element is used for delegated events. -
handlersType: ObjectAn object in which the keys represent the event type and optional selector for delegation, and the values represent a handler function to be called for the event.
Prevent the default action of all links clicked within the widget's element.
1
2
3
4
5
|
|
_setOption( key, value )Returns: jQuery (plugin only)
_setOptions()
method for each individual option. Widget state should be updated based on changes.
Update a widget's element when its height
or width
option changes.
1
2
3
4
5
6
7
8
9
|
|
_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: ObjectAn object containing options to set, with the name of the option as the key and the option value as the value.
Call a resize()
method if the height
or width
options change.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
|
_show( element, option [, callback ] )Returns: jQuery (plugin only)
option
values.
-
elementType: jQueryThe element(s) to show.
-
optionType: ObjectThe properties defining how to show the element.
-
callbackType: Function()Callback to invoke after the element has been fully shown.
Pass along the show
option for custom animations.
1
2
3
4
5
|
|
_super( [arg ] [, ... ] )Returns: jQuery (plugin only)
.call()
.
-
argType: ObjectZero to many arguments to pass to the parent widget's method.
Handle title
option updates and call the parent widget's _setOption()
to update the internal storage of the option.
1
2
3
4
5
6
|
|
_superApply( arguments )Returns: jQuery (plugin only)
.apply()
.
-
argumentsType: ArrayArray of arguments to pass to the parent method.
Handle title
option updates and call the parent widget's _setOption()
to update the internal storage of the option.
1
2
3
4
5
6
|
|
_trigger( type [, event ] [, data ] )Returns: Boolean
The option with the name equal to type is invoked as the callback.
The event name is the lowercase concatenation of the widget name and type.
Note: When providing data, you must provide all three parameters. If there is no event to pass along, just pass null
.
If the default action is prevented, false
will be returned, otherwise true
. Preventing the default action happens when the handler returns false
or calls event.preventDefault()
.
-
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.
Trigger a search
event whenever a key is pressed.
1
2
3
4
5
6
7
8
9
10
11
12
|
|
destroy()Returns: jQuery (plugin only)
- This method does not accept any arguments.
disable()Returns: jQuery (plugin only)
- This method does not accept any arguments.
enable()Returns: jQuery (plugin only)
- This method does not accept any arguments.
instance()Returns: Object
Retrieves the widget's instance object. If the element does not have an associated instance, undefined
is returned.
Unlike other widget methods, instance()
is safe to call on any element after the widget plugin has loaded.
- This method does not accept any arguments.
option( optionName )Returns: Object
Gets the value currently associated with the specified optionName
.
Note: For options that have objects as their value, you can get the value of a specific key by using dot notation. For example, "foo.bar"
would get the value of the bar
property on the foo
option.
-
optionNameType: StringThe name of the option to get.
option()Returns: PlainObject
- This signature does not accept any arguments.
option( optionName, value )Returns: jQuery (plugin only)
Sets the value of the widget option associated with the specified optionName
.
Note: For options that have objects as their value, you can set the value of just one property by using dot notation for optionName
. For example, "foo.bar"
would update only the bar
property of the foo
option.
option( options )Returns: jQuery (plugin only)
-
optionsType: ObjectA map of option-value pairs to set.
widget()Returns: jQuery
jQuery
object containing the original element or other relevant generated element.
- This method does not accept any arguments.
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
|
|