README.md

RenderJS

(Formerly known as PDRenderKit, renamed to RenderJS starting from version 2.0.0)

RenderJS is a lightweight tool focusing on extending JavaScript native object prototypes, providing powerful DOM manipulation and data processing methods. It minimizes repetitive code and enhances development efficiency.

Feature

• Simplified DOM Manipulation: Achieve complex DOM operations with concise chainable syntax.
• Enhanced Querying: Quickly retrieve elements with simplified selector syntax, supporting both single and multiple element selection.
• Built-in Extensions: Predefined prototype extensions accelerate development across various scenarios.
• Plug and Play: Seamlessly integrates with existing JavaScript projects and supports modern browsers.

Installation

• Install from npm

  npm i @pardnchiu/renderjs

• Or include via CDN

  <!-- Version 2.0.0 and above -->
  <script src="https://cdn.jsdelivr.net/npm/@pardnchiu/renderjs@[VERSION]/dist/RenderJS.js"></script>
  
  <!-- Version 1.5.2 and below -->
  <script src="https://cdn.jsdelivr.net/npm/pdrenderkit@[VERSION]/dist/PDRenderKit.js"></script>

Overview

Extension

• Before

  let section = document.createElement("section");
  section.id = "#test";
  document.body.appendChild(section);
  
  let button = document.createElement("button");
  button.style.width = "10rem";
  button.style.height = "2rem";
  button.style.backgroundColor = "steelblue";
  button.style.color = "fff";
  button.onclick = function(){
      alert("test")
  };
  button.innerHTML = "<span>test</span> button";
  section.appendChild(button);
  
  let svg = document.createElement("span");
  span.classList.add("svg");
  span.setAttribute("path", "https://xxxxxx");
  section.appendChild(span);
  
  let img = document.createElement("img");
  img.classList.add("lazyload");
  img.dataset.src = "https://xxxxxx";
  section.appendChild(img);
  
  let input = document.createElement("input");
  input.placeholder = "type";
  input.type = "email";
  section.appendChild(input);

• After

  document.body._child(
      "section#test"._([
          "button"._({
              style: {
                  width: "10rem",
                  hright: "2rem",
                  backgroundColor: "steelblue",
                  color: "#fff"
              }
          }, [
              // or "<span>test</span> button"
              "span"._("test"),
              " button"
          ])._click(function(){
              alert("test")
          }),
          "span.svg:._({ path: "https://xxxxxx" }),
          // No Lazy Loading => "img"._("https://xxxxxx"),
          "img"._({ lazyload: "https://xxxxxx" }),
          "input@email type"._()
      ])
  );
  
  _Listener({
      svg: true,     // Add SVGListener, convert span.svg to svg tag
      lazyload: true // Add Lazy Listener, Lazy Loading images
  });

• Get Element

  • Before

    document.getElementById("test");
    document.querySelector("div.test");
    document.querySelectorAll("div.test");
    document.querySelector("input[name='test']");

  • After

    "test".$;
    "div.test".$;
    "div.test".$all;
    "input[name='test']".$;

• Add Element

  • Before

    <div class="test" style="width: 5rem; height: 80px;" test="test">
        <button>
            <img src="https://xxxxxx">
        </button>
    </div>

  • After

    "div.test"._({
        style: {
            width: "5rem",
            height: 80,
        },
        test: "test"
    }, [
        "button"._([
            "img"._("https://xxxxxx")
        ])
    ]);

Simplified Frontend Framework

Note

RJS is a simplified frontend framework based on QuickUI, designed for specific projects

• Renders using non-vDOM technology, enhancing performance and reducing complexity.
• Removes automatic listening and updating, giving developers manual control over update processes.
• Introduces renew() function to support precise updates of data and events.

Attribute	Description
{{value}}	Inserts text into HTML tags and automatically updates with data changes.
:path	Used with the temp tag to load HTML fragments from external files into the current page.
:html	Replaces the element's innerHTML with text.
:for	Supports formats like item in items, (item, index) in items, (key, value) in object. Iterates over data collections to generate corresponding HTML elements.
:if :else-if :elif :else	Displays or hides elements based on specified conditions, enabling branching logic.
:model	Binds data to form elements (e.g., input), updating data automatically when input changes.
:[attr]	Sets element attributes, such as ID, class, image source, etc. Examples: :id/:class/:src/:alt/:href...
:[css]	Sets element CSS, such as margin, padding, etc. Examples: :background-color, :opacity, :margin, :top, :position...
@[event]	Adds event listeners that trigger specified actions upon activation. Examples: @click/@input/@mousedown...

• Initializing RJS

  const app = "(ComponentID)".RJS({
      data: {
          // Define data
      },
      event: {
          // Define events
      },
      when: {
          before_render: function () {
              // Executes before rendering (can stop rendering)
              // return false 
          },
          rendered: function () {
              // Executes after rendering
          }
      }
  });

• Updating RJS

  app.renew({
      // data: Only include data items to update; unmentioned items retain initial values.
      // event: Only include event items to update; unmentioned items retain initial values.
      // when: Only include lifecycle logic to update; unmentioned items retain initial logic.
  });

Creator

邱敬幃 Pardn Chiu

License

This source code project is licensed under the MIT license.

---

©️ 2022 邱敬幃 Pardn Chiu