Dollie Editor SDK guide

Verify Installation

Confirm that rendering, editing, and serialization work before adding a backend.

Verify the local editing loop before connecting authentication, persistence, or AI.

Installation checklist

  • The editor opens without an import or stylesheet error.
  • The section library contains the expected catalog components.
  • You can add, select, reorder, duplicate, and remove a section.
  • Editable fields update the preview.
  • Undo and redo restore the expected state.
  • Viewport controls change the canvas preview.
  • serializeEditorState(editor.state) returns a valid PageConfig.
  • The same definition renders with SectionRenderer.
  • Refreshing the page resets only the in-memory example, not your application.

Inspect the installed catalog

Run:

npx dollie-editor info

Use JSON output when a coding agent or script needs the result:

npx dollie-editor info --json

This is the reliable way to inspect the component ids and catalog capabilities available in the current installation.

Test a known page

Start with one known component:

{
  "sections": [
    {
      "component": "free-hero-split"
    }
  ]
}

If it does not render, check that:

  1. freeCatalog is included in createCatalog;
  2. freeSectionDefinitions is passed to the runtime;
  3. both package stylesheets are imported;
  4. the installed catalog actually reports that id.

Once this loop works, connect Persistence.