Flows (technical)

Save and load diagrams. Editor guide: Editor guide.

Data model

mxEditorJs uses Canonical JSON + HTML snapshot:

• JSON (Editor.js OutputData): source of truth in sidecar tables
• HTML: site snapshot in modResource.content or TV textarea

Loading resource form

1. Plugin on OnDocFormPrerender loads CSS/JS and fills window.mxEditorJsConfig
2. MODx.loadRTE initializes Editor.js on #ta (main content) and on textarea.modx-richtext except #ta (TVs)
3. content/get reads JSON from sidecar
4. If JSON is empty for main content: HTML migration offer (content/migrate, dry_run)

Save via MODX form (primary path)

The form writes HTML to the resource or TV, JSON to the sidecar. Connector content/save is not called.

1. Client (syncToTextarea, 500 ms delay):
   • HTML → textarea (client renderPreviewHtml)
   • JSON → hidden mxeditorjs_json / mxeditorjs_tv_{id}_json
2. hookBeforeSubmit flushes JSON to hidden fields
3. Form POST → MODX saves HTML to resource/TV
4. OnBeforeDocFormSave → ContentRepository / TvContentRepository.save(JSON)
5. If SHA-256 of JSON is unchanged, sidecar is not rewritten. Otherwise content_version increments. Empty blocks: [] updates the sidecar (clearing the editor wipes JSON).

Server HtmlRenderer is not called on this path. The client builds HTML in the textarea.

Save via connector

POST content/save + content_json:

1. ContentValidator
2. HtmlRenderer → HTML
3. Write sidecar
4. For main content: update modResource.content

Use for AJAX or custom integrations. TVs do not update modResource.content via connector.

HTML → Editor.js migration

1. Dialog when opening a resource without sidecar but with HTML
2. content/migrate?dry_run=1: block preview
3. Confirm → HtmlMigrator.convert() → sidecar + HtmlRenderer → modResource.content
4. force, confirmed: overwrite existing sidecar

Supported: p, h1–h6, ul/ol, blockquote, img, table, pre/code, hr. Not migrated: embed, gallery, attaches, checklist.

Media

Action	Connector	Settings
Image / gallery upload	media/upload	image_mediasource, image_upload_path
Attachment upload	media/uploadFile	file_mediasource, file_upload_path
Folder browse	media/browse	type=image or type=file

Resource delete

OnResourceDelete removes rows in mxeditorjs_content and related mxeditorjs_tv_content.

Plugin and events

Event	Purpose
OnRichTextEditorRegister	Register mxEditorJs in RTE list
OnTVInputRenderList	Path to elements/tv/input/ (migxmxeditorjs handler) when mxeditorjs.enabled
OnDocFormPrerender	Config, assets, init
OnBeforeDocFormSave	Save JSON to sidecar
OnResourceDelete	Clean sidecar