The NodeList class provides a wrapper for manipulating DOM NodeLists. NodeList properties can be accessed via the set/get methods. Use Y.all() to retrieve NodeList instances.
addClassclassName
Adds a class name to each node.
className
String
the class name to add to each node's class attribute
aftertype
fn
context
Applies an event listener to each Node bound to the NodeList. The handler is called only after all on() handlers are called and the event is not prevented.
A subscription handle capable of detaching that subscription
appendCalled on each Node instance
appendChildCalled on each Node instance
clearDataname
Clears data on all Node instances bound to the NodeList.
name
String
The name of the field to clear. If no name is given, all data is cleared.
concatvalueN
A new NodeList comprised of this NodeList joined with the input.
destroyrecursivePurge
Called on each Node instance. Nulls internal node references, removes any plugins and event listeners
recursivePurge
Boolean
(optional) Whether or not to remove listeners from the node's subtree (default is false)
detachCalled on each Node instance
detachAlleachfn
context
Applies the given function to each Node in the NodeList.
emptyCalled on each Node instance. Removes and destroys all of the nodes within the node
evenCreates a new NodeList containing all nodes at even indices (zero-based index), including zero.
NodeList containing the updated collection
filterselector
Filters the NodeList instance down to only nodes matching the given selector.
selector
String
The selector to filter against
NodeList containing the updated collection
generateIDApplies a unique ID to each node if none exists
The existing or generated ID
getgetAttributename
Allows getting attributes on DOM nodes, normalizing in some cases. This passes through to the DOM node, allowing for custom attributes.
name
String
The attribute name
The attribute value
getAttributename
Allows getting attributes on DOM nodes, normalizing in some cases. This passes through to the DOM node, allowing for custom attributes.
name
String
The attribute name
The attribute value
getComputedStyleattr
Returns an array of the computed value for each node. Use camelCase (e.g. 'backgroundColor') for multi-word properties.
attr
String
The style attribute to retrieve.
The computed values for each node.
getDataname
Retrieves arbitrary data stored on each Node instance bound to the NodeList.
name
String
Optional name of the data field to retrieve. If no name is given, all data is returned.
An array containing all of the data for each Node instance. or an object hash of all fields.
getDOMNodesnodelist
Retrieves the DOM nodes bound to a NodeList instance
nodelist
NodeList
The NodeList instance
The array of DOM nodes bound to the NodeList
getHTMLCalled on each Node instance
getStyleattr
Returns an array of values for each node. Use camelCase (e.g. 'backgroundColor') for multi-word properties.
attr
String
The style attribute to retrieve.
The current values of the style property for the element.
hasClassclassName
Determines whether each node has the given className.
className
String
the class name to search for
An array of booleans for each node bound to the NodeList.
hidename
config
callback
Hides each node. If the "transition" module is loaded, hide optionally animates the hiding of the node using either the default transition effect ('fadeOut'), or the given named effect.
indexOfnode
Returns the index of the node in the NodeList instance or -1 if the node isn't found.
node
Node | HTMLElement
the node to search for
the index of the node value or -1 if not found
insertCalled on each Node instance
insertBeforeCalled on each Node instance
isEmptyDetermines if the instance is bound to any nodes
Whether or not the NodeList is bound to any nodes
itemindex
Retrieves the Node instance at the given index.
index
Number
The index of the target Node.
The Node instance at the given index.
modulusn
r
Creates a new NodeList containing all nodes at every n indices, where remainder n % index equals r. (zero-based index).
NodeList containing the updated collection
oddCreates a new NodeList containing all nodes at odd indices (zero-based index).
NodeList containing the updated collection
ontype
fn
[context]
[arg*]
Subscribe a callback function for each Node in the collection to execute
in response to a DOM event.
NOTE: Generally, the on() method should be avoided on NodeLists, in
favor of using event delegation from a parent Node. See the Event user
guide for details.
Most DOM events are associated with a preventable default behavior, such as
link clicks navigating to a new page. Callbacks are passed a
DOMEventFacade object as their first argument (usually called e) that
can be used to prevent this default behavior with e.preventDefault(). See
the DOMEventFacade API for all available properties and methods on the
object.
By default, the this object will be the NodeList that the subscription
came from, not the Node that received the event. Use
e.currentTarget to refer to the Node.
Returning false from a callback is supported as an alternative to calling
e.preventDefault(); e.stopPropagation();. However, it is recommended to
use the event methods.
A subscription handle capable of detaching that subscription
Y.all(".sku").on("keydown", function (e) {
if (e.keyCode === 13) {
e.preventDefault();
// Use e.currentTarget to refer to the individual Node
var item = Y.MyApp.searchInventory( e.currentTarget.get('value') );
// etc ...
}
});oncetype
fn
context
Applies an one-time event listener to each Node bound to the NodeList.
A subscription handle capable of detaching that subscription
onceAftertype
fn
context
Applies an one-time event listener to each Node bound to the NodeList that will be called only after all on() handlers are called and the event is not prevented.
A subscription handle capable of detaching that subscription
plugP
config
Adds a plugin to each node in the NodeList. This will instantiate the plugin and attach it to the configured namespace on each node
P
Function | Object | Array
Accepts the plugin class, or an object with a "fn" property specifying the plugin class and a "cfg" property specifying the configuration for the Plugin.
Additionally an Array can also be passed in, with the above function or object values, allowing the user to add multiple plugins in a single call.
config
Object
(Optional) If the first argument is the plugin class, the second argument can be the configuration for the plugin.
popThe last item in the NodeList, or null if the list is empty.
prependCalled on each Node instance
pushnodes
nodes
Node | HTMLElement
One or more nodes to add to the end of the NodeList.
refreshReruns the initial query, when created using a selector query
removedestroy
Called on each Node instance. Removes the node from its parent. Shortcut for myNode.get('parentNode').removeChild(myNode);
destroy
Boolean
whether or not to call destroy() on the node after removal.
removeAttributename
Allows for removing attributes on DOM nodes. This passes through to the DOM node, allowing for custom attributes.
name
String
The attribute to remove
removeClassclassName
Removes a class name from each node.
className
String
the class name to remove from each node's class attribute
replaceClassoldClassName
newClassName
Replace a class with another class for each node. If no oldClassName is present, the newClassName is simply added.
setattr
val
Called on each Node instance. Sets an attribute on the Node instance. Unless pre-configured (via Node.ATTRS), set hands off to the underlying DOM node. Only valid attributes/properties for the node will be set. To set custom attributes use setAttribute.
attr
String
The attribute to be set.
val
Any
The value to set the attribute to.
setAttributename
value
Allows setting attributes on DOM nodes, normalizing in some cases. This passes through to the DOM node, allowing for custom attributes.
setAttributename
value
Allows setting attributes on DOM nodes, normalizing in some cases. This passes through to the DOM node, allowing for custom attributes.
setDataname
val
Stores arbitrary data on each Node instance bound to the NodeList. This is not stored with the DOM node.
name
String
The name of the field to set. If no name is given, name is treated as the data and overrides any existing data.
val
Any
The value to be assigned to the field.
setHTMLCalled on each Node instance
Note that this passes to innerHTML and is not escaped.
Use Y.Escape.html()
to escape html content or set('text') to add as text.
setStyleattr
val
Sets a style property on each node. Use camelCase (e.g. 'backgroundColor') for multi-word properties.
setStyleshash
Sets multiple style properties on each node. Use camelCase (e.g. 'backgroundColor') for multi-word properties.
hash
Object
An object literal of property:value pairs.
shiftThe first item in the NodeList, or null if the NodeList is empty.
showname
config
callback
Makes each node visible. If the "transition" module is loaded, show optionally animates the showing of the node using either the default transition effect ('fadeIn'), or the given named effect.
sizeReturns the current number of items in the NodeList.
The number of items in the NodeList.
slicebegin
end
begin
Number
Zero-based index at which to begin extraction. As a negative index, start indicates an offset from the end of the sequence. slice(-2) extracts the second-to-last element and the last element in the sequence.
end
Number
Zero-based index at which to end extraction. slice extracts up to but not including end. slice(1,4) extracts the second element through the fourth element (elements indexed 1, 2, and 3). As a negative index, end indicates an offset from the end of the sequence. slice(2,-1) extracts the third element through the second-to-last element in the sequence. If end is omitted, slice extracts to the end of the sequence.
A new NodeList comprised of this NodeList joined with the input.
somefn
context
Executes the function once for each node until a true value is returned.
Whether or not the function returned true for any node.
spliceindex
howMany
index
Number
Index at which to start changing the array. If negative, will begin that many elements from the end.
howMany
Number
An integer indicating the number of old array elements to remove. If howMany is 0, no elements are removed. In this case, you should specify at least one new element. If no howMany parameter is specified (second syntax above, which is a SpiderMonkey extension), all elements after index are removed. {Node | HTMLElement| element1, ..., elementN The elements to add to the array. If you don't specify any elements, splice simply removes elements from the array.
The element(s) removed.
toFragCreates a documenFragment from the nodes bound to the NodeList instance
a Node instance bound to the documentFragment
toggleClassclassName
For each node, if the className exists on the node it is removed, if it doesn't exist it is added.
className
String
the class name to be toggled
toggleView[on]
[callback]
Displays or hides each node. If the "transition" module is loaded, toggleView optionally animates the toggling of the nodes using given named effect.
transitionconfig
callback
callbackOnce
Animate one or more css properties to a given value. Requires the "transition" module.
example usage:
Y.all('.demo').transition({
duration: 1, // in seconds, default is 0.5
easing: 'ease-out', // default is 'ease'
delay: '1', // delay start for 1 second, default is 0
height: '10px',
width: '10px',
opacity: { // per property
value: 0,
duration: 2,
delay: 2,
easing: 'ease-in'
}
});
config
Object
An object containing one or more style properties, a duration and an easing.
callback
Function
A function to run after the transition has completed. The callback fires once per item in the NodeList.
callbackOnce
Boolean
If true, the callback will be called only after the last transition has completed
unplugplugin
Removes a plugin from all nodes in the NodeList. This will destroy the plugin instance and delete the namespace each node.
unwrapRemoves the parent node from node in the list.
wraphtml
Wraps the given HTML around each node.
html
String
The markup to wrap around the node.
_nodesThe underlying array of DOM nodes bound to the Y.NodeList instance