Zum Hauptinhalt springen

Anleitungen

Einbettung

Einbettung

Die Integration des Clepit-Editors oder -Renderers in jede Anwendung ist unkompliziert: ein DOM-Container ist der einzige Steuerungspunkt.

Den Editor einbinden

Geben Sie dem Container-Element eine id, rufen Sie `Editor.create({ containerId, ... })` auf, behalten Sie die zurückgegebene `EditorAPI` und rufen Sie beim Aufräumen `Editor.destroy(containerId)` auf.

TypeScript
import { Editor } from '@clepit/core';
import type { EditorAPI } from '@clepit/core';

// 1. Give your container a stable id
// <div id="my-editor"></div>

// 2. Create the editor and hold the returned API
const editor: EditorAPI = Editor.create({
  containerId: 'my-editor',
  minHeight: 400,
  placeholder: 'Start writing...',
  theme: 'auto',
  onChange: data => console.log(data),
  onReady: () => console.log('Editor ready'),
});

// 3. Extract content any time
const data = editor.data.extract();

// 4. Destroy on teardown (e.g. component unmount)
Editor.destroy('my-editor');

Ausgabe schreibgeschützt rendern

Rufen Sie `Renderer.render({ containerId, data })` auf. Das folgende Beispiel zeigt das echte React-Muster aus der `DocsRenderer`-Komponente: `useId` generiert eine eindeutige Container-id und `useEffect` löst das Rendering aus.

TSX
import { Renderer } from '@clepit/core';
import type { EditorData } from '@clepit/core';
import { useEffect, useId } from 'react';

type Props = { content: EditorData };

const ReadOnlyView = ({ content }: Props) => {
  // useId produces a stable, unique id per component instance
  const containerId = useId().replace(/[^a-z0-9]/gi, '');

  useEffect(() => {
    Renderer.render({
      containerId,
      data: content,
      margins: { bottom: 0, top: 0 },
    });
  }, [containerId, content]);

  return <div id={containerId} />;
};

Nur clientseitiges Rendering / SSR

Sowohl Editor als auch Renderer arbeiten auf dem DOM, daher laufen sie nur im Browser: verwenden Sie Effects (`useEffect`) oder die Direktive `'use client'`. Während des SSR funktionieren sie nicht.

Rufen Sie `Editor.create` oder `Renderer.render` nicht außerhalb von `useEffect` oder in einer Server-Komponente auf; dies führt zu einem "document is not defined"-Fehler.

Framework-unabhängig

Das Kernpaket @clepit/core ist reines TypeScript, keine React-Abhängigkeit. Ob Sie React, Vue, Svelte, Angular oder Vanilla-TS/JS verwenden, alle nutzen dieselbe API.