Home

Awesome

select-dom npm downloads

Lightweight querySelector/All wrapper that outputs an Array

Install

npm install select-dom

import {$, $$, lastElement, elementExists} from 'select-dom';

// And a stricter version
import {$, $optional} from 'select-dom/strict.js';

API

Note: if a falsy value is passed as baseElement, you'll always get an empty result (bd578b9)

$(selector[, baseElement = document])

Maps to baseElement.querySelector(selector), except it returns undefined if it's not found

$('.foo a[href=bar]');
// => <Element>

$('.foo a[href=bar]', baseElement);
// => <Element>

$('.non-existent', baseElement);
// => undefined

lastElement(selector[, baseElement = document])

Like $(), except that it returns the last matching item on the page instead of the first one.

elementExists(selector[, baseElement = document])

Tests the existence of one or more elements matching the selector. It's like $(), except it returns a boolean.

elementExists('.foo a[href=bar]');
// => true/false

elementExists('.foo a[href=bar]', baseElement);
// => true/false

countElements(selector[, baseElement = document])

Counts the number of elements found on the page or in the base element. Just a shortcut over $$(selector).length

countElements('a');
// => 3

$$(selector[, baseElements = document])

Maps to baseElements.querySelectorAll(selector) plus:

$$('.foo');
// => [<Element>, <Element>, <Element>]

$$('.foo', baseElement);
// => [<Element>, <Element>, <Element>]

$$('.foo', [baseElement1, baseElement2]);
// => [<Element>, <Element>, <Element>]
// This is similar to jQuery([baseElement1, baseElement2]).find('.foo')

/strict.js

The strict export will throw an error if the element is not found, instead of returning undefined. This is also reflected in the types, which are non-nullable:

import {$, $optional, $$, $$optional} from 'select-dom/strict.js';

const must: HTMLAnchorElement = $('.foo a[href=bar]'); //
const optional: HTMLAnchorElement | undefined = $optional('.foo a[href=bar]');


const oneOrMore: HTMLAnchorElement[] = $$('.foo a[href=bar]'); //
const zeroOrMore: HTMLAnchorElement[] = $$optional('.foo a[href=bar]');

Related