a CSS selector compiler/engine
css-select turns CSS selectors into functions that tests if elements match them. When searching for elements, testing is executed "from the top", similar to how browsers execute CSS selectors.
In its default configuration, css-select queries the DOM structure of the
domhandler module (also known as htmlparser2 DOM).
domutils as its default adapter over the DOM structure. See Options below for details on querying alternative DOM structures.
- Full implementation of CSS3 selectors
- Partial implementation of jQuery/Sizzle extensions
- Very high test coverage
- Pretty good performance
The traditional approach of executing CSS selectors, named left-to-right execution, is to execute every component of the selector in order, from left to right (duh). The execution of the selector
a b for example will first query for
a elements, then search these for
b elements. (That's the approach of eg.
While this works, it has some downsides: Children of
as will be checked multiple times; first, to check if they are also
as, then, for every superior
a once, if they are
bs. Using Big O notation, that would be
k is the number of descendant selectors (that's the space in the example above).
The far more efficient approach is to first look for
b elements, then check if they have superior
a elements: Using big O notation again, that would be
O(n). That's called right-to-left execution.
And that's what css-select does – and why it's quite performant.
How does it work?
By building a stack of functions.
Okay, so let's suppose we want to compile the selector
a b again, for right-to-left execution. We start by parsing the selector, which means we turn the selector into an array of the building-blocks of the selector, so we can distinguish them easily. That's what the
css-what module is for, if you want to have a look.
Anyway, after parsing, we end up with an array like this one:
type: 'tag' name: 'a'type: 'descendant'type: 'tag' name: 'b'
Actually, this array is wrapped in another array, but that's another story (involving commas in selectors).
Now that we know the meaning of every part of the selector, we can compile it. That's where it becomes interesting.
The basic idea is to turn every part of the selector into a function, which takes an element as its only argument. The function checks whether a passed element matches its part of the selector: If it does, the element is passed to the next turned-into-a-function part of the selector, which does the same. If an element is accepted by all parts of the selector, it matches the selector and double rainbow ALL THE WAY.
As said before, we want to do right-to-left execution with all the big O improvements nonsense, so elements are passed from the rightmost part of the selector (
b in our example) to the leftmost (
which would be of course
//TODO: More in-depth description. Implementation details. Build a spaceship.
const CSSselect = ;
Note: css-select throws errors when invalid selectors are passed to it, contrary to the behavior in browsers, which swallow them. This is done to aid with writing css selectors, but can be unexpected when processing arbitrary strings.
CSSselect(query, elems, options)
elems, returns an array containing all matches.
querycan be either a CSS selector or a function.
elemscan be either an array of elements, or a single element. If it is an element, its children will be queried.
optionsis described below.
Compiles the query, returns a function.
CSSselect.is(elem, query, options)
Tests whether or not an element is matched by
query can be either a CSS selector or a function.
CSSselect.selectOne(query, elems, options)
Arguments are the same as for
CSSselect(query, elems). Only returns the first match, or
null if there was no match.
xmlMode: When enabled, tag names will be case-sensitive. Default:
strict: Limits the module to only use CSS3 selectors. Default:
rootFunc: The last function in the stack, will be called with the last element that's looked at. Should return
adapter: The adapter to use when interacting with the backing DOM structure. By default it uses
A custom adapter must implement the following functions:
isTag, existsOne, getAttributeValue, getChildren, getName, getParent, getSiblings, getText, hasAttrib, removeSubsets, findAll, findOne
The method signature notation used below should be fairly intuitive - if not,
TypeScript docs, as it is very similar to
both of those. You may also want to look at
domutils to see the default
-implementation, or at
-for an implementation backed by the DOM.
As defined by CSS 4 and / or jQuery.
- Universal (
- Tag (
- Descendant (
- Child (
- Parent (
- Sibling (
- Adjacent (
- Attribute (
[attr=foo]), with supported comparisons:
ican be added after the comparison to make the comparison case-insensitive (eg.
[attr=foo i]) *
:icontains* (case-insensitive version of
:active* (these depend on optional Adapter methods, so these will work only if implemented in Adapter)
*: Not part of CSS3
Security contact information
To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.
css-select for enterprise
Available as part of the Tidelift Subscription
The maintainers of
css-select and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.