Skip to content

Latest commit

 

History

History
146 lines (115 loc) · 4.43 KB

README.md

File metadata and controls

146 lines (115 loc) · 4.43 KB
Raw

Dominar from KPVERSE

Dominar is a powerful library designed to make it easy for developers to manipulate the Document Object Model (DOM) and create dynamic HTML content. Dominar empowers you to take control of your web development projects like a pro. Unleash the power to dominate the DOM with Dominar.

Demo

Visit https://kpverse.in/dominar/ and click on "✨ See live preview" button to see a to-do app built using Dominar.

Installation

npm (scoped) npm bundle size (scoped) npm jsDelivr hits (npm scoped)

To install Dominar using npm, run the following command:

npm i @patelka2211/dominar

Alternatively, you can include Dominar's IIFE file in your website using a <script> tag:

<script src="https://cdn.jsdelivr.net/gh/patelka2211/[email protected]/Dominar.js"></script>

Examples

Here are some examples of how you can use Dominar:

When using as a npm package.

import {
    addEventListeners,
    render,
    setAttributes,
    tag,
    tagList,
} from "@patelka2211/dominar";

// DominarTagList Object
let tagListObject = tagList(
    "Text before button",
    tag("button", {
        children: "Click this button",
        eventListeners: {
            click: () => {
                alert("Button clicked");
            },
        },
    }),
    "Text after button"
);

// DominarTag Object
let tagObject = tag("div", {
    attributes: {
        id: "div-1",
    },
    children: tagListObject,
});

// Example of Dominar's render function
render(document.body, tagObject, {
    clearBeforeRender: false,
    insertType: "prepend",
});

// Example of Dominar's setAttributes function
setAttributes(document.body, {
    class: "class1 class2 class3",
    style: "background-color: azure;",
});

// Example of Dominar's addEventListeners function
addEventListeners(document.body, {
    keydown: (ev) => {
        console.log(`Key "${ev.key}" pressed`);
    },
});

When included as a <script> tag in a website.

If the script tag is not already included in the <head> tag, please add the following script tag to include Dominar's IIFE JavaScript file.

<script src="https://cdn.jsdelivr.net/gh/patelka2211/[email protected]/Dominar.js"></script>
<script>
    // DominarTagList Object
    let tagListObject = Dominar.tagList(
        "Text before button",
        Dominar.tag("button", {
            children: "Click this button",
            eventListeners: {
                click: () => {
                    alert("Button clicked");
                },
            },
        }),
        "Text after button"
    );

    // DominarTag Object
    let tagObject = Dominar.tag("div", {
        attributes: {
            id: "div-1",
        },
        children: tagListObject,
    });

    // Example of Dominar's render function
    Dominar.render(document.body, tagObject, {
        clearBeforeRender: false,
        insertType: "prepend",
    });

    // Example of Dominar's setAttributes function
    Dominar.setAttributes(document.body, {
        class: "class1 class2 class3",
        style: "background-color: azure;",
    });

    // Example of Dominar's addEventListeners function
    Dominar.addEventListeners(document.body, {
        keydown: (ev) => {
            console.log(`Key "${ev.key}" pressed`);
        },
    });
</script>

License

NPM

This project is licensed under the MIT License, which permits you to use, copy, modify, merge, publish, distribute, and sublicense the software, subject to the conditions stated in the LICENSE file.