Typix LogoTypix
Core

Editor Config (legacy)

How v1's createEditorConfig maps to v2's useTypixEditor options

v1 page. v2 doesn't have a createEditorConfig function — the same fields are now passed directly as options to useTypixEditor. This page exists for v1 → v2 migration.

v1 → v2 mapping

In v1:

const config = createEditorConfig({
  extensionNodes: defaultExtensionNodes,
  theme: defaultTheme,
  namespace: "editor",
});

return <EditorRoot config={config}>{/* … */}</EditorRoot>;

In v2:

const editor = useTypixEditor({
  extensions: [StarterKit()],
  theme: defaultTheme,
  namespace: "editor",
});

return (
  <TypixEditorContext.Provider value={{ editor }}>
    <EditorContent editor={editor} />
  </TypixEditorContext.Provider>
);

Field-by-field

v1 (createEditorConfig)v2 (useTypixEditor options)
extensionNodes: defaultExtensionNodesextensions: [StarterKit()]
theme: defaultThemetheme: defaultTheme
namespace: "..."namespace: "..."
editable: trueeditable: true
(passed via <EditorRoot content={...}>)content: serialized
(passed via <EditorRoot onContentChange={...}>)onUpdate: ({ editor }) => ...
(passed via <EditorRoot onError={...}>)onError: (err) => ...

Where to find more

On this page