back to Overview

.onClick()

Registers a function to be called for 'click' events.
Web module only.

Syntax Variants

list.onClick(handler)
list.onClick(customFunc, args)
list.onClick(selector, handler)
list.onClick(selector, customFunc, args)

Parameters

selector (optional)
a selector string for $() to register the event only on those children of the list elements that match the selector. Supports all valid parameters for $() except functions.
eventHandler
the callback function(event, index) to invoke when the event has been triggered:
event
The original DOM event object.
index
The index of the target object in the Minified list .
this
A Minified list containing the target element as only item (same element as event.target).
customFunc
a function to be called instead of a regular event handler with the arguments given in args. 'this' will be a Minified list containing the target element as only item (same element as event.target).
args (optional)
an array of arguments to pass to the custom callback function instead of the event objects. If omitted, the function is called as event handler with the event object as argument.
bubbleSelector (optional)
a selector string for $() to receive only events that bubbled up from an element that matches this selector. Supports all valid parameters for $() except functions. Analog to is(), the selector is optimized for the simple patterns '.classname', 'tagname' and 'tagname.classname'.
(return value)
the list

Description

Registers a function to be called for 'click' events. This is only a convenience method and identical to calling on() with 'click' as event type. You can specify a sub-selector to register only for specific children of the list elements, and you can specify arguments to pass to the handler instead of the default event object.

Event handlers registered using onClick() can be unregistered using $.off().

Example

Says hello if you click:

$('#sayHello').onClick(function() { window.alert('Hello!'); });

Example

Using arguments:

function saySomething(what) { window.alert(what); }

$('#sayHello').onClick(saySomething, ['Hello!']);
$('#sayBye').onClick(saySomething, ['Goodbye!']);

Example

Creates an event handler that toggles the color of the text on click:

$('#changeColor').onClick($('#colorChanger').toggle({$color:'#000'}, {$color:'#f00'}, 100));

See also..

  • on() provides low-level event registration.
  • off() can unregister onClick event handlers.

Comments

comments powered by Disqus

back to Overview

Functions