Skip to content

A small javascript DOM manipulation library based on Jquery's syntax. Acts as a small utility library with the most common functions.

License

Notifications You must be signed in to change notification settings

mcqua007/quantdom

Repository files navigation

Quantdom JS

npm bundle size npm bundle size license type test coverage

Quantdom is a very small (about 600 bytes when run through terser & gzipped) dom manipulation library that uses a Jquery like syntax and supports chaining but is only composed of the most commonly used utility functions. Quantdom makes working with the DOM less verbose, without all the bloat from jQuery. I chose to base it off of Jquery's syntax as many developers are already familiar with it and it's very concise. This library is meant to be as small as possible (without being unreadable) so when you need to directly interact with the DOM you can use this library alog side of a larger framework without all the extra bloat.

Why the name, QuantDOM ? Taken from Wikipedia's Quantum article, "In physics, a quantum (plural quanta) is the minimum amount of any physical entity (physical property) involved in an interaction." This fits the goal of this project as Quantdom is made to reduce the effort when having to deal directly with the DOM.

Supports Chaining:

$('.modal').show().addClass('active-overlay');

Getting Started

Install via NPM

  1. Install using npm npm i quantdom or with yarn yarn add quantdom
  2. Then import into project using import q from 'quantdom' or use the jQuery popularized $ as your function name. i.e. import $ from 'quantdom'

Install via CDN

  1. Use latest version https://cdn.jsdelivr.net/npm/quantdom or specify a certain version https://cdn.jsdelivr.net/npm/[email protected]/dist/quantdom.min.js. Visit Quantdom's JSDelivr page for ESM versions.

    <script src="https://cdn.jsdelivr.net/npm/quantdom"></script>
  2. Then start using ex.

    $('.drop-down').attr('aria-expanded', 'true');

Try it Out!

Documentation

View generated documentation