minor
#29497
React-UI-Tooltips: Abgeschnittene Tabellenzellen und Spaltenüberschriften, kompakte Symbolleisten-Schaltflächen und Attributbeschreibungen erhalten Tooltips; native Titelattribute werden durch Bridge-Tooltips ersetzt
Wurde über die „Consulting“-Anwendung in Version 8.0.0-alpha7 (React-View-Benutzeroberfläche, Issue #94) gemeldet und anschließend auf das Tooltip-Verhalten der gesamten React-Benutzeroberfläche ausgeweitet.
Umfang
In der React-Benutzeroberfläche (Ebene „.view.xml“, tl-react-bridge, die React-Steuerelemente) wird Text, den der Benutzer an der vorgesehenen Stelle nicht lesen kann, nicht als Tooltip angeboten, und die Beschreibungen von Modellelementen (#29484) werden nicht an der Stelle angezeigt, an der sich ihre Beschriftungen befinden. Nach diesem Ticket:
- Eine Tabellenzelle, deren Wert am Spaltenrand abgeschnitten ist, zeigt den vollständigen Wert als Tooltip beim Darüberfahren mit der Maus an; eine Zelle, deren Wert passt, zeigt nichts an. Dasselbe gilt für eine Spaltenüberschrift, deren Beschriftung abgeschnitten ist.
- Eine Symbolleiste, deren Schaltflächen auf ihre Symbole reduziert wurden (Kompaktmodus), zeigt die Beschriftung einer Schaltfläche als Tooltip an.
- Die Beschreibung eines Modellattributs ist der Tooltip der Beschriftung des zugehörigen Formularfelds (im Ansichts- und im Bearbeitungsmodus; das per Klick zu öffnende Hilfe-Symbol bleibt bestehen, siehe #29491) sowie der Spaltenüberschrift in einer Tabelle.
- Jeder Tooltip der React-Steuerelemente sieht gleich aus und verhält sich gleich: Die Schaltflächen von Panels, Fenstern, der Seitenleiste, Wertelisten, Formulargruppen, der WYSIWYG-Symbolleiste und jedes andere reines Symbol-Steuerelement verwenden den Tooltip der Bridge anstelle des nativen Titel-Tooltips des Browsers (oder einer privaten Tooltip-Bibliothek), der seine eigene Verzögerung und sein eigenes Aussehen hat und bei Berührung keine Reaktion zeigt.
- Kein Tabellen-Hover kommuniziert mehr mit dem Server: Tabellen-Tooltips werden auf dem Client anhand des bereits im DOM vorhandenen Textes ermittelt.
Ergebnisse
- Tabellenzellen (der ursprüngliche Bericht unten): Die Tabelle fragt bei jedem Hover den Server nach einem Tooltip ab (data-tooltip="dynamic" → /react-api/tooltip), und TableViewControl#getTooltipContent gibt nur CellContent.Labeled zurück; eine Spalte über einem Modellattribut rendert CellContent.Raw, daher ist die Antwort immer null. Der vollständige Wert befindet sich bereits im DOM – nur das CSS schneidet ihn ab (.tlTableView__cell > span { text-overflow: ellipsis }), sodass im Fall der Abschneidung keine Interaktion mit dem Server erforderlich ist.
- Schaltflächen nur mit Symbol: TLButton verwendet seine Beschriftung nur dann als Tooltip, wenn sein eigener displayMode auf „icon-only“ gesetzt ist. Der Kompaktmodus der Symbolleiste blendet die Beschriftungen allein per CSS aus (.tlToolbar--compact … .tlReactButton__label { display: none }), sodass eine ausgeblendete Schaltfläche keinen Tooltip hat.
- Attributbeschreibungen: AttributeFieldControl liest die Beschreibung des Attributs (TLModelI18N-Schlüssel, .tooltip) und übergibt sie als Hilfetext an das Feld-Chrome, das durch das „?“-Klick-Umschaltelement angezeigt wird; die Beschriftung selbst hat keinen Tooltip. Der eigene Tooltip-Slot der Beschriftung (ReactFormFieldChromeControl#setTooltip) wird ausschließlich vom View-Designer verwendet. Eine Tabellenspaltenüberschrift enthält überhaupt keinen Tooltip. Daher gibt es nirgendwo in der React-Benutzeroberfläche eine Beschreibung als Tooltip, obwohl in #29484 Formulare und Tabellenüberschriften als Orte genannt werden, an denen sie erscheinen.
- Native „title“-Attribute an etwa 70 Stellen der React-Steuerelemente, ein privater Radix-Tooltip in der WYSIWYG-Symbolleiste sowie weitere reine Symbol-Steuerelemente (Farb- und Symbolfelder, Auswahl löschen, Hilfe-Symbol, Schubladen-Umschalter, Baum-Chevrons) mit einem barrierefreien Namen, aber überhaupt keinem Tooltip.
- Steckengebliebene Tooltips: Der Tooltip-Host brach das anstehende Schließen ab, sobald der Mauszeiger ein Element unter einer Tooltip-Deklaration berührte, und eine leere Auflösung (die Null-Antwort der Tabelle) wurde stillschweigend zurückgegeben – ein auf einer Symbolleisten-Schaltfläche geöffneter Tooltip blieb unbegrenzt auf dem Bildschirm, sobald der Mauszeiger in eine Tabellenzelle sprang.
Lösung
Ein Grundsatz: Ein Text, den der Benutzer an der vorgesehenen Stelle nicht lesen kann, wird als Tooltip angeboten, der auf dem Client festgelegt wird; eine Beschreibung wird dort angeboten, wo sich die Beschriftung befindet.
- Bridge (tl-react-bridge, tooltip-host.ts): ein Tooltip-Modus „data-tooltip=“content““, dessen Tooltip der eigene Text des Elements ist, und eine Bedingung „data-tooltip-when=“truncated““, der auf dem „data-tooltip“-Element oder auf einem beliebigen Element zwischen diesem und dem Element, über dem der Mauszeiger schwebt, gelesen wird: Der Tooltip wird nur angezeigt, solange der Text dieses Elements nicht vollständig lesbar ist – das Element oder ein Nachkomme ist abgeschnitten (scrollWidth > clientWidth) oder ein texttragender Nachkomme ist ausgeblendet. Eine Deklaration, deren Bedingung nicht erfüllt ist, liefert nichts (kein Fall-Through zu einer übergeordneten Deklaration). Beide lassen sich mit den bestehenden Modi (text:, html:, key:, dynamic) kombinieren. Die Konstanten TOOLTIP_ATTR, TOOLTIP_WHEN_ATTR, WHEN_TRUNCATED, die Hilfsfunktion tooltipProps(text) und das Paar TOOLTIP_WHEN_CLIPPED werden an die Steuerelemente exportiert. Ein Hover, dessen Auflösung nichts liefert – oder vom Server leer zurückkommt –, schließt nun den geöffneten Tooltip, wie es ein Element ohne Tooltip tut.
- Tabelle: Jede Body-Zelle enthält Inhalt + gekürzte Darstellung (in der Baumspalte auf dem Wert-Wrapper .tlTableView__treeValue, sodass das Erweitern-Symbol und die Gruppengröße außerhalb des Textes bleiben); eine Zelle mit einem eigenen Tooltip enthält stattdessen data-tooltip="text:…". Die Überschriftenbezeichnung enthält die Spaltenbeschreibung, sofern vorhanden, andernfalls ihren eigenen Text unter der abgeschnittenen Bedingung. CellContent erhält den Standard-String-Tooltip() (beschriftet über seine Record-Komponente; Raw erhält eine Tooltip- Komponente, wobei der Konstruktor mit einem einzigen Argument beibehalten wird); TableViewControl sendet die eigenständigen Tooltips pro Zeile unter „Tooltips“ und die Beschreibung des Label-Schlüssels jeder Spalte (ResKey#tooltipOptional()) unter dem Tooltip der Spalte. Die „TooltipProvider “-Implementierung und die dynamische Auflösung wurden entfernt; die 12 nativen Titel der Tabelle sind Bridge-Tooltips. Test: „TestTableTooltips“.
- Schaltflächen: Ein expliziter Tooltip hat Vorrang; im reinen Symbolmodus ist die Beschriftung der Tooltip; in jedem anderen Modus ist die Beschriftung unter der Bedingung der Kürzung der Tooltip, sodass eine kompakte Symbolleiste – oder jedes Stylesheet, das die Beschriftung ausblendet – diesen liefert.
- Beschreibungen: „ReactFormFieldChromeControl“ erhält einen Tooltip als Klartext-Beschriftung (setTooltipText, state tooltipText, kein Roundtrip; ein „rich setTooltip“ hat weiterhin Vorrang), den „AttributeFieldControl“ in jedem Modus mit der Beschreibung des Attributs füllt; das Hilfe-Symbol bleibt erhalten. Test: TestFormFieldTooltips.
- Umfassende Überprüfung: Alle nativen Titelattribute der React-Steuerelemente (mit Ausnahme von iframe-Titeln) sind Bridge-Tooltips, wobei „aria-label“ hinzugefügt wird, wenn der Titel der einzige barrierefreie Name war; Steuerelemente, die nur über ein Symbol verfügen und bisher lediglich ein „aria-label“ hatten, bieten dieses nun ebenfalls als Tooltip an; der Radix-Tooltip der WYSIWYG-Symbolleiste und seine Abhängigkeit werden zugunsten der Bridge entfernt; die fest codierten englischen Bezeichnungen „Help“/`Expand`/`Collapse` des Hilfe-Symbols und der Baum-Chevrons sind nun i18n-Schlüssel (js.formField.help, js.treeView.expand, js.treeView.collapse).
Ursprünglicher Bericht
Was passiert
Die Tabelle fordert bei jedem Mauszeiger-Hover einen Zell-Tooltip an, und der Server kann niemals antworten, sodass keine Tabellenzelle in einer auf <table> basierenden Anwendung mit Spalten im Modellattribut jemals einen Tooltip haben kann.
Die Client-Seite ist vollständig implementiert. TableViewControl rendert seinen Container mit `data-tooltip="dynamic"`, und tl-react-bridge ermittelt das Element, über dem der Mauszeiger schwebt, entlang der Vorfahrenkette, löst `tl-tooltip-resolve` aus, und der tabelleninterne Handler antwortet mit `row_<index>|<column>`. Dieser Schlüssel wird an /react-api/tooltip gesendet.
Die Serverseite gibt ihn dann ab:
// TableViewControl#getTooltipContent
CellContent content = _view.cell(single.get(0), key.substring(separator + 1));
if (content instanceof CellContent.Labeled labeled
&& labeled.tooltip() != null && !labeled.tooltip().isEmpty()) {
return new TooltipContent(labeled.tooltip(), null);
}
return null;
Es wird nur `CellContent.Labeled ` berücksichtigt. Eine an ein Modellattribut gebundene Spalte erzeugt jedoch niemals ein solches – `ColumnProviderService#displayContent` gibt `CellContent.Raw` zurück, das das schreibgeschützte Feld des Attributs umschließt:
public static CellContent displayContent(TLStructuredTypePart part, Object value) {
if (part == null) {
return CellContent.text(label(value));
}
return new CellContent.Raw((CellControlFactory) context -> FieldControlService.getInstance()
.createDisplayControl(context, part, value));
}
RowSetTableControl verhält sich sowohl bei seinen bearbeitbaren als auch bei seinen schreibgeschützten Zellen genauso. Im Normalfall – also bei einem deklarativen `<table>` über Geschäftsobjekten – ist das Ergebnis also stets `null`, und jeder Mauszeiger-Hover verursacht einen Hin- und Rückweg, der nichts bewirkt.
Dies spielt vor allem dann eine Rolle, wenn der Text abgeschnitten ist. Zellen sind einzeilig; ein langer Wert endet mit drei Punkten, und der Rest ist nur durch Öffnen der Zeile erreichbar. In unserer Kundentabelle enthält die Spalte „//Address//“ einen Ansprechpartner, eine Straße, eine Stadt und eine Telefonnummer, von denen etwa die Hälfte sichtbar ist.
Vorgeschlagene Lösung
Drei kleine, aufeinander aufbauende Schritte:
- CellContent erhält einen Standard-String-Tooltip() { return null; }. Labeled erfüllt diese Anforderung bereits durch seine gleichnamige Record-Komponente; Raw erhält eine Tooltip-Komponente, wobei die bestehende Form mit einem einzigen Argument beibehalten wird.
- TableViewControl#getTooltipContent liest content.tooltip() anstelle einer Prüfung auf „Labeled“ – die Methode wird kürzer, und jede „CellContent“-Variante kann nun einen Tooltip enthalten.
- ColumnProviderService#displayContent (und die entsprechende Stelle in RowSetTableControl) übergibt label(value) als diesen Tooltip. Der dynamische Pfad funktioniert dann für jede Modellattribut-Spalte in jeder Anwendung, ohne dass eine anwendungsspezifische Konfiguration erforderlich ist.
Separater Wunsch: Nur anzeigen, wenn der Text tatsächlich abgeschnitten ist
Mit dem oben Gesagten würde eine Zelle, deren Text passt, einen Tooltip anzeigen, der das wiederholt, was bereits auf dem Bildschirm zu sehen ist. Was dafür fehlt, ist eine Möglichkeit, den Tooltip davon abhängig zu machen, dass der Anker überläuft – ein Opt-in-Attribut, das an derselben Stelle ausgelesen wird, an der „data-tooltip“ ausgewertet wird, z. B.:
data-tooltip-when="overflow" // nur anzeigen, solange anchor.scrollWidth > anchor.clientWidth
Das ist genau das eine Element, das eine Anwendung derzeit nicht ausdrücken kann, und es ist das, was Zell-Tooltips erträglich macht, anstatt dass sie störend wirken. Es würde auch für Spaltenüberschriften gelten, die auf dieselbe Weise abgeschnitten werden.
Verwendete Abhilfe
Ein clientseitiges Skript (consulting-cell-tooltip.js, ~40 Zeilen) misst die mit der Maus angezeigte Zelle und setzt „data-tooltip="text:<vollständiger Wert>"“ darauf, wenn der Text überläuft, und entfernt es wieder, wenn dies nicht der Fall ist. Es nutzt den framework-eigenen „text: “-Modus, sodass das Popover, seine Platzierung, „role=“tooltip““, die Escape-Taste und das Drücken außerhalb des Bereichs alle von tl-react-bridge stammen – nichts wird neu implementiert.
Der Listener muss in der Capture-Phase auf dem Fenster angesiedelt sein: Das Framework registriert `document.addEventListener("pointerover", ..., true)`, und die Capture-Phase wird vom Fenster nach unten weitergegeben, sodass dies die einzige Position ist, an der garantiert ist, dass das Attribut gesetzt wurde, bevor das Framework es ausliest. Die Zelle hat Vorrang vor der Dynamik des Containers, da die Auflösung vom Element, über dem der Mauszeiger schwebt, nach außen verläuft.
Im Browser überprüft: Von zwölf Zellen erhalten die beiden abgeschnittenen Adressen das Popover mit dem vollständigen Wert, die zehn, die passen, erhalten keines. Die Datei wird gelöscht, sobald dieses Ticket veröffentlicht wird.
Verwandte Themen
- #29491 – Gleicher Bereich: Der Hilfetext des Formularfelds sollte ein verankertes Overlay sein.
- #29487 – FormElement.Config verfügt nicht über „max-columns “ / „label-position“.
- #29475 – keine konfigurierbare Spaltenbreite bei <table>.
- #29484 – Beschreibungen der Modellelemente als Tooltips; das Ticket liefert die Texte, dieses hier die technische Umsetzung für die Zellen.