Giter Club home page Giter Club logo

dusk's Introduction

dusk

Build Status
A feathery (light), alacritous (fast), extensible DOM abstraction. (Partly based on PlainJS. And faster than jQuery)

At its core it's nothing but a selector that will return an array of HTMLElement's:

var $popup = dusk('#popup');              // will return a single-element array
var $rows  = dusk('.my-table tr');        // will return an array
var $oops  = dusk('.non-existing-class'); // will return an empty array

This means it has the same collection of methods as a native array. Pretty cool. And you can pass dusk some strange things as well:

var $itself  = dusk(dusk('div'));                      // dusk recognizes itself
var $list    = dusk(document.querySelectorAll('div')); // it turns NodeList's and HTMLCollection's into arrays
var $context = dusk('.class', '#context');             // and it can use a context

Getting Started

dusk implements the Universal Module Definition (UMD), and resides on NPM so that you can really use it any way you want. To include it in your project:

Download it...

Get it from https://github.com/mjsarfatti/dusk/blob/master/dist/dusk.min.js, then include it with:

HTML

<script src="path/to/dusk.min.js"></script>

AMD

require(['path/to/dusk.min.js'], function(dusk) {
	// ...
});

CommonJS

var dusk = require('path/to/dusk.min.js');

...or NPM it

$ npm install --save dusk, then:

CommonJS + NPM

var dusk = require('dusk');

ECMAScript 2015

import dusk from 'dusk';

Methods

At the moment it ships only one, static, method.

dusk.DOMReady

(shamelessly stolen from jQuery)

dusk.DOMReady(function() {
	// something to execute on DOM ready
});

Extend (Plugins)

But it's already apt to be extended!

const $demo = dusk('#demo');

dusk.fn.plugin1 = function () {
  // do something with `this` (remember, it's an array)
  return this;
};

dusk.fn.plugin2 = function () {
  // do something with `this`
  return this;
};

$demo.plugin1().plugin2();

The Future

Version 1.1 will include the following:

Events

  • .on()
  • .off()
  • .one()

Classes

  • .hasClass()
  • .addClass()
  • .removeClass()
  • .toggleClass()

It will also include polyfills for matches and closest.

This will cover 95% of the use cases. And remember, for all the rest you have PlainJS and the Fetch API.

Ps: of course, if you absolutely need .thirdChild() you can easily extend the core. In fact, that is the whole purpose of this: a super-lightweight extensible DOM abstraction.

Browser support

At the moment dusk has been tested on

  • IE11
  • Edge
  • Chrome
  • Firefox
  • Safari

Version 1.1 will be tested against IE9+ and mobile browsers as well.

License

dusk is released under the MIT license.

dusk's People

Contributors

mjsarfatti avatar

Watchers

 avatar  avatar

Forkers

satrianak

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.