Product Logo

Eigene Blöcke im Live-Editor

So machst du eine eigene React-Komponente im Live-Editor verfügbar. Sie erscheint im Blockmenü neben Callout und FAQ, und der Editor speichert sie als MDX in der Seite.

Als Beispiel dient eine Komponente Highlight, die einen Text hervorhebt.

Voraussetzungen

  • @document-writing-tools/kernux-theme ab Version 3.1.3
  • Ein Projekt im Developer Mode mit eingerichtetem Live-Editor, siehe Live-Editor einrichten
  • @blocknote/core und @blocknote/react in Version 0.56.0

Komponente anlegen

Lege die Komponente an, so wie sie auf der Webseite erscheinen soll, zum Beispiel in components/Highlight.tsx:

Komponente für alle Seiten registrieren

Trage die Komponente in die mdx-components.tsx ein. Damit kennt jede Seite <Highlight> ohne Import:

Block definieren

Beschreibe in components/HighlightBlock.tsx, wie der Editor den Block liest, anzeigt und speichert:

FeldAufgabe
blockTypeName des Blocks im Editor
fromMdxNodeLiest <Highlight> aus der Seite und macht daraus den Block
toMdxStringSchreibt den Block beim Speichern als MDX zurück
blockSpecZeigt den Block im Editor an. contentRef markiert den Text, den du bearbeitest. Das äußerste Element braucht w-full, sonst ist der Block im Editor nur so breit wie sein Inhalt
insertMenuItemEintrag im Blockmenü

Im Eintrag für das Blockmenü sind nur title und onItemClick Pflicht. Optional sind:

FeldAufgabe
subtextBeschreibung unter dem Titel
iconSymbol vor dem Titel, ein beliebiges React-Element, zum Beispiel aus lucide-react. Mit size-4 passt es zu den mitgelieferten Blöcken
groupAbschnitt im Menü, zum Beispiel Blocks neben Callout und FAQ
aliasesWeitere Suchwörter, unter denen der Block nach / erscheint

Block an den Editor übergeben

Übergib den Block in pages/preview.tsx an EditorShell:

Der Schlüssel Highlight ist der Name der Komponente in der MDX-Datei. Heißt er wie ein mitgelieferter Block, zum Beispiel Callout, ersetzt dein Block diesen.

Ergebnis prüfen

Öffne /preview/ und wähle eine Seite. Tippe in einer leeren Zeile / und wähle Highlight. Schreibe einen Text und klicke auf Save. In der Datei steht dann:

Block mit Einstellungsdialog

Manche Blöcke haben keinen Text zum Bearbeiten, sondern Felder. Der FAQ-Block zeigt dafür einen Stift-Button, der einen Dialog öffnet. Diesen Dialog nutzt du mit BlockSettings auch für eigene Blöcke.

Als Beispiel dient eine Kontaktkarte mit Name und E-Mail-Adresse. Lege die Komponente in components/ContactCard.tsx an:

Die Block-Definition in components/ContactCardBlock.tsx speichert die Felder als Props des Blocks. mdxAttribute liest ein Attribut aus der Seite, mdxAttributes schreibt die Attribute sicher zurück:

Das ist anders als beim Highlight-Block:

FeldAufgabe
content: 'none'Der Block hat keinen Text, den du direkt im Editor tippst
propSchemaDie Felder des Blocks mit ihren Startwerten
formattingToolbar: falseBlendet die Textformatierung für den Block aus
BlockSettingsStift-Button oben rechts im Block, der den Dialog mit den Feldern öffnet. Das umgebende Element braucht relative und w-full
editor.updateBlockÜbernimmt jede Eingabe sofort in den Block

Trage die Komponente wie oben in die mdx-components.tsx ein und ergänze den Block in pages/preview.tsx:

Nach dem Speichern steht in der Datei:

Nächste Schritte