Basic DOM helper

Basic DOM helper - A lightweight DOM helper.

This package provides methods for manipulating DOM objects programmatically. The methods condense sequences of commands common in DOM manipulation (such as creating then append elements). This makes the code that uses this package more readable, focusing on business rules.

Installation

Install the basic-dom-helper package:

npm i basic-dom-helper

Usage

This API is an abstract class with static methods for DOM manipulation. The methods uses multiple arguments merging common javascript commands for DOM manipulation with low overheading comparing with inline commands.

For javascript usage:

const $ = require('basic-dom-helper');

For typescript usage:

import $ from 'basic-dom-helper';

Examples

The example above show how to create a div element appending as child of parent with id 'div-id':

const div = $.create('div', parent, 'div-id');

The parent parameter can be a DOM element or id string of element.

The create method as shown in the previous example is equivalent to run the following three javascript commands:

const div = document.createElement('div');
content.append(div);
div.setAttribute('id', 'div-id');

If the create method is used in its complete call, it can assign the created tag to a parent referred to by id, also assigning the style class and element name.

const div = $.create('div', 'parent-id', 'div-id', 'div-style-class', 'div-name');

Being equivalent to:

const div = document.createElement('div');
document.getElementById('parent-id').append(div);
div.setAttribute('id', 'div-id');
div.setAttribute('class', 'div-style-class');
div.setAttribute('name', 'div-name');

License

MIT License

Copyright © 2016-2024 Sergio Lindau

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.