Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

cash-dom

Package Overview
Dependencies
Maintainers
3
Versions
54
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

cash-dom

An absurdly small jQuery alternative for modern browsers.

  • 2.2.1
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
26K
increased by6.44%
Maintainers
3
Weekly downloads
 
Created
Source

Cash

An absurdly small jQuery alternative for modern browsers (IE10+)

Cash is a small library for modern browsers (IE10+) that provides jQuery-style syntax for manipulating the DOM. Utilizing modern browser features to minimize the codebase, developers can use the familiar chainable methods at a fraction of the file size. 100% feature parity with jQuery isn't a goal, but cash comes helpfully close, covering most day to day use cases.

Size Comparison

CashjQuery 3.3.1
Uncompressed28.7 KB271 KB
Minified11 KB87 KB
Minified & Gzipped4.4 KB30.3 KB

An 85% gain in size reduction. If you need a smaller file, partial builds are supported too since this project is bundled using pacco.

Partial Builds

Some alternative configuration files for pacco for generating partial builds are available here.

Let's compare the size of those partial builds (you could actually exclude individual methods and get even smaller builds):

Enabled ModulesMinifiedMinified & Gzipped
QSA1.1 KB0.6 KB
attributes2.8 KB1.2 KB
events3.5 KB1.5 KB
collection + manipulation + traversal5.3 KB1.9 KB

Usage

Get cash from CloudFlare or jsDelivr and use it like this:

<script src="https://cdnjs.cloudflare.com/ajax/libs/cash/2.1.3/cash.min.js"></script>
<script>
  $(function () {
    $('html').addClass ( 'dom-loaded' );
    $('<footer>Appended with cash</footer>').appendTo ( document.body );
  });
</script>

Cash is also available through NPM as the cash-dom package:

npm install cash-dom --save-dev

Documentation

$()

This is the main selector method for cash. It returns an actionable collection of nodes.

If a function is provided, the function will be run once the DOM is ready.

$( selector, [context] ) // => collection
$(node) // => collection
$(nodeList) // => collection
$(htmlString) // => collection
$(collection) // => self
$(function () {}) // => document ready callback

Collection Methods

These methods from the collection prototype ($.fn) are available once you create a collection with $() and are called like so:

$(element).addClass ( className ) // => collection
AttributesCollectionCSSDataDimensionsEvents
fn.addClass ()fn.add ()fn.css ()fn.data ()fn.height ()fn.off ()
fn.attr ()fn.each ()fn.removeData ()fn.innerHeight ()fn.on ()
fn.hasClass ()fn.eq ()fn.innerWidth ()fn.one ()
fn.prop ()fn.filter ()fn.outerHeight ()fn.ready ()
fn.removeAttr ()fn.first ()fn.outerWidth ()fn.trigger ()
fn.removeClass ()fn.get ()fn.width ()
fn.removeProp ()fn.index ()
fn.toggleClass ()fn.last ()
fn.map ()
fn.slice ()
FormsManipulationOffsetTraversal
fn.serialize ()fn.after ()fn.offset ()fn.children ()
fn.val ()fn.append ()fn.offsetParent ()fn.closest ()
fn.appendTo ()fn.position ()fn.find ()
fn.before ()fn.has ()
fn.clone ()fn.is ()
fn.detach ()fn.next ()
fn.empty ()fn.not ()
fn.html ()fn.parent ()
fn.insertAfter ()fn.parents ()
fn.insertBefore ()fn.prev ()
fn.prepend ()fn.siblings ()
fn.prependTo ()
fn.remove ()
fn.replaceAll ()
fn.replaceWith ()
fn.text ()
$.fn

The main prototype for collections, allowing you to extend cash with plugins by adding methods to all collections.

$.fn // => cash.prototype
$.fn.myMethod = function () {}; // Custom method added to all collections
$.fn.extend ( object ); // Add multiple methods to the prototype
fn.add ()

Returns a new collection with the element(s) added to the end.

$(element).add ( element ) // => collection
$(element).add ( selector ) // => collection
$(element).add ( collection ) // => collection
fn.addClass ()

Adds the className class to each element in the collection.

Accepts space-separated className for adding multiple classes.

$(element).addClass ( className ) // => collection
fn.after ()

Inserts content or elements after the collection.

$(element).after ( element ) // => collection
$(element).after ( htmlString ) // => collection
$(element).after ( content [, content] ) // => collection
fn.append ()

Appends content or elements to each element in the collection.

$(element).append ( element ) // => collection
$(element).append ( htmlString ) // => collection
$(element).append ( element [, element] ) // => collection
fn.appendTo ()

Adds the elements in the collection to the target element(s).

$(element).appendTo ( element ) // => collection
fn.attr ()

Without attrValue, returns the attribute value of the first element in the collection.

With attrValue, sets the attribute value of each element of the collection.

$(element).attr ( attrName ) // => AttributeValue
$(element).attr ( attrName, attrValue ) // => collection
fn.before ()

Inserts content or elements before the collection.

$(element).before ( element ) // => collection
$(element).before ( htmlString ) // => collection
$(element).before ( content [, content] ) // => collection
fn.children ()

Without a selector specified, returns a collection of child elements.

With a selector, returns child elements that match the selector.

$(element).children () // => collection
$(element).children ( selector ) // => collection
fn.closest ()

Returns the closest matching selector up the DOM tree.

$(element).closest () // => collection
$(element).closest ( selector ) // => collection
fn.clone ()

Returns a clone of the collection.

$(element).clone () // => collection
fn.detach ()

Removes collection elements from the DOM.

$(element).detach () // => collection
fn.css ()

Returns a CSS property value when just property is supplied.

Sets a CSS property when property and value are supplied.

Sets multiple properties when an object is supplied.

Properties will be autoprefixed if needed for the user's browser.

$(element).css ( property ) // => value
$(element).css ( property, value ) // => collection
$(element).css ( object ) // => collection
fn.data ()

Link some data (string, object, array, etc.) to an element when both key and value are supplied.

If only a key is supplied, returns the linked data and falls back to data attribute value if no data is already linked.

Multiple data can be set when an object is supplied.

$(element).data () // => object
$(element).data ( key ) // => value
$(element).data ( key, value ) // => collection
$(element).data ( object ) // => collection
fn.each ()

Iterates over a collection with callback ( index, element ).

$(element).each ( callback ) // => collection
fn.empty ()

Empties the elements interior markup.

$(element).empty () // => collection
fn.eq ()

Returns a collection with the element at index.

$(element).eq ( index ) // => collection
fn.extend ()

Adds properties to the cash collection prototype.

$.fn.extend(object) // => object
fn.filter ()

Returns the collection that results from applying the filter selector/method.

$(element).filter ( selector ) // => collection
$(element).filter ( function ( index, element ) {} ) // => collection
fn.find ()

Returns selector match descendants from the first element in the collection.

$(element).find ( selector ) // => collection
fn.first ()

Returns a collection containing only the first element.

$(element).first () // => collection
fn.get ()

Returns the element at the index, or returns all elements.

$(element).get ( index ) // => domNode
$(element).get () // => domNode[]
fn.has ()

Reduce the set of matched elements to those that have a descendant that matches the selector or DOM element.

$(element).has ( selector ) // => collection
$(element).has ( element ) // => collection
fn.hasClass ()

Returns the boolean result of checking if the first element in the collection has the className attribute.

$(element).hasClass ( className ) // => boolean
fn.height ()

Returns or sets the height of the element.

$(element).height () // => Integer
$(element).height ( number ) // => collection
fn.html ()

Returns the HTML text of the first element in the collection, sets the HTML if provided.

$(element).html () // => HTML Text
$(element).html ( htmlString ) // => HTML Text
fn.index ()

Returns the index of the element in its parent if an element or selector isn't provided. Returns index within element or selector if it is.

$(element).index () // => Integer
$(element).index ( element ) // => Integer
fn.innerHeight ()

Returns the height of the element + padding.

$(element).innerHeight () // => Integer
fn.innerWidth ()

Returns the width of the element + padding.

$(element).innerWidth () // => Integer
fn.insertAfter ()

Inserts collection after specified element.

$(element).insertAfter ( element ) // => collection
fn.insertBefore ()

Inserts collection before specified element.

$(element).insertBefore ( element ) // => collection
fn.is ()

Returns whether the provided selector, element or collection matches any element in the collection.

$(element).is ( selector ) // => boolean
fn.last ()

Returns a collection containing only the last element.

$(element).last () // => collection
fn.map ()

Returns a new collection, mapping each element with callback ( index, element ).

$(selector).map ( callback ) // => collection
fn.next ()

Returns next sibling.

$(element).next () // => collection
fn.not ()

Filters collection by false match on collection/selector.

$(element).not ( selector ) // => collection
$(element).not ( collection ) // => collection
fn.off ()

Removes event listener from collection elements.

Accepts space-separated eventName for removing multiple events listeners.

Removes all event listeners if called without arguments.

$(element).off ( eventName, eventHandler ) // => collection
$(element).off ( eventName ) // => collection
$(element).off () // => collection
fn.offset ()

Get the coordinates of the first element in a collection relative to the document.

$(element).offset () // => Object
fn.offsetParent ()

Get the first element's ancestor that's positioned.

$(element).offsetParent () // => collection
fn.on ()

Adds event listener to collection elements.

Accepts space-separated eventName for listening to multiple events.

Event is delegated if delegate is supplied.

$(element).on ( eventName, eventHandler ) // => collection
$(element).on ( eventName, delegate, eventHandler ) // => collection
fn.one ()

Adds event listener to collection elements that only triggers once for each element.

Accepts space-separated eventName for listening to multiple events.

Event is delegated if delegate is supplied.

$(element).one ( eventName, eventHandler ) // => collection
$(element).one ( eventName, delegate, eventHandler ) // => collection
fn.outerHeight ()

Returns the outer height of the element. Includes margins if includeMargings is set to true.

$(element).outerHeight () // => Integer
$(element).outerHeight ( includeMargins ) // => Integer
fn.outerWidth ()

Returns the outer width of the element. Includes margins if includeMargings is set to true.

$(element).outerWidth () // => Integer
$(element).outerWidth ( includeMargins ) // => Integer
fn.parent ()

Returns parent element.

$(element).parent() // => collection
fn.parents ()

Returns collection of elements who are parents of element. Optionally filtering by selector.

$(element).parents () // => collection
$(element).parents ( selector ) // => collection
fn.position ()

Get the coordinates of the first element in a collection relative to its offsetParent.

$(element).position () // => object
fn.prepend ()

Prepends content or elements to the each element in collection.

$(element).prepend ( element ) // => collection
$(element).prepend ( htmlString ) // => collection
$(element).prepend ( content [, content] ) // => collection
fn.prependTo ()

Prepends elements in a collection to the target element(s).

$(element).prependTo ( element ) // => collection
fn.prev ()

Returns the previous adjacent element.

$(element).prev () // => collection
fn.prop ()

Returns a property value when just property is supplied.

Sets a property when property and value are supplied, and sets multiple properties when an object is supplied.

$(element).prop ( property ) // => property value
$(element).prop ( property, value ) // => collection
$(element).prop ( object ) // => collection
fn.ready ()

Calls callback method on DOMContentLoaded.

$(document).ready ( callback ) // => collection/span
fn.remove ()

Removes collection elements from the DOM and removes all their event listeners.

$(element).remove () // => collection
fn.replaceAll ()

This is similar to fn.replaceWith(), but with the source and target reversed.

$(element).replaceAll ( content ) // => collection
fn.replaceWith ()

Replace collection elements with the provided new content.

$(element).replaceWith ( content ) // => collection
fn.removeAttr ()

Removes attribute from collection elements.

Accepts space-separated attrName for removing multiple attributes.

$(element).removeAttr ( attrName ) // => collection
fn.removeClass ()

Removes className from collection elements.

Accepts space-separated className for adding multiple classes.

Providing no arguments will remove all classes.

$(element).removeClass () // => collection
$(element).removeClass ( className ) // => collection
fn.removeData ()

Removes linked data and data-attributes from collection elements.

$(element).removeData ( name ) // => collection
$(element).removeData () // => collection
fn.removeProp ()

Removes property from collection elements.

$(element).removeProp ( propName ) // => collection
fn.serialize ()

When called on a form, serializes and returns form data.

$(form).serialize () // => String
fn.siblings ()

Returns a collection of sibling elements.

$(element).siblings () // => collection
fn.slice ()

Returns a new collection with elements taken from start to end.

$(selector).slice ( start, end ) // => collection
fn.text ()

Returns the inner text of the first element in the collection, sets the text if textContent is provided.

$(element).text () // => text
$(element).text ( textContent ) // => collection
fn.toggleClass ()

Adds or removes className from collection elements based on if the element already has the class.

Accepts space-separated classNames for toggling multiple classes, and an optional force boolean to ensure classes are added (true) or removed (false).

$(element).toggleClass ( className ) // => collection
$(element).toggleClass ( className, force ) // => collection
fn.trigger ()

Triggers supplied event on elements in collection. Data can be passed along as the second parameter.

$(element).trigger ( eventName ) // => collection
$(element).trigger ( eventObj ) // => collection
$(element).trigger ( eventName, data ) // => collection
$(element).trigger ( eventObj, data ) // => collection
fn.val ()

Returns an inputs value. If value is supplied, sets all inputs in collection's value to the value argument.

$(input).val () // => value
$(input).val ( value ) // => collection
fn.width ()

Returns or sets the width of the element.

$(element).width () // => number
$(element).width ( number ) // => collection

Cash Methods

These methods are exported from the global $ object, and are called like so:

$.isString ( str ) // => boolean
Type CheckingUtilities
$.isArray ()$.guid
$.isFunction ()$.camelCase ()
$.isNumeric ()$.each ()
$.isString ()$.extend ()
$.hasData ()
$.matches ()
$.parseHTML ()
$.prefixedProp ()
$.unique ()
$.guid

A unique number.

$.guid++ // => number
$.camelCase ()

Transforms a string to camelCase.

$.camelCase ( 'border-width' ) // => 'borderWidth'
$.each ()

Iterates through an array and calls the callback ( value, index, array ) method on each.

$.each ( array, callback ) // => undefined
$.extend ()

Extends target object with properties from the source object. If no target is provided, cash itself will be extended.

$.extend ( target, source ) // => object
$.hasData ()

Determine whether an element has any cash data associated with it.

$.hasData ( document.body ) // => boolean
$.isArray ()

Check if the argument is an array.

$.isArray ([ 1, 2, 3 ]) // => true
$.isFunction ()

Check if the argument is a function.

function fn () {};
$.isFunction ( fn ) // => true
$.isNumeric ()

Check if the argument is numeric.

$.isNumeric ( 57 ) // => true
$.isString ()

Check if the argument is a string.

$.isString ( 'hello' ) // => true
$.matches ()

Checks a selector against an element, returning a boolean value for match.

$.matches ( element, selector ) // => boolean
$.parseHTML ()

Returns a collection from an HTML string.

$.parseHTML ( htmlString ) // => collection
$.prefixedProp ()

Return a prefixed CSS property, if necessary.

$.prefixedProp ( 'transform' ) // => 'mozTransform'
$.unique ()

Returns a new array with duplicates removed.

$.unique ( array ) // => array

FAQs

Package last updated on 16 Jun 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc