SimplyBuilderCore - Main Modules

Welcome to SimplyBuilder's Core JavaScript Modules - a collection of three powerful modules designed to streamline web development by simplifying DOM manipulation, event handling, and integrating these functionalities into a cohesive system. These modules are EventModule, DomModule, and CoreModule.

static example on StackBlitz without event

static example on StackBliz with event

🤖 Documented by Artificial Intelligence

This project takes a leap into the future of code documentation and maintenance. 🚀
All text commits, Readme details and JSDoc comments were created automatically by the advanced AI of ChatGPT, showcasing a seamless integration between human creativity and artificial intelligence.

By leveraging ChatGPT's capabilities, we've ensured that the documentation is not only comprehensive but also up-to-date with the latest standards. This collaboration marks a step forward in our pursuit of innovative solutions, making our codebase more accessible and easier to understand for developers worldwide.

Embrace the future of coding with us. 🌟

Modules Overview

1. EventModule

The EventModule provides an intuitive API for event management. It allows you to register, unregister, and handle custom events efficiently, making your application's event handling cleaner and more manageable.

Key Features:

• Register and unregister custom events.
• Simplified event listener management.
• Supports custom event actions.

2. DomModule

The DomModule focuses on DOM manipulation, offering functionalities to create, query, and manage HTML and SVG elements seamlessly. It's designed to work with both vanilla JavaScript and modern frontend frameworks.

Key Features:

• Efficient creation and management of HTML and SVG elements.
• Support for shadow DOM operations.
• Internal registry for querying and managing elements.

3. CoreModule

The CoreModule combines the EventModule and DomModule, providing a unified interface for managing both DOM elements and their events. This module streamlines the process of creating interactive web applications by integrating element creation and event handling into a single, coherent API.

Key Features:

• Unified API for DOM manipulation and event handling.
• Simplifies the process of creating and managing interactive elements.
• Leverages the capabilities of both EventModule and DomModule.

Installation

These modules are designed to be modular, allowing you to use them independently or together based on your project's needs. You can install each module using npm, pnpm, or yarn.

For EventModule:

npm install @jamilservices/sb-core-event-module

For DomModule:

npm install @jamilservices/sb-core-dom-module

For CoreModule (includes both EventModule and DomModule):

npm install @jamilservices/sb-core-module

ESM Import Module

CDN:

You can use the following CDN links to include the module:

For EventModule:

https://cdn.skypack.dev/@jamilservices/sb-core-event-module@latest/lib/main.min.js

https://cdn.jsdelivr.net/npm/@jamilservices/sb-core-event-module@latest/lib/main.min.js

https://unpkg.com/@jamilservices/sb-core-event-module@latest/lib/main.min.js

For DomModule:

https://cdn.skypack.dev/@jamilservices/sb-core-dom-module@latest/lib/main.min.js

https://cdn.jsdelivr.net/npm/@jamilservices/sb-core-dom-module@latest/lib/main.min.js

https://unpkg.com/@jamilservices/sb-core-dom-module@latest/lib/main.min.js

For CoreModule (includes both EventModule and DomModule):

https://cdn.skypack.dev/@jamilservices/sb-core-module@latest/lib/main.min.js

https://cdn.jsdelivr.net/npm/@jamilservices/sb-core-module@latest/lib/main.min.js

https://unpkg.com/@jamilservices/sb-core-module@latest/lib/main.min.js

Contribution Guidelines

Interested in contributing? We value your contributions and would love to see your input. Please follow our guidelines for contributing to ensure a smooth collaboration process.

• For contributing to Core Module, please see the Core Module Guidelines.
• For contributing to Dom Module, please see the Dom Module Guidelines.
• For contributing to Event Module, please see the Event Module Guidelines.

License

SimplyBuilderCore is available under the MIT License by @jamilservicos.

• You are free to modify and reuse the code.
• The original license must be included with copies of this software.
• We encourage linking back to this repository if you use a significant portion of the source code.