.off()

jQuery

previous page next page

.off()

Categories: Events > Event Handler Attachment

.off( events [, selector ] [, handler(eventObject) ] ) Returns: jQuery

Description: Remove an event handler.

  • version added: 1.7.off( events [, selector ] [, handler(eventObject) ] )

    • events
      Type: String
      One or more space-separated event types and optional namespaces, or just namespaces, such as "click", "keydown.myPlugin", or ".myPlugin".
    • selector
      Type: String
      A selector which should match the one originally passed to .on() when attaching event handlers.
    • handler(eventObject)
      Type: Function()
      A handler function previously attached for the event(s), or the special value false.

  • version added: 1.7.off( events [, selector ] )

    • events
      Type: PlainObject
      An object where the string keys represent one or more space-separated event types and optional namespaces, and the values represent handler functions previously attached for the event(s).
    • selector
      Type: String
      A selector which should match the one originally passed to .on() when attaching event handlers.

The off() method removes event handlers that were attached with .on(). See the discussion of delegated and directly bound events on that page for more information. Specific event handlers can be removed on elements by providing combinations of event names, namespaces, selectors, or handler function names. When multiple filtering arguments are given, all of the arguments provided must match for the event handler to be removed.

If a simple event name such as "click" is provided, all events of that type (both direct and delegated) are removed from the elements in the jQuery set. When writing code that will be used as a plugin, or simply when working with a large code base, best practice is to attach and remove events using namespaces so that the code will not inadvertently remove event handlers attached by other code. All events of all types in a specific namespace can be removed from an element by providing just a namespace, such as ".myPlugin". At minimum, either a namespace or event name must be provided.

To remove specific delegated event handlers, provide a selector argument. The selector string must exactly match the one passed to .on() when the event handler was attached. To remove all delegated events from an element without removing non-delegated events, use the special value "**".

A handler can also be removed by specifying the function name in the handler argument. When jQuery attaches an event handler, it assigns a unique id to the handler function. Handlers proxied by jQuery.proxy() or a similar mechanism will all have the same unique id (the proxy function), so passing proxied handlers to .off may remove more handlers than intended. In those situations it is better to attach and remove event handlers using namespaces.

As with .on(), you can pass events as an object instead of specifying an events string and handler function as separate arguments. The keys for the events object are events and/or namespaces; the values are handler functions or the special value false.

Examples:

Example: Add and remove event handlers on the colored button.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
                                  

                                    

                                      
                                        <!DOCTYPE html>
                                      
                                    

                                  

                                  

                                    

                                      
                                        <html>
                                      
                                    

                                  

                                  

                                    

                                      
                                        <head>
                                      
                                    

                                  

                                  

                                    

                                        <style>
                                    

                                  

                                  

                                    

                                      button { margin:5px; }
                                    

                                  

                                  

                                    

                                      button#theone { color:red; background:yellow; }
                                    

                                  

                                  

                                    

                                      
                                        </style>
                                      
                                    

                                  

                                  

                                    

                                        <script src="http://code.jquery.com/jquery-latest.js"></script>
                                    

                                  

                                  

                                    

                                      
                                        </head>
                                      
                                    

                                  

                                  

                                    

                                      
                                        <body>
                                      
                                    

                                  

                                  

                                    

                                        <button id="theone">Does nothing...</button>
                                    

                                  

                                  

                                    

                                      <button id="bind">Add Click</button>
                                    

                                  

                                  

                                    

                                      <button id="unbind">Remove Click</button>
                                    

                                  

                                  

                                    

                                      <div style="display:none;">Click!</div>
                                    

                                  

                                  

                                    

                                      
                                        <script>
                                        
                                      
                                    

                                  

                                  

                                    

                                      
                                        function aClick() {
                                      
                                    

                                  

                                  

                                    

                                        $("div").show().fadeOut("slow");
                                    

                                  

                                  

                                    

                                      }
                                    

                                  

                                  

                                    

                                      $("#bind").click(function () {
                                    

                                  

                                  

                                    

                                        $("body").on("click", "#theone", aClick)
                                    

                                  

                                  

                                    

                                          .find("#theone").text("Can Click!");
                                    

                                  

                                  

                                    

                                      });
                                    

                                  

                                  

                                    

                                      $("#unbind").click(function () {
                                    

                                  

                                  

                                    

                                        $("body").off("click", "#theone", aClick)
                                    

                                  

                                  

                                    

                                          .find("#theone").text("Does nothing...");
                                    

                                  

                                  

                                    

                                      });
                                    

                                  

                                  

                                    

                                      
                                        </script>
                                      
                                    

                                  

                                  

                                    

                                       
                                    

                                  

                                  

                                    

                                      
                                        </body>
                                      
                                    

                                  

                                  

                                    

                                      
                                        </html>

Example: Remove all event handlers from all paragraphs:

1
 
                                  

                                    

                                      $("p").off()

Example: Remove all delegated click handlers from all paragraphs:

1
 
                                  

                                    

                                      $("p").off( "click", "**" )

Example: Remove just one previously bound handler by passing it as the third argument:

1
2
3
4
5
6
7
8
9
 
                                  

                                    

                                      var foo = function () {
                                    

                                  

                                  

                                    

                                        // code to handle some kind of event
                                    

                                  

                                  

                                    

                                      };
                                    

                                  

                                  

                                    

                                       
                                    

                                  

                                  

                                    

                                      
                                        // ... now foo will be called when paragraphs are clicked ...
                                      
                                    

                                  

                                  

                                    

                                      $("body").on("click", "p", foo);
                                    

                                  

                                  

                                    

                                       
                                    

                                  

                                  

                                    

                                      
                                        // ... foo will no longer be called.
                                      
                                    

                                  

                                  

                                    

                                      $("body").off("click", "p", foo);

Example: Unbind all delegated event handlers by their namespace:

1
2
3
4
5
6
7
8
9
10
11
12
 
                                  

                                    

                                      var validate = function () {
                                    

                                  

                                  

                                    

                                        // code to validate form entries
                                    

                                  

                                  

                                    

                                      };
                                    

                                  

                                  

                                    

                                       
                                    

                                  

                                  

                                    

                                      
                                        // delegate events under the ".validator" namespace
                                      
                                    

                                  

                                  

                                    

                                      $("form").on("click.validator", "button", validate);
                                    

                                  

                                  

                                    

                                       
                                    

                                  

                                  

                                    

                                      $("form").on("keypress.validator", "input[type='text']", validate);
                                    

                                  

                                  

                                    

                                       
                                    

                                  

                                  

                                    

                                      
                                        // remove event handlers in the ".validator" namespace
                                      
                                    

                                  

                                  

                                    

                                       
                                    

                                  

                                  

                                    

                                      $("form").off(".validator");
 POWERED BYHERONOTE
previous page start next page