MarkdownEditor

Der MarkdownEditor ist eine Component zur Erstellung und Formatierung von Textinhalten mithilfe von Markdown-Syntax. Er unterstützt User bei der schnellen und konsistenten Textformatierung und stellt eine Vorschauansicht zur Verfügung.GitHubMarkdown

Grundlagen

Best Practices

Achte bei der Verwendung eines MarkdownEditors darauf, dass ...

  • die Höhe über das Property rows so gewählt ist, dass sie der erwarteten Textmenge des Users entspricht.
  • falls notwendig eine sinnvolle Zeichenbegrenzung definiert ist.
  • das Label prägnant und leicht verständlich ist.
  • die FieldDescription genutzt wird, um Beispiele, Formatierungshinweise oder Kontext bereitzustellen.
  • Fehlermeldungen klar, hilfreich und lösungsorientiert formuliert sind.

Custom Buttons

Custom Buttons ermöglichen es, spezielle Funktionen direkt in der Toolbar verfügbar zu machen. Diese sollten:

  • ein aussagekräftiges Icon haben, das die Funktion klar erklärt.
  • mit einem aussagekräftigen Label versehen sein (wird bei Hover angezeigt).
  • nur dann aktiv sein, wenn die Funktion sinnvoll ist (verwende isDisabled).
  • die aktuelle Text- und Cursor-Position berücksichtigen (über den MarkdownEditorCustomToolContext zugänglich).
  • die neue Cursor-Position sinnvoll setzen, damit der User direkt weiterarbeiten kann.

Verwendung

Verwende einen MarkdownEditor, um Usern die Möglichkeit zu geben, Texte wie Dokumentationen, Kommentare oder Beschreibungen mithilfe von Markdown-Syntax zu formatieren.

Auf dieser Seite