Zum Hauptinhalt springen

toolbar

Beschreibung

Optional. Aktiviert die Toolbar und erlaubt es, die darin angezeigten Schaltflächen anzugeben und zu konfigurieren

Verwendung

toolbar?: boolean | Array<string | { id: string, type: string, label?: string, tooltip?: string, css?: string, handler?: () => any }>;

Verfügbare Schaltflächen in der Toolbar

Sie können die folgenden Schaltflächen in der RichText-Toolbar angeben:

SchaltflächeBeschreibung
undoMacht die zuletzt ausgeführte Benutzeraktion rückgängig.
redoStellt die zuvor rückgängig gemachte Aktion wieder her.
styleErmöglicht die Auswahl von Textstilen (z. B. Überschriften, Absatz usw.).
font-familyÄndert die Schriftart des ausgewählten Texts.
font-sizePasst die Größe des ausgewählten Texts an.
boldWendet fette Formatierung auf den ausgewählten Text an.
italicWendet kursive Formatierung auf den ausgewählten Text an.
underlineUnterstreicht den ausgewählten Text.
strikeWendet eine Durchstreichung an.
subscriptFormatiert den Text als tiefgestellten Text.
superscriptFormatiert den Text als hochgestellten Text.
text-colorÄndert die Textfarbe.
background-colorÄndert die Hintergrundfarbe (Hervorhebungsfarbe) des Texts.
alignLegt die Textausrichtung fest (links, zentriert, rechts, Blocksatz).
indentErhöht den Einzug des Textblocks.
outdentVerringert den Absatzeinzug.
line-heightPasst den Zeilenabstand an.
quoteFormatiert den Text als Blockzitat.
bulleted-listSchaltet die Aufzählungsliste ein/aus
numbered-listSchaltet die nummerierte Liste ein/aus
linkFügt einen Hyperlink ein.
imageFügt ein Bild ein.
lineFügt eine horizontale Linie ein.
clearEntfernt alle Formatierungen des ausgewählten Texts.
printÖffnet den Druckdialog.
fullscreenSchaltet den Vollbildmodus um.
modeWechselt zwischen Layout-Modi (klassisch/Dokument)
shortcutsZeigt eine Liste der verfügbaren Tastaturkürzel an.
separatorFügt einen visuellen Trenner zwischen Toolbar-Gruppen ein.

Sie können diese Zeichenketten wie folgt zur Konfiguration der Toolbar-Schaltflächen verwenden:

new richtext.Richtext("#root", {
toolbar: [
"bold",
"italic",
"separator",
// weitere Schaltflächen
],
// weitere Konfigurationseigenschaften
});

Benutzerdefinierte Schaltflächen in der Toolbar

Sie können benutzerdefinierte Schaltflächen als Objekte mit folgenden Parametern angeben:

  • type - (erforderlich) gibt den benutzerdefinierten Steuerelementtyp an. Folgende Typen sind verfügbar: "button", "richselect", "colorpicker"
  • id - (optional) eine benutzerdefinierte Steuerelement-ID (darf nicht mit einer vorhandenen Steuerelement-ID übereinstimmen)
  • label - (optional) eine Schaltflächenbeschriftung (wird mit einem Symbol kombiniert)
  • tooltip - (optional) ein Tooltip, der beim Hover angezeigt wird (falls nicht angegeben, wird der Wert aus „label" verwendet)
  • css - (optional) ein CSS-Klassenname, der dem Steuerelement zugewiesen wird (unterstützte Standardklassen: wx-primary, wx-secondary)
  • handler - (optional) eine Callback-Funktion, die beim Klicken auf die Schaltfläche ausgeführt wird
new richtext.Richtext("#root", {
toolbar: [
// Schaltflächen (Zeichenketten repräsentieren nur Schaltflächen)
"bold",
"italic",
// vordefinierte Schaltflächen (der Benutzer kann keine weiteren Optionen für diese festlegen (keine Beschriftungen, Tooltips, Optionen usw.), daher nur ({ type: "button", id: string })
{
type: "button",
id: "fullscreen",
},
// der Benutzer muss den richtigen Typ angeben, wenn er ein vordefiniertes Steuerelement verwenden möchte (z. B. richselect/colorpicker)
// nicht übereinstimmende Typen werden ignoriert (nicht zur Toolbar hinzugefügt)
{
type: "richselect", // type: "button" - falsch, wird ignoriert
id: "mode",
},
// benutzerdefinierte Schaltflächen (unterstützte Optionen sind unten aufgeführt)
// der Benutzer kann nur benutzerdefinierte Schaltflächen definieren (derzeit keine Unterstützung für richselect/colorpicker)
{
type: "button",
id: "some",
label: "Some",
handler: () => {/* benutzerdefinierte Logik */}
},
{
type: "button",
id: "other",
icon: "wxo-help",
label: "Other",
tooltip: "Some tooltip",
handler: () => {/* benutzerdefinierte Logik */}
}
],
// weitere Konfigurationseigenschaften
});

Toolbar ausblenden

Wenn Sie die Toolbar ausblenden möchten, setzen Sie die Eigenschaft toolbar wie folgt auf false:

new richtext.Richtext("#root", {
toolbar: false
// weitere Konfigurationseigenschaften
});

Standardkonfiguration

const defaultToolbarButtons = {
"undo",
"redo",
"separator",
"style",
"separator",
"font-family",
"font-size",
"separator",
"bold",
"italic",
"underline",
"strike",
"separator",
"text-color",
"background-color",
"separator",
"align",
"line-height",
"outdent",
"indent",
"separator",
"bulleted-list",
"numbered-list",
"quote",
"separator",
"link",
"image",
"separator",
"clear",
"separator",
"fullscreen",
"mode"
};
Tipp

Die Standard-Toolbar-Steuerelemente werden vom RichText-Widget exportiert und sind über richtext.defaultToolbarButtons zugänglich.

// RichText initialisieren
new richtext.Richtext("#root", {
toolbar: [
...richtext.defaultToolbarButtons,
{
type: "button",
id: "btn1", // Schaltflächen-ID (darf nicht mit vorhandenen Schaltflächen-IDs übereinstimmen, wenn Sie benutzerdefinierte Logik anwenden möchten)
icon: "wxo-help", // Schaltflächensymbol (wird mit der Beschriftung kombiniert)
css: "rounded", // CSS-Klassenname, der dem Steuerelement zugewiesen wird (unterstützte Standardklassen: wx-primary, wx-secondary)
label: "Custom button", // Schaltflächenbeschriftung (wird mit dem Symbol kombiniert)
tooltip: "Some tooltip", // Tooltip, der beim Hover angezeigt wird (falls nicht angegeben, wird der Wert aus „label" verwendet)
}
]
// weitere Konfigurationseigenschaften
});

Beispiel

// RichText initialisieren
new richtext.Richtext("#root", {
toolbar: [
"bold",
"italic",
"separator",
// benutzerdefinierte Schaltflächen (alle unterstützten Optionen werden unten verwendet)
// der Benutzer kann nur benutzerdefinierte Schaltflächen definieren (derzeit keine Unterstützung für richselect/colorpicker)
{
type: "button",
id: "btn1", // Schaltflächen-ID (darf nicht mit vorhandenen Schaltflächen-IDs übereinstimmen, wenn Sie benutzerdefinierte Logik anwenden möchten)
icon: "wxo-help", // Schaltflächensymbol (wird mit der Beschriftung kombiniert)
css: "rounded", // CSS-Klassenname, der dem Steuerelement zugewiesen wird (unterstützte Standardklassen: wx-primary, wx-secondary)
label: "Custom button", // Schaltflächenbeschriftung (wird mit dem Symbol kombiniert)
tooltip: "Some tooltip", // Tooltip, der beim Hover angezeigt wird (falls nicht angegeben, wird der Wert aus „label" verwendet)
handler: () => ..., // benutzerdefinierte Logik für diese Schaltfläche
}
]
// weitere Konfigurationseigenschaften
});

Änderungsprotokoll: Die Eigenschaft wurde in v2.0 hinzugefügt

Verwandte Artikel: Konfiguration

Verwandtes Beispiel: RichText. Benutzerdefiniertes Steuerelement und vereinfachte Toolbar