Rich-Text-Editor (Input/Rte)
- Dominik Hisler
Mit dem Eingabefeld Input/Rte wird eine Integration des CKEditor 5 in brandbox angeboten. Der CKEditor erlaubt die Textaufbereitung mithilfe von HTML-Formatierungen.
Funktionsumfang
Jedes Rich-Text-Editor-Eingabefeld kann mit einem anderen Funktionsumfang ausgestattet werden. Dabei kann entweder ein vordefinierter Funktionsumfang oder eine Liste an Funktionen übergeben werden. In der Strukturmodellierung wird die Funktionsliste angeboten. In den Strukturdefinitionen kann der Integrator zwischen den vordefinierten Umfängen oder der Funktionsliste entscheiden.
In den Strukturdefinitionen muss die Konfiguration mithilfe der Eigenschaft capabilities definiert werden.
{
"identifier": "[Feldidentifikator]",
"type": "rte",
"configuration": {
"capabilities": "..."
}
}Vordefinierte Funktionsumfänge
Die vordefinierten Funktionsumfänge werden mit einem Identifikator in der Konfiguration hinterlegt. Die nachfolgenden Umfänge stehen zur Verfügung.
Identifikator | Beschreibung |
|---|---|
| Stellt dem Anwender den gesamten Funktionsumfang von CKEditor zur Verfügung. |
| Stellt alle Textformatierungen zur Verfügung, verzichtet allerdings auf Schriftformatierungen (Farbe, Schriftart, etc.). |
| Stellt nur die Pflege von Codesegmenten zur Verfügung. |
| Stellt den kleinsten Funktionsumfang für grundlegende Textformatierung zur Verfügung. |
| Stellt den Standardumfang an Textformatierungen zur Verfügung und wird als Standard genutzt, wenn kein Umfang definiert wurde. |
Funktionsliste
Die Funktionsliste wird in der Feldkonfiguration als Array definiert. Jedes Element listet dabei die entsprechende Funktion auf. Die folgenden Funktionen und Funktionspakete stehen zur Verfügung.
Identifikator | Beschreibung |
|---|---|
| Stellt Schaltflächen zum Zurücksetzen und Wiederherstellen von Änderungen zur Verfügung. |
| Erlaubt das Hoch- bzw. Tiefstellen von Textabschnitten. |
| Stellt die Basisformatierungen für Texte bereit (Fett, Kursiv, Unterstrichen, Durchgestrichen). |
| Stellt Textformatierungen für Quellcodeblöcke bereit. |
| Erlaubt das Ein- bzw. Ausrücken von Textabschnitten. |
| Erlaubt die Erstellung von nummerierten oder Strichlisten. |
| Erlaubt Schriftformatierungen wie Farbe, Schriftart und Schriftgröße. |
| Erlaubt die Erstellung von Tabellen. |
| Erlaubt die horizontale Ausrichtung von Text. |
| Stellt Überschriftformatierungen zur Verfügung. |
| Erlaubt das Erstellen von Verlinkungen. |
| Stellt einen Dialog für Sonderzeichen zur Verfügung. |
| Erlaubt das Entfernen von angewendeten Formatierungen. |
| Stellt eine Schaltfläche zur Ansicht des Inhaltsquellcodes bereit. |