Skip to content

Latest commit

 

History

History
83 lines (64 loc) · 3.2 KB

README.md

File metadata and controls

83 lines (64 loc) · 3.2 KB
Raw

qr-manipulation

Dependencies devDependencies npm License Code Quality: Javascript Total Alerts

Extension for Query Result to add jQuery-type manipulation functionality.

In very early stages...

manipulation export signature

  • manipulation($ [, jml]) - $ is the query-result instance, while the second (optional) argument is a Jamilih instance that will be used for adding a jml method.

Methods

These methods may be obtained individually (though see the notes for appendTo, prependTo, insertBefore, and insertAfter which require insertTo in such a situation), or one may use manipulation which makes available all methods automatically.

  • append(content [, content])

  • append(function-html)

  • prepend(content [, content])

  • prepend(function-html)

  • after(content [, content])

  • after(function-html)

  • before(content [, content])

  • before(function-html)

  • html(content)

  • html(function-html)

  • text(content)

  • text(function-html)

  • clone() - Does not support optional withDataAndEvents and deepWithDataAndEvents arguments

  • empty()

  • remove()

  • remove(selector) - The selector currently uses Element.matches instead of QueryResult

  • attr(attributeName)

  • attr(attributes)

  • attr(attributeName, value)

  • attr(attributeName, function)

  • removeAttr(attributeName)

  • hasClass(className)

  • addClass(className)

  • addClass(function)

  • removeClass([className])

  • removeClass(function)

  • toggleClass(className)

  • toggleClass(className, state)

  • toggleClass(function [, state])

For the following methods, because they allow selectors, and so we can avoid a mutual dependency with query-result (or use document.querySelectorAll which doesn't have all of the latter's features), are not available directly as exports.

You should, if you are not using manipulation (which adds all methods automatically) instead import insertTo and invoke it as insertTo(method, queryResultInstance), e.g., insertTo('appendTo', $); in order to get that particular method for manual use of $.extend:

  • appendTo(target)

  • prependTo(target)

  • insertAfter(target)

  • insertBefore(target)

There is also an jml method if a jml instance is supplied as the second argument to manipulation. This will expect an array to be used as part of building a Jamilih document fragment. After converting from Jamilih, it will empty and then append the contents.