.one( events [, data ], handler )Returns: jQuery
Description: Attach a handler to an event for the elements. The handler is executed at most once per element per event type.
-
version added: 1.1.one( events [, data ], handler )
- eventsType: StringA string containing one or more JavaScript event types, such as "click" or "submit," or custom event names.
- dataType: PlainObjectAn object containing data that will be passed to the event handler.
- handlerA function to execute at the time the event is triggered.
-
-
version added: 1.7.one( events [, selector ] [, data ], handler )
- eventsType: StringOne or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".
- selectorType: StringA selector string to filter the descendants of the selected elements that trigger the event. If the selector is
null
or omitted, the event is always triggered when it reaches the selected element. - dataType: AnythingData to be passed to the handler in
event.data
when an event is triggered. - handlerA function to execute when the event is triggered. The value
false
is also allowed as a shorthand for a function that simply doesreturn false
.
-
-
version added: 1.7.one( events [, selector ] [, data ] )
- eventsType: PlainObjectAn object in which the string keys represent one or more space-separated event types and optional namespaces, and the values represent a handler function to be called for the event(s).
- selectorType: StringA selector string to filter the descendants of the selected elements that will call the handler. If the selector is null or omitted, the handler is always called when it reaches the selected element.
- dataType: AnythingData to be passed to the handler in
event.data
when an event occurs.
-
The .one()
method is identical to .on()
, except that the handler for a given element and event type is unbound after its first invocation. For example:
$( "#foo" ).one( "click", function() { alert( "This will be displayed only once." ); });
After the code is executed, a click on the element with ID foo
will display the alert. Subsequent clicks will do nothing. This code is equivalent to:
$( "#foo" ).on( "click", function( event ) { alert( "This will be displayed only once." ); $( this ).off( event ); });
In other words, explicitly calling .off()
from within a regularly-bound handler has exactly the same effect.
If the first argument contains more than one space-separated event types, the event handler is called once for each event type.
$( "#foo" ).one( "click mouseover", function( event ) { alert( "The " + event.type + " event happened!" ); });
In the example above the alert could be displayed twice due to the two event types (click
and mouseover
).
Examples:
Tie a one-time click to each div.
<!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <title>one demo</title> <style> div { width: 60px; height: 60px; margin: 5px; float: left; background: green; border: 10px outset; cursor:pointer; } p { color: red; margin: 0; clear: left; } </style> <script src="https://code.jquery.com/jquery-1.10.2.js"></script> </head> <body> <div></div> <div></div> <div></div> <div></div> <div></div> <p>Click a green square...</p> <script> var n = 0; $( "div" ).one( "click", function() { var index = $( "div" ).index( this ); $( this ).css({ borderStyle: "inset", cursor: "auto" }); $( "p" ).text( "Div at index #" + index + " clicked." + " That's " + (++n) + " total clicks." ); }); </script> </body> </html>
Demo:
To display the text of all paragraphs in an alert box the first time each of them is clicked:
$( "p" ).one( "click", function() { alert( $( this ).text() ); });
Event handlers will trigger once per element per event type
<!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <title>one demo</title> <script src="https://code.jquery.com/jquery-1.10.2.js"></script> </head> <body> <div class="count">0</div> <div class="target">Hover/click me</div> <script> var n = 0; $(".target").one("click mouseenter", function() { $(".count").html(++n); }); </script> </body> </html>