Skip to content
This repository has been archived by the owner on Jan 10, 2022. It is now read-only.

Latest commit

 

History

History
178 lines (125 loc) · 3.58 KB

README.md

File metadata and controls

178 lines (125 loc) · 3.58 KB

realdom

A lightweight DOM & Event manipulation.

NPM Build Status Coverage Status

Setup

Usage

import {create, add} from 'realdom';

const div = create('DIV');
div.addClass('panel');

const span = add('SPAN', div);
span.html('Hello world');
// ...

How does it work?

Here are several examples:

APIs

DOM

import {
  ready,
  create,
  add,
  get,
  query,
  queryAll
} from 'realdom';

const rows = queryAll('table tr');
rows.forEach((row) => {
  row.style.backgroundColor = 'red';
});

  • .query(String selectors)
  • .queryAll(String selectors)
  • .get(String ID)
  • .add(Element|String tag [, Element parent])
  • .create(Element dom)
  • .ready(Function callback)

Returned elements have several helpful methods as below:

  • .hasClass(String className)
  • .addClass(String className_1, String className_2, ...)
  • .removeClass(String className_1, String className_2, ...)
  • .toggleClass(String className_1, String className_2, ...)
  • .replaceClass(String classNameOld, String classNameNew)
  • .setProperty(Object atts)
  • .setStyle(Object style)
  • .query(String selectors)
  • .queryAll(String selectors)
  • .html([String html])
  • .empty()
  • .destroy()

Event

import { Event } from 'realdom';
  • .Event.on(String|Element s, String eventName, Function callback)
  • .Event.off(String|Element s, String eventName, Function callback)
  • .Event.simulate(String|Element s, String eventName)
  • .Event.stop(Event e)
  • .Event.locate(Event e)

Examples:

import {
  ready,
  add,
  all,
  Event
} from 'realdom';

ready(() => {

  // Add a new element to document.body
  const container = add('DIV');

  // then add a DIV element into container
  const div1 = add('DIV', container);

  // then add a class "sub-item" to child DIV
  div1.addClass('sub-item');

  // more a child DIV
  const div2 = add('DIV', container);

  // also add a class "sub-item"
  div2.addClass('sub-item');

  // now, we can extract list of elements by class name:
  const subItems = all('.sub-item');

  console.log(subItems);


  // create a button
  const btn = add('INPUT');

  // add some attributes
  btn.setProperty({
    type: 'button',
    id: 'btnLogin',
    value: 'Login'
  });

  // specify css style
  btn.setStyle({
    color: 'red',
    fontSize: 15,
    backgroundColor: '#ff6',
    maxWidth: 500,
    'padding-top': '2px'
  });

  // set an event listener
  Event.on(btn, 'click', () => {
    alert('Hello! How it\'s going?');
  });

  // simulate/trigger a click event on there
  Event.simulate(btn, 'click');

});

Test

git clone https://github.com/ndaidong/realdom.git
cd realdom
npm install
npm test

License

The MIT License (MIT)