Variable TextEditorConst

Type Declaration

• engines: Record<string, TextEditorEngineConfig>

  Configuration for custom text editor engines.

• enrichers: TextEditorEnricherConfig[]

  A collection of custom enrichers that can be applied to text content, allowing for the matching and handling of custom patterns.

• inserts: ProseMirrorInsert[]

  A collection of custom ProseMirror inserts that the user may place in their ProseMirror documents.

  Example: Inserting a custom readaloud block at the cursor's position.

  CONFIG.TextEditor.inserts.push({
    action: "readaloud",
    title: "Readaloud",
    html: `
      <div class="readaloud">
        <strong>Title</strong>
        <blockquote>You awake to find yourself in a dark room.</blockquote>
      </div>
    `
  });
  Copy

  Example: Wrapping the selection in an inline span with a custom class.

  CONFIG.TextEditor.inserts.push({
    action: "lore-link",
    title: "Lore Link",
    inline: true,
    html: '<span class="lore"><selection></selection></span>'
  });
  Copy

  Example: Wrapping the selection in a block, with fallback content if there is no selection.

  CONFIG.TextEditor.inserts.push({
    action: "readaloud",
    title: "Readaloud",
    html: `
      <div class="readaloud">
        <selection>
        <strong>Title</strong>
        <blockquote>You awake to find yourself in a dark room.</blockquote>
        </selection>
      </div>
    `
  })
  Copy

  Example: Provide a group for several inserts.

  CONFIG.TextEditor.inserts.push({
    action: "my-inserts",
    title: "My Inserts",
    children: [{
      action: "lore-link",
      title: "Lore Link",
      inline: true,
      html: '<span class="lore"><selection></selection></span>'
    }, {
      action: "quest-link",
      title: "Quest Link",
      inline: true,
      html: '<span class="quest"><selection></selection></span>'
    }]
  })
  Copy