Skip to content
master
Go to file
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

test Coverage Status CodeFactor Size npm version GitHub

Carbonium

One kilobyte library for easy manipulation of the DOM

With carbonium, you can call $(selector) and the result can be accessed as both an DOM element and an array of matched elements. DOM element operations are applied to all matched elements.

Examples

To set the left CSS property of all elements with the class indent to 40 pixels:

$(".indent").style.left = "40px";

To add the class important to all div's with "priority" as content:

$("div")
  .filter((el) => el.textContent == "priority")
  .classList.add("important");

You can use carbonium to create elements:

const error = $("<div class='error'>An error has occured!</div>")[0];

Installation

npm install --save-dev carbonium

Now you can import carbonium:

import { $ } from "carbonium";

If you don't want to install or use a bundler like webpack or rollup.js, you can import carbonium like this:

const { $ } = await import(
  "https://cdn.jsdelivr.net/npm/carbonium@1/dist/bundle.min.js"
);

API

Select elements

$(selector [, parentNode])

Parameters

Name Type Description
selector string Selector to select elements
parentNode Document | Element (optional) Document or element in which to apply the selector, defaults to document

Returns

An array of the matched elements, which can also be accessed as a single element.

Create element

$(html [, parentNode])

Parameters

Name Type Description
selector string HTML of element to create, starting with "<"
parentNode Document | Element (optional) Document or element in which to apply the selector, defaults to document

Returns

An array with one created element.

TypeScript

If you use TypeScript, it's good to know Carbonium is written in TypeScript and provides all typings. You can use generics to declare a specific type of element, for example HTMLInputElement to make the disabled property available:

$<HTMLInputElement>("input, select, button").disabled = true;

Why?

You might find most frameworks are quite bulky and bad for performance (1). On the other side, you might find using native DOM and writing document.querySelectorAll(selector) each time you want to do some DOM operations to become tedious. You can write your own helper function, but that only takes part of the pain away.

Carbonium seeks to find the sweet spot between using a framework and using the native DOM.

jQuery

Isn't this just jQuery and isn't that obsolete and bad practice?

No. Carbonium doesn't have the disadvantages of jQuery:

  1. Carbonium is very small: just around one kilobyte.
  2. There's no new API to learn, carbonium provides only standard DOM API's.

Browser support

Carbonium is supported by all modern browsers. It is tested to work on desktop and mobile with Firefox 79, Chrome 84, Safari 13 and Edge 84. It should work with all browsers supporting Proxy, see Can I use Proxy for support tables.

Name

Photo of diamond and graphite

Carbonium is the Latin name for carbon. Carbon has two forms (allotropes): graphite and diamond. Just like this library, in which the result presents itself both as one element and as a list of elements.

Photo CC BY-SA 3.0

License

Copyright 2020 Edwin Martin and released under the MIT license.

About

One kilobyte library for easy manipulation of the DOM

Resources

License

Packages

No packages published
You can’t perform that action at this time.