README.md

jQuery DOM Cache

================

jQuery DOM Cache is a plugin for caching DOM elements and collections preventing overuse of selector lookups on persistent DOM structures.

$.cache/$.domCache: Extends jQuery to allow for caching of jQuery objects. This functionality enables faster DOM manipulation without overuse of selector lookups on *persistentDOM elements. If you have many of the same selector lookups throughout your code, this functionality will dramatically increase the performance of your web application. If a DOM node is removed from the document, the cache is updated accordingly -- reduces possibility of memory leaks / improves GC.

If you are using jQuery < 2.x, domCache is the plugin name. If you prefer to use domCache as the name, remove the conditional var "name" assigment.

Remove objects from the cache by passing an empty string selector.

Refresh the cached collection with only what exists in the current DOM.

Do NOT bind events to nodes which may be removed from the document.

NOTE: $.cache is a hidden deprecated core property of jQuery (1.x) which is being removed.

Usage

If (the jQuery Core) $.cache property is non-existent, $.cache is used. $.domCache is the method used for all versions of jQuery < 2.x.

Caching DOM Objects

$.domCache("videos",".yt,.vimeo").css({border:"1px solid blue"});
$.domCache("animImages","img.animated").hide();
$.domCache("forms","form");

Retrieving Cached Objects

$.domCache("animImages").show("slow");
$.domCache("videos").fadeOut();

Create a Local Reference

var $myForms = $.domCache("forms");
$myForms.on("submit",function(){});

Update the Collection

The refresh method lets you reset the cached object to include only the matching elements (based on the original selector) currently in the DOM.

$.domCache("videos").refresh();

Remove a Cached Object

$.domCache("forms",'');

Example

• Gist DOM Cache Example