frostquery v1.0.3

fQuery

fQuery is a free, open-source DOM manipulation library for JavaScript.

It is a tiny (~2kb gzipped), OOP-style wrapper for FrostDOM, heavily inspired by jQuery.

Table Of Contents

• Installation
• Queries
• Animation
  • Animations
  • Queue
• Attributes
  • Custom Data
  • Position
  • Scroll
  • Size
  • Styles
• Events
  • Event Handlers
• Manipulation
  • Create
  • Move
  • Wrap
• Traversal
  • Filter
  • Find
• Utility
  • Selection
  • Tests

Installation

Dependencies

• FrostCore
• FrostDOM

<script type="text/javascript" src="/path/to/frost-core.min.js"></script>
<script type="text/javascript" src="/path/to/frost-dom.min.js"></script>
<script type="text/javascript" src="/path/to/fquery.min.js"></script>

Alternatively, the bundled version of FrostDOM includes all 3 libraries in a single JS file.

<script type="text/javascript" src="/path/to/frost-dom-bundle.min.js"></script>

Using NPM

npm i frostquery

In Node.js:

const { JSDOM } = require('jsdom');
const { window } = new JSDOM('');
window.Core = require('frostcore');
const { dom } = require('frostdom')(window);
require('frostquery')(window);

Queries

• selector is a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, Document, Window, NodeList, HTMLCollection, QuerySet, an array of nodes or a function to execute when the DOM is ready.
• context is a query selector string, a HTMLElement, DocumentFragment, ShadowRoot, Document, HTMLCollection, QuerySet or an array of nodes, and will default to the Document context of the dom.

The QuerySetImmutable object returned provides all the methods listed below, and unless an explicit value is returned, all methods will return the current QuerySetImmutable object (allowing method chaining).

const query = dom.query(selector, context);

Query One

You can also query for a single node using the queryOne method.

• selector is a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, Document, Window, NodeList, HTMLCollection, QuerySet, or an array of nodes.
• context is a query selector string, a HTMLElement, DocumentFragment, ShadowRoot, Document, HTMLCollection, QuerySet or an array of nodes, and will default to the Document context of the dom.

const query = dom.queryOne(selector, context);

Query Mutable

By default, the result returned is a QuerySetImmutable but you can return a mutable QuerySet using the queryMutable method.

• selector is a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, Document, Window, NodeList, HTMLCollection, QuerySet, an array of nodes or a function to execute when the DOM is ready.
• context is a query selector string, a HTMLElement, DocumentFragment, ShadowRoot, Document, HTMLCollection, QuerySet or an array of nodes, and will default to the Document context of the dom.

const query = dom.queryMutable(selector, context);

You can also query for a single node using the queryOneMutable method.

const query = dom.queryOneMutable(selector, context);

Query Binding

You can also bind the query method to any variable you wish, for a more jQuery-like experience.

const $ = dom.query.bind(dom);

Animation

Animate

Add an animation to the queue for each node.

• callback is a function that accepts node, progress and options as arguments, where node is a HTMLElement, progress is a value between 0 and 1 and options is the options object passed to this method.
• options is an object containing properties to define how the animation should be handled.
  • duration is the number of milliseconds that the animation should last, and will default to 1000.
  • type is a string of either ease-in, ease-out, ease-in-out or linear indicating the type of animation to run, and will default to ease-in-out.
  • infinite is a boolean indicating whether the animation should continue forever, and will default to false.

query.animate(callback, options);

Stop Animations

Stop all animations and clear the queue of each node.

• finish is a boolean indicating whether to immediately finish the animation, and will default to true.

query.stop(finish);

Animations

Drop In

Add a drop in animation to the queue for each node.

• options is an object containing properties to define how the animation should be handled.
  • direction is a string or function that returns either "top", "right", "bottom" or "left" indicating the direction to drop from, and will default to "top".
  • duration is the number of milliseconds that the animation should last, and will default to 1000.
  • type is a string of either "ease-in", "ease-out", "ease-in-out" or "linear" indicating the type of animation to run, and will default to "ease-in-out".
  • infinite is a boolean indicating whether the animation should continue forever, and will default to false.
  • useGpu is a boolean indicating whether the animation should use GPU acceleration (CSS transform) and will default to true.

query.dropIn(options);

Drop Out

Add a drop out animation to the queue for each node.

• options is an object containing properties to define how the animation should be handled.
  • direction is a string or function that returns either "top", "right", "bottom" or "left" indicating the direction to drop from, and will default to "top".
  • duration is the number of milliseconds that the animation should last, and will default to 1000.
  • type is a string of either "ease-in", "ease-out", "ease-in-out" or "linear" indicating the type of animation to run, and will default to "ease-in-out".
  • infinite is a boolean indicating whether the animation should continue forever, and will default to false.
  • useGpu is a boolean indicating whether the animation should use GPU acceleration (CSS transform) and will default to true.

query.dropOut(options);

Fade In

Add a fade in animation to the queue for each node.

• options is an object containing properties to define how the animation should be handled.
  • duration is the number of milliseconds that the animation should last, and will default to 1000.
  • type is a string of either "ease-in", "ease-out", "ease-in-out" or "linear" indicating the type of animation to run, and will default to "ease-in-out".
  • infinite is a boolean indicating whether the animation should continue forever, and will default to false.

query.fadeIn(options);

Fade Out

Add a fade out animation to the queue for each node.

• options is an object containing properties to define how the animation should be handled.
  • duration is the number of milliseconds that the animation should last, and will default to 1000.
  • type is a string of either "ease-in", "ease-out", "ease-in-out" or "linear" indicating the type of animation to run, and will default to "ease-in-out".
  • infinite is a boolean indicating whether the animation should continue forever, and will default to false.

query.fadeOut(options);

Rotate In

Add a rotate in animation to the queue for each node.

• options is an object containing properties to define how the animation should be handled.
  • x is the amount of rotation to apply to the X axis, and will default to 0.
  • y is the amount of rotation to apply to the Y axis, and will default to 1.
  • z is the amount of rotation to apply to the Z axis, and will default to 0.
  • inverse is a boolean indicating whether to rotate in the opposite direction, and will default to false.
  • duration is the number of milliseconds that the animation should last, and will default to 1000.
  • type is a string of either "ease-in", "ease-out", "ease-in-out" or "linear" indicating the type of animation to run, and will default to "ease-in-out".
  • infinite is a boolean indicating whether the animation should continue forever, and will default to false.

query.rotateIn(options);

Rotate Out

Add a rotate out animation to the queue for each node.

• options is an object containing properties to define how the animation should be handled.
  • x is the amount of rotation to apply to the X axis, and will default to 0.
  • y is the amount of rotation to apply to the Y axis, and will default to 1.
  • z is the amount of rotation to apply to the Z axis, and will default to 0.
  • inverse is a boolean indicating whether to rotate in the opposite direction, and will default to false.
  • duration is the number of milliseconds that the animation should last, and will default to 1000.
  • type is a string of either "ease-in", "ease-out", "ease-in-out" or "linear" indicating the type of animation to run, and will default to "ease-in-out".
  • infinite is a boolean indicating whether the animation should continue forever, and will default to false.

query.rotateOut(options);

Slide In

Add a slide in animation to the queue for each node.

• options is an object containing properties to define how the animation should be handled.
  • direction is a string or function that returns either "top", "right", "bottom" or "left" indicating the direction to drop from, and will default to "top".
  • duration is the number of milliseconds that the animation should last, and will default to 1000.
  • type is a string of either "ease-in", "ease-out", "ease-in-out" or "linear" indicating the type of animation to run, and will default to "ease-in-out".
  • infinite is a boolean indicating whether the animation should continue forever, and will default to false.
  • useGpu is a boolean indicating whether the animation should use GPU acceleration (CSS transform) and will default to true.

query.slideIn(options);

Slide Out

Add a slide out animation to the queue for each node.

• options is an object containing properties to define how the animation should be handled.
  • direction is a string or function that returns either "top", "right", "bottom" or "left" indicating the direction to drop from, and will default to "top".
  • duration is the number of milliseconds that the animation should last, and will default to 1000.
  • type is a string of either "ease-in", "ease-out", "ease-in-out" or "linear" indicating the type of animation to run, and will default to "ease-in-out".
  • infinite is a boolean indicating whether the animation should continue forever, and will default to false.
  • useGpu is a boolean indicating whether the animation should use GPU acceleration (CSS transform) and will default to true.

query.slideOut(options);

Squeeze In

Add a squeeze in animation to the queue for each node.

• options is an object containing properties to define how the animation should be handled.
  • direction is a string or function that returns either "top", "right", "bottom" or "left" indicating the direction to drop from, and will default to "top".
  • duration is the number of milliseconds that the animation should last, and will default to 1000.
  • type is a string of either "ease-in", "ease-out", "ease-in-out" or "linear" indicating the type of animation to run, and will default to "ease-in-out".
  • infinite is a boolean indicating whether the animation should continue forever, and will default to false.
  • useGpu is a boolean indicating whether the animation should use GPU acceleration (CSS transform) and will default to true.

query.squeezeIn(options);

Squeeze Out

Add a squeeze out animation to the queue for each node.

• options is an object containing properties to define how the animation should be handled.
  • direction is a string or function that returns either "top", "right", "bottom" or "left" indicating the direction to drop from, and will default to "top".
  • duration is the number of milliseconds that the animation should last, and will default to 1000.
  • type is a string of either "ease-in", "ease-out", "ease-in-out" or "linear" indicating the type of animation to run, and will default to "ease-in-out".
  • infinite is a boolean indicating whether the animation should continue forever, and will default to false.
  • useGpu is a boolean indicating whether the animation should use GPU acceleration (CSS transform) and will default to true.

query.squeezeOut(options);

Queue

Clear Queue

Clear the queue of each node.

query.clearQueue();

Delay

Delay execution of subsequent items in the queue.

• duration is the number of milliseconds to delay execution by.

query.delay(duration);

Queue

Queue a callback on each node.

• callback is a function that accepts node as an argument, where node is a HTMLElement. The callback can return a Promise which will pause the queue until the promise is resolved.

query.queue(callback);

If an item in the queue returns a Promise that rejects, the queue will be cleared.

Attributes

Get Attribute

Get an attribute value for the first node.

• attribute is a string indicating the attribute value to return.

const value = query.getAttribute(attribute);

If the attribute argument is omitted, an object containing all attribute values will be returned instead.

const attributes = query.getAttribute();

Get Dataset

Get a dataset value for the first node.

• key is a string indicating the dataset value to return.

const value = query.getDataset(key);

If the key argument is omitted, an object containing all dataset values will be returned instead.

const dataset = query.getDataset();

This method will attempt to convert string values to JS primitives (including booleans, numbers, objects, arrays and null).

Get HTML

Get the HTML contents of the first node.

const html = query.getHTML();

Get Property

Get a property value for the first node.

• property is a string indicating the property value to return.

const value = query.getProperty(property);

Get Text

Get the text contents of the first node.

const text = query.getText();

Get Value

Get the value property of the first node.

const value = query.getValue();

Remove Attribute

Remove an attribute from each node.

• attribute is a string indicating the attribute value to remove.

query.removeAttribute(attribute);

Remove Dataset

Remove a dataset value from each node.

• key is a string indicating the dataset value to remove.

query.removeDataset(key);

Remove Property

Remove a property from each node.

• property is a string indicating the property value to remove.

query.removeProperty(property);

Set Attribute

Set attributes for each node.

• attribute is a string indicating the attribute value to set.
• value is the value you want to set the attribute to.

query.setAttribute(attribute, value);

Alternatively, you can set multiple attributes by passing a single attributes object as the argument with key/value pairs of the attributes to set.

query.setAttribute(attributes);

Set Dataset

Set dataset values for each node.

• key is a string indicating the dataset value to set.
• value is the value you want to set the dataset to.

query.setDataset(key, value);

Alternatively, you can set multiple dataset properties by passing a single dataset object as the argument with key/value pairs of the properties to set.

query.setDataset(dataset);

This method will convert object and array values to JSON strings.

Set HTML

Set the HTML contents for each node.

• html is a string that will become the HTML contents of the node.

query.setHTML(html);

Set Property

Set property values for each node.

• property is a string indicating the property value to set.
• value is the value you want to set the property to.

query.setProperty(property, value);

Alternatively, you can set multiple properties by passing a single properties object as the argument with key/value pairs of the properties to set.

query.setProperty(properties);

Set Text

Set the text contents for each node.

• text is a string that will become the text contents of the node.

query.setText(text);

Set Value

Set the value property for each node.

• value is a string that will become the value of the node.

query.setValue(value);

Custom Data

Clone Data

Clone custom data from each node to each other node.

• others is a query selector string, a HTMLElement, DocumentFragment, ShadowRoot, Document, Window, NodeList, HTMLCollection, QuerySet or an array of nodes.

query.cloneData(others);

Get Data

Get custom data for the first node.

• key is a string indicating the custom data value to return.

const value = query.getData(key);

If the key argument is omitted, an object containing all custom data values will be returned instead.

const data = query.getData();

Remove Data

Remove custom data for each node.

• key is a string indicating the custom data value to remove.

query.removeData(key);

Set Data

Set custom data for each node.

• key is a string indicating the custom data value to set.
• value is the value you want to set the attribute to.

query.setData(key, value);

Alternatively, you can set multiple data values by passing a single data object as the argument with key/value pairs of the data to set.

query.setData(data);

Position

Center

Get the X,Y co-ordinates for the center of the first node.

• offset is a boolean indicating whether the co-ordinates should be offset from the top left of the document, and will default to false.

const center = query.center(offset);

Constrain

Constrain each node to a container node.

• container is a query selector string, a HTMLElement, NodeList, HTMLCollection, QuerySet or an array of nodes.

query.constrain(container);

Distance To

Get the distance of the first node to an X,Y position.

• x is a distance (in pixels) along the X axis.
• y is a distance (in pixels) along the Y axis.
• offset is a boolean indicating whether the co-ordinates should be offset from the top left of the document, and will default to false.

const dist = query.distTo(x, y, offset);

Distance To Node

Get the distance between two nodes.

• others is a query selector string, a HTMLElement, NodeList, HTMLCollection, QuerySet or an array of nodes.

const dist = query.distToNode(others);

Nearest To

Get the nearest node to an X,Y position.

• x is a distance (in pixels) along the X axis.
• y is a distance (in pixels) along the Y axis.
• offset is a boolean indicating whether the co-ordinates should be offset from the top left of the document, and will default to false.

const nearest = query.nearestTo(x, y, offset);

This method always returns a new QuerySet containing the nearest node.

Nearest To Node

Get the nearest node to another node.

• others is a query selector string, a HTMLElement, NodeList, HTMLCollection, QuerySet or an array of nodes.

const nearest = query.nearestToNode(others);

This method always returns a new QuerySet containing the nearest node.

Percent X

Get the percentage of an X co-ordinate relative to the first node.

• x is a distance (in pixels) along the X axis.
• offset is a boolean indicating whether the co-ordinates should be offset from the top left of the document, and will default to false.
• clamp is a boolean indicating whether to clamp the percent betwen 0 and 100, and will default to true.

const percentX = query.percentX(x, offset, clamp);

Percent Y

Get the percentage of a Y co-ordinate relative to the first node.

• y is a distance (in pixels) along the Y axis.
• offset is a boolean indicating whether the co-ordinates should be offset from the top left of the document, and will default to false.
• clamp is a boolean indicating whether to clamp the percent betwen 0 and 100, and will default to true.

const percentY = query.percentY(y, offset, clamp);

Position

Get the X,Y position for the top/left of the first node.

• offset is a boolean indicating whether the co-ordinates should be offset from the top left of the document, and will default to false.

const position = query.position(offset);

Rectangle

Get the computed bounding rectangle of the first node.

• offset is a boolean indicating whether the rectangle should be offset from the top left of the document, and will default to false.

const rect = query.rect(offset);

Scroll

Get Scroll X

Get the scroll X position of the first node.

const scrollX = query.getScrollX();

Get Scroll Y

Get the scroll Y position of the first node.

const scrollY = query.getScrollY();

Set Scroll

Scroll each node to an X,Y position.

• x is a distance (in pixels) along the X axis to scroll to.
• y is a distance (in pixels) along the Y axis to scroll to.

query.setScroll(x, y);

Set Scroll X

Scroll each element to an X node.

• x is a distance (in pixels) along the X axis to scroll to.

query.setScrollX(x);

Set Scroll Y

Scroll each element to a Y node.

• y is a distance (in pixels) along the Y axis to scroll to.

query.setScrollY(y);

Size

Height

Get the computed height of the first node (and optionally padding, border or margin).

• innerNumber is a number indicating whether to include padding, border or margin sizes in the calculation. Allowed values are 0 (no padding), 1 (padding), 2 (padding and border) and 3 (padding, border and margin), and will default to 1.

const height = query.height(innerNumber);

If the first node is a Window, the first argument will instead determine whether to use the outer height, and will default to 0.

The following constants can also be used as the first argument for brevity.

• DOM.INNER 0
• DOM.OUTER 2
• DOM.OUTER_MARGIN 3

Scroll Height

Get the scroll height of the first node.

const scrollHeight = query.scrollHeight();

Scroll Width

Get the scroll width of the first node.

const scrollWidth = query.scrollWidth();

Width

Get the computed width of the first node (and optionally padding, border or margin).

• innerNumber is a number indicating whether to include padding, border or margin sizes in the calculation. Allowed values are 0 (no padding), 1 (padding), 2 (padding and border) and 3 (padding, border and margin), and will default to 1.

const width = query.width(innerNumber);

If the first node is a Window, the first argument will instead determine whether to use the outer width, and will default to 0.

The following constants can also be used as the first argument for brevity.

• DOM.INNER 0
• DOM.OUTER 2
• DOM.OUTER_MARGIN 3

Styles

Add Class

Add a class or classes to each node.

• classes is an array of classes, or a space seperated string of class names.

query.addClass(...classes);

Computed Style

Get the computed style for the first node.

• style is a string indicating the computed style property value to return.

const value = query.css(style);

If the style argument is omitted, an object containing all computed style values will be returned instead.

const css = query.css();

Get Style

Get a style property for the first node.

• style is a string indicating the style property value to return.

const value = query.getStyle(style);

If the style argument is omitted, an object containing all style values will be returned instead.

const styles = query.getStyle();

Hide

Hide each element from display.

query.hide();

Remove Class

Remove a class or classes from each node.

• classes is an array of classes, or a space seperated string of class names.

query.removeClass(...classes);

Set Style

Set style properties for each node.

• style is a string indicating the style property value to set.
• value is the value you wish to set the style property to.
• important is a boolean indicating the style should be set as important, and will default to false.

query.setStyle(style, value, important);

Alternatively, you can set multiple style properties by passing a single styles object as the argument with key/value pairs of the styles to set.

query.setStyle(styles);

Show

Display each hidden node.

query.show();

Toggle

Toggle the visibility of each node.

query.toggle();

Toggle Class

Toggle a class or classes for each node.

• classes is an array of classes, or a space seperated string of class names.

query.toggleClass(...classes);

Events

Blur

Trigger a blur event on the first node.

query.blur();

Click

Trigger a click event on the first node.

query.click();

Focus

Trigger a focus event on the first node.

query.focus();

Event Handlers

Add Event

Add events to each node.

• events is a space-separated string of events to attach to the nodes.
• callback is a function that accepts an event argument, which will be called when the event is triggered.

query.addEvent(events, callback);

Add Event Delegate

Add delegated events to each node.

• events is a space-separated string of events to attach to the nodes.
• delegate is a query selector string which will only trigger the event if it is propagated by a target matching the selector.
• callback is a function that accepts an event argument, which will be called when the event is triggered.

query.addEventDelegate(events, delegate, callback);

Add Event Delegate Once

Add self-destructing delegated events to each node.

• events is a space-separated string of events to attach to the nodes.
• delegate is a query selector string which will only trigger the event if it is propagated by a target matching the selector.
• callback is a function that accepts an event argument, which will be called when the event is triggered.

query.addEventDelegateOnce(events, delegate, callback);

Add Event Once

Add self-destructing events to each node.

• events is a space-separated string of events to attach to the nodes.
• callback is a function that accepts an event argument, which will be called when the event is triggered.

query.addEventOnce(events, callback);

Clone Events

Clone all events from each node to other nodes.

• others is a query selector string, a HTMLElement, ShadowRoot, Document, Window, NodeList, HTMLCollection, QuerySet or an array of nodes.

query.cloneEvents(others);

Remove Event

Remove events from each node.

• events is a space-separated string of events to remove from the nodes.
• callback is a function that accepts an event argument, which will be called when the event is triggered.

query.removeEvent(events, callback);

If the events and callback arguments are omitted, this method will remove all events from each node.

If just the callback arguments is omitted, this method will remove all events of the specified types.

Remove Event Delegate

Remove delegated events from each node.

• events is a space-separated string of events to remove from the nodes.
• delegate is a query selector string which will only trigger the event if it is propagated by a target matching the selector.
• callback is a function that accepts an event argument, which will be called when the event is triggered.

query.removeEventDelegate(events, delegate, callback);

Trigger Event

Trigger events on each node.

• events is a space-separated string of events to trigger on the nodes.
• options is an object containing properties to define the new Event.
  • details can be used to attach additional data to the event.
  • bubbles is a boolean indicating whether the event should bubble, and will default to true.
  • cancelable is a boolean indicating whether the event is cancelable, and will default to true.

query.triggerEvent(events, options);

Trigger One

Trigger an event on the first node.

• event is an event to trigger on the nodes.
• options is an object containing properties to define the new Event.
  • details can be used to attach additional data to the event.
  • bubbles is a boolean indicating whether the event should bubble, and will default to true.
  • cancelable is a boolean indicating whether the event is cancelable, and will default to true.

const cancelled = !query.triggerOne(event, options);

This method returns false if the event was cancelled, otherwise returns true.

Manipulation

Clone

Clone each node (optionally deep, and with events and data).

• deep is a boolean indicating whether you wish to clone all descendent nodes, and will default to true.
• cloneEvents is a boolean indicating whether you wish to clone all events to the new nodes and will default to false.
• cloneData is a boolean indicating whether you wish to clone all custom data to the new nodes and will default to false.

const clones = query.clone(deep, cloneEvents, cloneData);

This method always returns a new QuerySet containing the cloned nodes.

Detach

Detach each node from the DOM.

query.detach();

Empty

Remove all children of each node from the query.

query.empty();

Remove

Remove each node from the DOM.

query.remove();

Replace All

Replace each other node with nodes.

• others is a query selector string, a Node, HTMLElement NodeList, HTMLCollection, QuerySet or an array of nodes.

query.replaceAll(others);

If a node you are replacing with is a DocumentFragment, the fragment contents will be used as a replacement.

If multiple nodes are being replaced, cloned nodes will be created for each except for the last one.

All events, data and animations will be removed from each node that is replaced.

Replace With

Replace each node with other nodes.

• others is a query selector string, a HTML string, a Node, HTMLElement, DocumentFragment, NodeList, HTMLCollection, QuerySet or an array of nodes.

query.replaceWith(others);

If a node you are replacing with is a DocumentFragment, the fragment contents will be used as a replacement.

If multiple nodes are being replaced, cloned nodes will be created for each except for the last one.

All events, data and animations will be removed from each node that is replaced.

Create

Attach Shadow

Attach a shadow DOM tree to the first node.

• open is a boolean indicating whether the nodes are accessible from JavaScript outside the root, and will default to true.

const shadow = query.attachShadow(open);

This method always returns a new QuerySet containing the ShadowRoot.

Move

After

Insert each other node after the first node.

• others is a query selector string, a HTML string, a Node, HTMLElement, DocumentFragment, NodeList, HTMLCollection, QuerySet or an array of nodes.

query.after(others);

If the node you are moving is a DocumentFragment, the contents will be moved instead.

Append

Append each other node to the first node.

• others is a query selector string, a HTML string, a Node, HTMLElement, DocumentFragment, NodeList, HTMLCollection, QuerySet or an array of nodes.

query.append(others);

If a node you are moving is a DocumentFragment, the contents will be moved instead.

If multiple copies of the nodes are being moved, cloned nodes will be created for each except for the last one.

Append To

Append each node to the first other node.

• others is a query selector string, a HTMLElement, DocumentFragment, ShadowRoot, Document, NodeList, HTMLCollection, QuerySet or an array of nodes.

query.appendTo(others);

If a node you are moving is a DocumentFragment, the contents will be moved instead.

If multiple copies of the nodes are being moved, cloned nodes will be created for each except for the last one.

Before

Insert each other node before the first node.

• others is a query selector string, a HTML string, a Node, HTMLElement, DocumentFragment, NodeList, HTMLCollection, QuerySet or an array of nodes.

query.before(others);

If a node you are moving is a DocumentFragment, the contents will be moved instead.

If multiple copies of the nodes are being moved, cloned nodes will be created for each except for the last one.

Insert After

Insert each node after the first other node.

• others is a query selector string, a Node, HTMLElement, NodeList, HTMLCollection, QuerySet or an array of nodes.

query.insertAfter(others);

If a node you are moving is a DocumentFragment, the contents will be moved instead.

If multiple copies of the nodes are being moved, cloned nodes will be created for each except for the last one.

Insert Before

Insert each node before the first other node.

• others is a query selector string, a Node, HTMLElement, NodeList, HTMLCollection, QuerySet or an array of nodes.

query.insertBefore(others);

If a node you are moving is a DocumentFragment, the contents will be moved instead.

If multiple copies of the nodes are being moved, cloned nodes will be created for each except for the last one.

Prepend

Prepend each other node to the first node.

• others is a query selector string, a HTML string, a Node, HTMLElement, DocumentFragment, NodeList, HTMLCollection, QuerySet or an array of nodes.

query.prepend(others);

If a node you are moving is a DocumentFragment, the contents will be moved instead.

If multiple copies of the nodes are being moved, cloned nodes will be created for each except for the last one.

Prepend To

Prepend each node to the first other node.

• others is a query selector string, a HTMLElement, DocumentFragment, ShadowRoot, Document, NodeList, HTMLCollection, QuerySet or an array of nodes.

query.prependTo(others);

If a node you are moving is a DocumentFragment, the contents will be moved instead.

If multiple copies of the nodes are being moved, cloned nodes will be created for each except for the last one.

Wrap

Unwrap

Unwrap each node.

• filter is either a function that accepts a node argument, a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, NodeList, HTMLCollection, QuerySet or an array of nodes that must match the parent of each node for it to be unwrapped.

query.unwrap(filter);

Wrap

Wrap each nodes with other nodes.

• others is a query selector string, a HTML string, a HTMLElement, DocumentFragment, NodeList, HTMLCollection, QuerySet or an array of nodes.

query.wrap(others);

If a node you are wrapping with is a DocumentFragment, the contents will be used to wrap instead.

Wrap All

Wrap all nodes with other nodes.

• others is a query selector string, a HTML string, a HTMLElement, DocumentFragment, NodeList, HTMLCollection, QuerySet or an array of nodes.

query.wrapAll(others);

If a node you are wrapping with is a DocumentFragment, the contents will be used to wrap instead.

Wrap Inner

Wrap the contents of each node with other nodes.

• others is a query selector string, a HTML string, a HTMLElement, DocumentFragment, NodeList, HTMLCollection, QuerySet or an array of nodes.

query.wrapInner(others);

If a node you are wrapping with is a DocumentFragment, the contents will be used to wrap instead.

Traversal

Child

Find the first child of each node (optionally matching a filter) and push them to the stack.

• filter is either a function that accepts a node argument, a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, NodeList, HTMLCollection, QuerySet or an array of nodes that the nodes will be filtered by, and will default to false.

const child = query.child(filter);

Children

Find all children of each node (optionally matching a filter) and push them to the stack.

• filter is either a function that accepts a node argument, a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, NodeList, HTMLCollection, QuerySet or an array of nodes that the nodes will be filtered by, and will default to false.

const children = query.children(filter);

Closest

Find the closest ancestor to each node (optionally matching a filter, and before a limit) and push them to the stack.

• filter is either a function that accepts a node argument, a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, NodeList, HTMLCollection, QuerySet or an array of nodes that the nodes will be filtered by, and will default to false.
• limit is either a function that accepts a node argument, a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, NodeList, HTMLCollection, QuerySet or an array of nodes that when matched will stop the search, and will default to false.

const closest = query.closest(filter, limit);

Common Ancestor

Find the common ancestor of all nodes and push it to the stack.

const commonAncestor = query.commonAncestor();

Contents

Find all children of each node (including text and comment nodes) and push them to the stack.

const contents = query.contents();

Fragment

Return the DocumentFragment of the first node. and push it to the stack

const fragment = query.fragment();

Next

Find the next sibling for each node (optionally matching a filter) and push them to the stack.

• filter is either a function that accepts a node argument, a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, NodeList, HTMLCollection, QuerySet or an array of nodes that the nodes will be filtered by, and will default to false.

const next = query.next(filter);

Next All

Find all next siblings for each node (optionally matching a filter, and before a limit) and push them to the stack.

• filter is either a function that accepts a node argument, a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, NodeList, HTMLCollection, QuerySet or an array of nodes that the nodes will be filtered by, and will default to false.
• limit is either a function that accepts a node argument, a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, NodeList, HTMLCollection, QuerySet or an array of nodes that when matched will stop the search, and will default to false.

const nextAll = query.nextAll(filter, limit, first);

Offset Parent

Find the offset parent (relatively positioned) of the first node and push it to the stack.

const offsetParent = query.offsetParent();

Parent

Find the parent of each node (optionally matching a filter) and push them to the stack.

• filter is either a function that accepts a node argument, a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, NodeList, HTMLCollection, QuerySet or an array of nodes that the nodes will be filtered by, and will default to false.

const parent = query.parent(filter);

Parents

Find all parents of each node (optionally matching a filter, and before a limit) and push them to the stack.

• filter is either a function that accepts a node argument, a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, NodeList, HTMLCollection, QuerySet or an array of nodes that the nodes will be filtered by, and will default to false.
• limit is either a function that accepts a node argument, a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, NodeList, HTMLCollection, QuerySet or an array of nodes that when matched will stop the search, and will default to false.

const parents = query.parents(filter, limit, first);

Previous

Find the previous sibling for each node (optionally matching a filter) and push them to the stack.

• filter is either a function that accepts a node argument, a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, NodeList, HTMLCollection, QuerySet or an array of nodes that the nodes will be filtered by, and will default to false.

const prev = query.prev(filter);

Previous All

Find all previous siblings for each node (optionally matching a filter, and before a limit) and push them to the stack.

• filter is either a function that accepts a node argument, a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, NodeList, HTMLCollection, QuerySet or an array of nodes that the nodes will be filtered by, and will default to false.
• limit is either a function that accepts a node argument, a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, NodeList, HTMLCollection, QuerySet or an array of nodes that when matched will stop the search, and will default to false.

const prevAll = query.prevAll(filter, limit, first);

Shadow

Return the ShadowRoot of the first node and push it to the stack.

const shadow = query.shadow();

Siblings

Find all siblings for each node (optionally matching a filter) and push them to the stack.

• filter is either a function that accepts a node argument, a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, NodeList, HTMLCollection, QuerySet or an array of nodes that the nodes will be filtered by, and will default to false.

const siblings = query.siblings(filter);

Filter

Connected

Find all nodes connected to the DOM and push them to the stack.

const connected = query.connected();

Equal

Find all nodes considered equal to any of the other nodes and push them to the stack.

• others is a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, NodeList, HTMLCollection, QuerySet or an array of nodes.

const equal = query.equal(others);

Filter

Find all nodes matching a filter and push them to the stack.

• filter is either a function that accepts a node argument, a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, NodeList, HTMLCollection, QuerySet or an array of nodes that the nodes will be filtered by.

const filtered = query.filter(filter);

Filter One

Find the first node matching a filter and push it to the stack.

• filter is either a function that accepts a node argument, a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, NodeList, HTMLCollection, QuerySet or an array of nodes that the nodes will be filtered by.

const filteredOne = query.filterOne(filter);

Fixed

Find all "fixed" nodes and push them to the stack.

const fixed = query.fixed();

Hidden

Find all hidden nodes and push them to the stack.

const hidden = query.hidden();

Not

Find all nodes not matching a filter and push them to the stack.

• filter is either a function that accepts a node argument, a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, NodeList, HTMLCollection, QuerySet or an array of nodes that the nodes will be filtered by.

const not = query.not(filter);

Not One

Find the first node not matching a filter and push it to the stack.

• filter is either a function that accepts a node argument, a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, NodeList, HTMLCollection, QuerySet or an array of nodes that the nodes will be filtered by.

const notOne = query.notOne(filter);

Same

Find all nodes considered identical to any of the other nodes and push them to the stack.

• others is a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, NodeList, HTMLCollection, QuerySet or an array of nodes.

const same = query.same(others);

Visible

Find all visible nodes and push them to the stack.

const visible = query.visible();

With Animation

Find all nodes with an animation and push them to the stack.

const withAnimation = query.withAnimation();

With Attribute

Find all nodes with a specified attribute and push them to the stack.

• attribute is a string indicating the attribute value to test for.

const withAttribute = query.withAttribute(attribute);

With Children

Find all nodes with child elements and push them to the stack.

const withChildren = query.withChildren();

With Class

Find all nodes with any of the specified classes and push them to the stack.

• classes is an array of classes, or a space seperated string of class names to test for.

const withClass = query.withClass(classes);

With CSS Animation

Find all nodes with a CSS animation and push them to the stack.

const withCSSAnimation = query.withCSSAnimation();

With CSS Transition

Find all nodes with a CSS transition and push them to the stack.

const withCSSTransition = query.withCSSTransition();

With Data

Find all nodes with custom data and push them to the stack.

• key is a string indicating the custom data value to test for.

const withData = query.withData(key);

If the key argument is omitted, this method will find all nodes with any custom data and push them to the stack.

const withData = query.withData();

With Descendent

Find all elements with a descendent matching a filter and push them to the stack.

• filter is either a function that accepts a node argument, a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, NodeList, HTMLCollection, QuerySet or an array of nodes that the nodes will be filtered by.

const withDescendent = query.withDescendent(filter);

With Property

Find all nodes with a specified property and push them to the stack.

• property is a string indicating the property value to test for.

const withProperty = query.withProperty(property);

Find

Find

Find all descendent nodes matching a selector and push them to the stack.

• selector is a query selector string to search for.

const elements = query.find(selector);

Find By Class

Find all descendent nodes with a specific class and push them to the stack.

• className is a string indicating the class name to search for.

const elements = query.findByClass(className);

Find By ID

Find all nodes with a specific ID and push them to the stack.

• id is a string indicating the id to search for.

const elements = query.findById(id);

Find By Tag

Find all nodes with a specific tag and push them to the stack.

• tagName is a string indicating the tag name to search for.

const elements = query.findByTag(tagName);

Find One

Find the first node matching a selector and push it to the stack.

• selector is a query selector string to search for.

const element = query.findOne(selectors);

Find One By Class

Find the first node with a specific class and push it to the stack.

• className is a string indicating the class name to search for.

const element = query.findOneByClass(className);

Find One By ID

Find the first node with a specific ID and push it to the stack.

• id is a string indicating the id to search for.

const element = query.findOneById(id);

Find One By Tag

Find the first node with a specific tag and push it to the stack.

• tagName is a string indicating the tag name to search for.

const element = query.findOneByTag(tagName);

Utility

Add

Push new nodes to the stack and sort the results.

• selector is a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, Document, Window, NodeList, HTMLCollection, QuerySet or an array of nodes.
• context is a query selector string, a HTMLElement, DocumentFragment, ShadowRoot, Document, HTMLCollection, QuerySet or an array of nodes, and will default to the Document context of the dom.

const merged = query.add(selector, context);

Each

Execute a function for each node in the set.

• callback is a function that accepts a node and index as arguments.

query.each(callback);

Eq

Reduce the set of nodes to the one at the specified index.

• index is the index of the node.

const eq = query.eq(index);

First

Reduce the set of nodes to the first.

const first = query.first();

Force Show

Force an node to be temporarily shown, and then execute a callback.

• callback is a function that accepts a node as a parameter.

query.forceShow(callback);

Get

Retrieve the DOM node(s) contained in the QuerySet.

• index is the index of the node.

const node = query.get(index);

If no index argument is supplied, this method will return the internal array containing all the nodes in the set.

const nodes = query.get();

Index

Get the index of the first node relative to it's parent node.

const index = query.index();

Index Of

Get the index of the first node matching a filter.

• filter is either a function that accepts a node argument, a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, NodeList, HTMLCollection, QuerySet or an array of nodes that the nodes will be tested for.

const indexOf = query.indexOf(filter);

Last

Reduce the set of nodes to the last.

const last = query.last();

Map

Execute a function for each node in the set.

• callback is a function that accepts a node and index as arguments.

const mapped = query.map(callback);

This method always returns a new QuerySet containing the mapped nodes.

Normalize

Normalize nodes (remove empty text and join adjacent text nodes).

query.normalize();

Serialize

Returns a serialized string containing names and values of all form nodes.

const serialized = query.serialize();

Serialize Array

Returns a serialized array containing names and values of all form nodes.

const serializedArray = query.serializeArray();

Slice

Reduce the set of matched elements to a subset specified by a range of indices.

• begin is a number indicating the index to begin slicing from, and will default to 0.
• end is a number indicating the index to end slicing, and will default to the length of the set.

const sliced = query.slice(begin, end);

This method always returns a new QuerySet containing the sliced nodes.

Sort

Sort nodes by their position in the document.

query.sort();

Tag Name

Return the tag name (lowercase) of the first node.

const tagName = query.tagName();

Symbol.iterator

Return an iterable from the elements.

This method allows the QuerySet to be used in a for...of loop.

for (const node of query) {
    console.log(node);
}

Selection

After Selection

Insert each node after the selection.

query.afterSelection();

If a node you are moving is a DocumentFragment, the contents will be moved instead.

Before Selection

Insert each node before the selection.

query.beforeSelection();

If a node you are moving is a DocumentFragment, the contents will be moved instead.

Select

Create a selection on the first node.

query.select();

Select All

Create a selection on all nodes.

query.selectAll();

Wrap Selection

Wrap selected nodes with other nodes.

query.wrapSelection();

Tests

Has Animation

Returns true if any of the nodes has an animation.

const hasAnimation = query.hasAnimation();

Has Attribute

Returns true if any of the nodes has a specified attribute.

• attribute is a string indicating the attribute value to test for.

const hasAttribute = query.hasAttribute(attribute);

Has Children

Returns true if any of the nodes has child nodes.

const hasChildren = query.hasChildren();

Has Class

Returns true if any of the nodes has any of the specified classes.

• classes is an array of classes, or a space seperated string of class names to test for.

const hasClass = query.hasClass(...classes);

Has CSS Animation

Returns true if any of the nodes has a CSS animation.

const hasCSSAnimation = query.hasCSSAnimation();

Has CSS Transition

Returns true if any of the nodes has a CSS transition.

const hasCSSTransition = query.hasCSSTransition();

Has Data

Returns true if any of the nodes has custom data.

• key is a string indicating the custom data value to test for.

const hasData = query.hasData(key);

If the key argument is omitted, this method will return true if any of the nodes has any custom data.

query.hasData();

Has Descendent

Returns true if any of the nodes contains a descendent matching a filter.

• filter is either a function that accepts a node argument, a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, NodeList, HTMLCollection, QuerySet or an array of nodes that the nodes will be tested for.

const hasDescendent = query.hasDescendent(filter);

Has Property

Returns true if any of the nodes has a specified property.

• property is a string indicating the property value to test for.

const hasProperty = query.hasProperty(property);

Is

Returns true if any of the nodes matches a filter.

• filter is either a function that accepts a node argument, a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, NodeList, HTMLCollection, QuerySet or an array of nodes that the nodes will be tested for.

const is = query.is(filter);

Is Connected

Returns true if any of the nodes is connected to the DOM.

const isConnected = query.isConnected();

Is Equal

Returns true if any of the nodes is considered equal to any of the other nodes.

• others is a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, NodeList, HTMLCollection, QuerySet or an array of nodes.

const isEqual = query.isEqual(others);

Is Fixed

Returns true if any of the nodes or a parent of any of the nodes is "fixed".

const isFixed = query.isFixed();

Is Hidden

Returns true if any of the nodes is hidden.

const isHidden = query.isHidden();

Is Same

Returns true if any of the nodes is considered identical to any of the other nodes.

• others is a query selector string, a Node, HTMLElement, DocumentFragment, ShadowRoot, NodeList, HTMLCollection, QuerySet or an array of nodes.

const isSame = query.isSame(others);

Is Visible

Returns true if any of the nodes is visible.

const isVisible = query.isVisible();