API-Übersicht

RichText-Konstruktor

new richtext.RichText("#root", {
    // Konfigurationsparameter
});

Parameter:

• ein HTML-Container (z. B. CSS-Selektor oder DOM-Element)
• ein Konfigurationsobjekt (siehe Eigenschaften)

RichText-Methoden

Name	Beschreibung
getValue()	Gibt den Wert des RichText zurück
setValue()	Wendet einen neuen Wert auf RichText an
insertValue()	Fügt Text, Markdown oder HTML-Inhalt an der aktuellen Cursorposition ein oder ersetzt den markierten Text
setConfig()	Wendet neue Konfigurationsparameter auf RichText an
setLocale()	Wendet ein neues Gebietsschema auf RichText an
destructor()	Entfernt alle HTML-Elemente von RichText und trennt alle zugehörigen Events

Event-Bus-Methoden

Name	Beschreibung
api.exec()	Ermöglicht das Auslösen interner Events
api.intercept()	Ermöglicht das Abfangen und Verhindern interner Events
api.on()	Ermöglicht das Anbinden eines Handlers an interne Events
api.detach()	Ermöglicht das Entfernen/Trennen von Event-Handlern
api.setNext()	Ermöglicht das Hinzufügen einer Aktion in die Event-Bus-Reihenfolge

State-Methoden

Name	Beschreibung
api.getState()	Gibt ein Objekt mit den StateStore-Eigenschaften von RichText zurück
api.getReactiveState()	Gibt ein Objekt mit den reaktiven Eigenschaften von RichText zurück

Events

Name	Beschreibung
align	Wird ausgelöst, wenn die Textausrichtung über die Menüleiste/Toolbar oder Event-Bus-Methoden geändert wird
clear-text-format	Wird ausgelöst, wenn eine Textformatierung über die Menüleiste/Symbolleiste oder Event-Bus-Methoden aufgehoben wird
copy	Wird ausgelöst, wenn ausgewählter Text kopiert wird
create-new	Wird ausgelöst, wenn die Option „Neu" in der Menüleiste oder über Event-Bus-Methoden aufgerufen wird
cut	Wird ausgelöst, wenn ausgewählter Text ausgeschnitten wird
delete-link	Wird ausgelöst, wenn ein Link gelöscht wird
export	Wird ausgelöst, nachdem die Option „Export" in der Menüleiste oder über Event-Bus-Methoden aufgerufen wurde
import	Wird ausgelöst, nachdem die Option "Import" in der Menüleiste oder über Event-Bus-Methoden aufgerufen wird
indent	Wird ausgelöst, wenn der Block-Einzug erhöht wird
insert-image	Wird ausgelöst, wenn ein Bild eingefügt wird (über die Toolbar, die Menüleiste, die Zwischenablage oder Drag-and-Drop)
insert-line	Wird ausgelöst, wenn eine horizontale Linie eingefügt wird
insert-link	Wird ausgelöst, wenn ein Link eingefügt wird
insert-list	Wird beim Einfügen einer Liste ausgelöst
outdent	Wird ausgelöst, wenn der Block-Einzug verringert wird
paste	Wird ausgelöst, wenn Inhalt eingefügt wird
print	Wird beim Drucken des Dokuments ausgelöst
redo	Wird ausgelöst, wenn die Schaltfläche „Redo" in der Menüleiste/Toolbar gedrückt oder über Event-Bus-Methoden aufgerufen wird
resize-image	Wird ausgelöst, wenn ein Bild in der Größe geändert wird
set-font-family	Wird ausgelöst, wenn eine Schriftfamilie gesetzt wird
set-font-size	Wird ausgelöst, wenn eine Schriftgröße festgelegt wird
set-line-height	Wird ausgelöst, wenn eine Zeilenhöhe gesetzt wird
set-text-color	Wird ausgelöst, wenn eine Textfarbe und/oder eine Texthintergrundfarbe gesetzt wird
set-text-format	Wird ausgelöst, wenn ein Textformat gesetzt wird
set-text-style	Wird ausgelöst, wenn ein Textstil gesetzt wird
show-popup	Wird ausgelöst, wenn ein Popup angezeigt oder ausgeblendet wird
subscript	Wird ausgelöst, wenn die Schaltfläche „Subscript" in der Menüleiste/Toolbar oder über Event-Bus-Methoden gedrückt wird
superscript	Wird ausgelöst, wenn die Schaltfläche „Hochgestellt" in der Menüleiste/Toolbar oder über Event-Bus-Methoden gedrückt wird
toggle-fullscreen-mode	Wird ausgelöst, wenn der Vollbildmodus umgeschaltet wird
toggle-layout-mode	Wird ausgelöst, wenn der Layout-Modus umgeschaltet wird
toggle-shortcut-info	Wird ausgelöst, wenn die Shortcut-Info ein- oder ausgeblendet wird
undo	Wird ausgelöst, wenn die Schaltfläche „Undo" in der Menüleiste/Toolbar gedrückt oder über Event-Bus-Methoden aufgerufen wird
update-link	Wird ausgelöst, wenn ein Link aktualisiert wird

Eigenschaften

Name	Beschreibung
defaultStyles	Optional. Legt Standard-Stilwerte für bestimmte Block-Typen fest
fullscreenMode	Optional. Aktiviert den Vollbildmodus von RichText
imageUploadUrl	Optional. Gibt die URL an, die für den Bild-Upload verwendet wird (über Toolbar, Menüleiste, Zwischenablage-Einfügen oder Drag-and-Drop)
layoutMode	Optional. Legt den Layout-Modus für den Haupteditorbereich fest
locale	Optional. Ein Objekt, das Lokalisierungsbeschriftungen von RichText enthält
menubar	Optional. Aktiviert die obere Menüleiste von RichText
toolbar	Optional. Aktiviert die Toolbar und erlaubt es, die darin angezeigten Schaltflächen anzugeben und zu konfigurieren
value	Optional. Legt den Anfangswert (Inhalt) fest, der im Editorbereich von RichText angezeigt wird