nwmatcher
Advanced tools
Package description
The nwmatcher npm package is a fast CSS selector engine and matcher, primarily used for matching DOM elements against CSS selectors. It is useful for tasks such as querying and filtering elements in a DOM-like structure.
Matching Elements
This feature allows you to check if a given DOM element matches a specific CSS selector.
const NWMatcher = require('nwmatcher');
const matcher = NWMatcher({ document });
const element = document.getElementById('example');
const isMatch = matcher.match(element, '.example-class');
console.log(isMatch); // true or falseQuerying Elements
This feature allows you to query and retrieve all DOM elements that match a specific CSS selector.
const NWMatcher = require('nwmatcher');
const matcher = NWMatcher({ document });
const elements = matcher.select('.example-class');
console.log(elements); // Array of elements matching the selectorCustom Selectors
This feature allows you to register and use custom selectors for more advanced querying.
const NWMatcher = require('nwmatcher');
const matcher = NWMatcher({ document });
matcher.registerSelector('custom', function(element) {
return element.hasAttribute('data-custom');
});
const elements = matcher.select(':custom');
console.log(elements); // Array of elements with the 'data-custom' attributeSizzle is a pure-JavaScript CSS selector engine designed to be easily dropped in to a host library. It is highly optimized for performance and is used internally by jQuery. Compared to nwmatcher, Sizzle is more widely used and integrated into larger libraries like jQuery.
css-select is a library for selecting elements in a DOM-like structure using CSS selectors. It is part of the Cheerio library, which is used for server-side DOM manipulation. css-select is similar to nwmatcher but is often used in conjunction with Cheerio for server-side applications.
query-selector-shadow-dom is a library that extends the native querySelector and querySelectorAll methods to work with shadow DOM. It is useful for querying elements within shadow DOM trees, which nwmatcher does not natively support.
Readme
A fast CSS selector engine and matcher.
To include NWMatcher in a standard web page:
<script type="text/javascript" src="nwmatcher.js"></script>
To use it with Node.js:
$ npm install nwmatcher
NWMatcher currently supports browsers (as a global, NW.Dom) and headless environments (as a CommonJS module).
Here is a list of all the CSS2/CSS3 Supported selectors.
You can read more about NWMatcher features and compliance on the wiki.
first( selector, context )Returns a reference to the first element matching selector, starting at context.
match( element, selector, context )Returns true if element matches selector, starting at context; returns false otherwise.
select( selector, context, callback )Returns an array of all the elements matching selector, starting at context. If callback is provided, it is invoked for each matching element.
byId( id, from )Returns a reference to the first element with ID id, optionally filtered to descendants of the element from.
byTag( tag, from )Returns an array of elements having the specified tag name tag, optionally filtered to descendants of the element from.
byClass( class, from )Returns an array of elements having the specified class name class, optionally filtered to descendants of the element from.
byName( name, from )Returns an array of elements having the specified value name for their name attribute, optionally filtered to descendants of the element from.
getAttribute( element, attribute )Return the value read from the attribute of element with name attribute, as a string.
hasAttribute( element, attribute )Returns true element has an attribute with name attribute set; returns false otherwise.
configure( options )The following is the list of currently available configuration options, their default values and descriptions, they are boolean flags that can be set to true or false:
CACHING: false - false to disable caching of result sets, true to enableESCAPECHR: true - true to allow CSS escaped identifiers, false to disallowNON_ASCII: true - true to allow identifiers containing non-ASCII (utf-8) charsSELECTOR3: true - switch syntax RE, true to use Level 3, false to use Level 2UNICODE16: true - true to allow identifiers containing Unicode (utf-16) charsSHORTCUTS: false - false to disable mangled selector strings like "+div" or "ul>"SIMPLENOT: true - true to disallow complex selectors nested in ':not()' classesUNIQUE_ID: true - true to disallow multiple elements with the same id (strict)USE_HTML5: true - true to use HTML5 specs for ":checked" and similar UI statesUSE_QSAPI: true - true to use browsers native Query Selector API if availableVERBOSITY: true - true to throw exceptions, false to skip throwing exceptionsLOGERRORS: true - true to print console errors or warnings, false to mute themExample:
NW.Dom.configure( { USE_QSAPI: false, VERBOSITY: false } );
registerOperator( symbol, resolver )Registers a new symbol and its matching resolver in the operators table. Example:
NW.Dom.registerOperator( '!=', 'n!="%m"' );
registerSelector( name, rexp, func )Registers a new selector, with the matching regular expression and the appropriate resolver function, in the selectors table.
FAQs
A CSS3-compliant JavaScript selector engine.
The npm package nwmatcher receives a total of 407,814 weekly downloads. As such, nwmatcher popularity was classified as popular.
We found that nwmatcher demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
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.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.
Security News
A JavaScript library maintainer is under fire after merging a controversial PR to support legacy versions of Node.js.
Security News
Results from the 2023 State of JavaScript Survey highlight key trends, including Vite's dominance, rising TypeScript adoption, and the enduring popularity of React. Discover more insights on developer preferences and technology usage.