Coralite DOM Structure

Coralite uses a server-side DOM structure that mimics the standard browser DOM but is optimized for static site generation. This DOM is exposed to developers when writing plugins, specifically in lifecycle hooks like onPageSet and when processing slots in templates.

While the underlying structure is compatible with domhandler, Coralite enhances these nodes with a standard DOM-like API (getters and setters) to make manipulation more intuitive.

Node Types #

The Coralite DOM consists of several node types, all inheriting from a base node structure:

CoraliteElement (Type 1): Represents HTML tags (e.g., <div>, <span>).
CoraliteTextNode (Type 3): Represents text content.
CoraliteComment (Type 8): Represents HTML comments.
CoraliteDocumentRoot (Type 9): The root node of a document.
CoraliteDirective (Type 10): Directives like <!DOCTYPE html>.

CoraliteElement API #

Elements are the most common nodes you will interact with. They are standard objects enhanced with the following properties:

Property	Type	Access	Description
`tagName`	`string`	Read/Write	The uppercase tag name of the element (e.g., "DIV"). Setting it updates `name` (lowercase).
`nodeName`	`string`	Read-only	Same as `tagName`.
`attributes`	`Object`	Read/Write	Key-value pair of attributes. Alias for `attribs`.
`childNodes`	`Array`	Read/Write	Live collection (array) of child nodes. Alias for `children`.
`parentNode`	`Node`	Read/Write	The parent node of this element. Alias for `parent`.
`textContent`	`string`	Read/Write	Getting returns concatenated text of all descendants. Setting replaces all children with a single text node.
`id`	`string`	Read/Write	Convenience accessor for the `id` attribute.
`className`	`string`	Read/Write	Convenience accessor for the `class` attribute.
`firstChild`	`Node\|null`	Read-only	The first child node.
`lastChild`	`Node\|null`	Read-only	The last child node.
`previousSibling`	`Node\|null`	Read-only	The node immediately preceding this one.
`nextSibling`	`Node\|null`	Read-only	The node immediately following this one.

CoraliteTextNode API #

Text nodes represent the text content within elements.

Property	Type	Access	Description
`data`	`string`	Read/Write	The actual text content.
`nodeValue`	`string`	Read/Write	Alias for `data`.
`textContent`	`string`	Read/Write	Alias for `data`.
`parentNode`	`Node`	Read/Write	The parent node.

Traversing the DOM #

You can traverse the DOM tree using the relationship properties defined above.

  // Example: Walking the tree
  function walk(node) {
    console.log(node.nodeName);
    
    if (node.childNodes) {
      node.childNodes.forEach(child => walk(child));
    }
  }
  
  // Example: Finding a sibling
  if (element.nextSibling) {
    console.log('Next element is:', element.nextSibling.tagName);
  }

Manipulating the DOM #

Since Coralite nodes are JavaScript objects, you can manipulate them directly. However, for adding or removing nodes, you interact with the childNodes (or children) array.

Changing Content #

  // Change text content
  element.textContent = "New text content";
  
  // Change an attribute
  element.attributes.class = "active";
  // element.setAttribute('data-id', '123'); // Error: setAttribute is not a function
  
  // Use the attributes object (or its alias attribs) directly:
  element.attributes['data-id'] = '123';

Adding/Removing Children #

Coralite does not implement methods like appendChild, removeChild or setAttribute. Instead, use standard Array methods on childNodes and direct access to attributes.

  // Append a child
  parent.childNodes.push(newElement);
  
  // Remove a child
  const index = parent.childNodes.indexOf(childToRemove);
  if (index > -1) {
    parent.childNodes.splice(index, 1);
  }
  
  // Insert before
  parent.childNodes.splice(index, 0, newElement);

Creating Nodes #

To create new nodes that are correctly enhanced with the Coralite API, use the helper functions exported by the coralite package.

Note: These functions automatically append the new node to the parent's children array if a parent is provided.

  import { createElement, createTextNode } from 'coralite';
  
  // Create a new DIV attached to parent
  const newDiv = createElement({
    name: 'div',
    attributes: { class: 'container' },
    parent: parentElement
  });
  
  // Create a text node attached to the new DIV
  createTextNode('Hello World', newDiv);

createElement Options #

name (string): The tag name (e.g., 'div').
attributes (object): Key-value pairs of attributes.
parent (Node): The parent node to attach to.

Usage in Plugins #

You will encounter the Coralite DOM in several places when developing plugins.

Page-Level Plugins #

In hooks like onPageSet, you receive the full document tree.

  // coralite.config.js
  createPlugin({
    name: 'my-plugin',
    onPageSet: async (context) => {
      const root = context.elements.root;
      // Traverse root.childNodes to find and modify elements
    }
  })

Modifying Slots #

When using defineComponent, the slots property allows you to intercept and modify slot content. The content is passed as an array of DOM nodes.

  // component.html script
  export default defineComponent({
    slots: {
      default: (slotNodes, values) => {
        // slotNodes is an Array