Divider Node Type – contenteditable.lab

Schema Definition

Schema definition for the Divider node type:

{
  divider: {
    group: 'block',
    attrs: {
      style: { default: 'solid' }
    },
  }
}

Model Representation

Example model representation:

{
  type: 'divider',
  attrs: { style: 'solid' }
}

HTML Serialization

Converting model to HTML:

function serializeDivider(node) {
  return '<div data-type="divider" data-style="' + node.attrs.style + '"></div>';
}

HTML Deserialization

Parsing HTML to model:

function parseDivider(domNode) {
  return {
    type: 'divider',
    attrs: { style: domNode.getAttribute('data-style') || 'solid' }
  };
}

View Integration

View Integration Notes: Pay special attention to contenteditable behavior, selection handling, and event management when implementing this node type in your view layer.

View integration code:

// Rendering divider
const divider = document.createElement('div');
divider.setAttribute('data-type', 'divider');
divider.setAttribute('data-style', node.attrs.style);
divider.className = 'divider';
divider.contentEditable = 'false'; // Dividers are typically not editable

Common Issues

Common Pitfalls: These are issues frequently encountered when implementing this node type. Review carefully before implementation.

Common issues and solutions:

// Issue: Divider styling
// Solution: Apply consistent styles
function styleDivider(divider, style) {
  divider.className = 'divider divider-' + style;
  divider.style.borderTop = '1px solid #ccc';
  divider.style.margin = '1em 0';
}

// Issue: Divider selection
// Solution: Handle divider selection
function selectDivider(divider) {
  const range = document.createRange();
  range.setStartBefore(divider);
  range.setEndAfter(divider);
  const selection = window.getSelection();
  selection.removeAllRanges();
  selection.addRange(range);
}

Implementation

Complete implementation example:

class DividerNode {
  constructor(attrs) {
    this.type = 'divider';
    this.attrs = { style: attrs?.style || 'solid' };
  }
  
  toDOM() {
    const divider = document.createElement('div');
    divider.setAttribute('data-type', 'divider');
    divider.setAttribute('data-style', this.attrs.style);
    divider.className = 'divider';
    return divider;
  }
  
  static fromDOM(domNode) {
    return new DividerNode({
      style: domNode.getAttribute('data-style') || 'solid'
    });
  }
}