Callouts #62

Closed
opened 2026-11-04 08:58:35 +01:00 by miko · 2 comments
Owner

Wir nutzen ein Editor.js Tool namens "Warnung". Dessen Icon ist während der bearbeitung im Dark Mode Schwarz und schwer zu erkennen.

Wir sollten aus diesem Tool ein generisches "Callout" Tool machen, in welchem es die üblichen Abstufungen "Warnung", "Fehler", "Hinweis", und "Erfolg" gibt, die beim Rendern dann mit den entsprechenden Farben hinterlegt und einem passenden icon versehen werden.

Beim editieren sollte das icon dann in der entsprechenden farbe angezeigt werden.

Wir nutzen ein Editor.js Tool namens "Warnung". Dessen Icon ist während der bearbeitung im Dark Mode Schwarz und schwer zu erkennen. Wir sollten aus diesem Tool ein generisches "Callout" Tool machen, in welchem es die üblichen Abstufungen "Warnung", "Fehler", "Hinweis", und "Erfolg" gibt, die beim Rendern dann mit den entsprechenden Farben hinterlegt und einem passenden icon versehen werden. Beim editieren sollte das icon dann in der entsprechenden farbe angezeigt werden.
Author
Owner

Spezifikation (aus Grilling-Session)

Ziel: Das @editorjs/warning-Tool wird durch ein eigenes, generisches Callout-Tool mit vier Abstufungen ersetzt. Behebt nebenbei das schwarze, im Dark Mode kaum erkennbare Icon.

Entscheidungen

  1. Eigenes Tool unter src/richText/calloutTool.ts (analog inlineCodeTool); @editorjs/warning wird aus den Abhängigkeiten entfernt.
  2. Blocktyp/Datenform: type: "callout", data: {variant, title, message} mit variant ∈ warning | error | note | success.
  3. Bestandsdaten: Keine Migration. parseRichText liest alte warning-Blöcke dauerhaft als callout mit variant: "warning"; toEditorJson gibt immer callout aus, beim nächsten Speichern wird also umgeschrieben. Ungültige/fehlende variant → note.
  4. Genau vier Abstufungen: Warnung, Fehler, Hinweis, Erfolg.
  5. Titel (optional) + Nachricht bleiben, jeweils mit dem Inline-Subset (fett, kursiv, Link, Inline-Code). plainText für die Suche unverändert (Titel + Nachricht).
  6. Auswahl der Abstufung über das Block-Einstellungsmenü (renderSettings), je Stufe Icon + Label (übersetzt via Lingui).
  7. Standard beim Einfügen: Hinweis (note).
  8. Neue semantische Tokens --success und --info (Light + Dark) gemäß ADR-0010. Zuordnung: Warnung → warning, Fehler → danger, Hinweis → info, Erfolg → success. Bewusst nicht die Akzentfarbe (frei wählbar, ADR-0012).
  9. Icons (Lucide): Warnung TriangleAlert, Fehler CircleX, Hinweis Info, Erfolg CircleCheck.
  10. Rendering: Icon links in Stufenfarbe, Rahmen in Stufenfarbe, dezent getönter Hintergrund per color-mix (~10 % Stufenfarbe), Titel fett, Nachricht darunter.
  11. Editor: Gleiche Darstellung wie gerendert; Wechsel der Stufe aktualisiert sofort. Toolbox-Icon nutzt currentColor (Dark-Mode-lesbar).
  12. Domain-Doku: „Callout“ ins GLOSSARY.md (Avoid: Warning box, Alert, Admonition); ADR-0005 Blockliste warning → callout inkl. Notiz zum Weiterlesen alter warning-Blöcke. Kein neues ADR.

Akzeptanzkriterien

  • Bestehende warning-Blöcke werden korrekt gelesen und als Warnung dargestellt.
  • Alle vier Stufen sind in Light und Dark Mode korrekt eingefärbt (Icon, Rahmen, Hintergrund) – im Editor wie im Rendering.
  • Stufenwechsel im Editor aktualisiert die Darstellung sofort.
  • Tests für parseRichText/toEditorJson decken callout (alle Stufen, ungültige Stufe) und Legacy-warning ab.
  • @editorjs/warning ist entfernt; Übersetzungen (de/en) ergänzt.
  • CHANGELOG: Changed „Warnungen sind jetzt Callouts mit vier Stufen“, Fixed „Icon im Dark Mode lesbar“.
  • GLOSSARY.md und ADR-0005 aktualisiert.
## Spezifikation (aus Grilling-Session) **Ziel:** Das `@editorjs/warning`-Tool wird durch ein eigenes, generisches **Callout**-Tool mit vier Abstufungen ersetzt. Behebt nebenbei das schwarze, im Dark Mode kaum erkennbare Icon. ### Entscheidungen 1. **Eigenes Tool** unter `src/richText/calloutTool.ts` (analog `inlineCodeTool`); `@editorjs/warning` wird aus den Abhängigkeiten entfernt. 2. **Blocktyp/Datenform:** `type: "callout"`, `data: {variant, title, message}` mit `variant ∈ warning | error | note | success`. 3. **Bestandsdaten:** Keine Migration. `parseRichText` liest alte `warning`-Blöcke dauerhaft als `callout` mit `variant: "warning"`; `toEditorJson` gibt immer `callout` aus, beim nächsten Speichern wird also umgeschrieben. Ungültige/fehlende `variant` → `note`. 4. **Genau vier Abstufungen:** Warnung, Fehler, Hinweis, Erfolg. 5. **Titel (optional) + Nachricht** bleiben, jeweils mit dem Inline-Subset (fett, kursiv, Link, Inline-Code). `plainText` für die Suche unverändert (Titel + Nachricht). 6. **Auswahl der Abstufung** über das Block-Einstellungsmenü (`renderSettings`), je Stufe Icon + Label (übersetzt via Lingui). 7. **Standard** beim Einfügen: Hinweis (`note`). 8. **Neue semantische Tokens** `--success` und `--info` (Light + Dark) gemäß ADR-0010. Zuordnung: Warnung → `warning`, Fehler → `danger`, Hinweis → `info`, Erfolg → `success`. Bewusst nicht die Akzentfarbe (frei wählbar, ADR-0012). 9. **Icons (Lucide):** Warnung `TriangleAlert`, Fehler `CircleX`, Hinweis `Info`, Erfolg `CircleCheck`. 10. **Rendering:** Icon links in Stufenfarbe, Rahmen in Stufenfarbe, dezent getönter Hintergrund per `color-mix` (~10 % Stufenfarbe), Titel fett, Nachricht darunter. 11. **Editor:** Gleiche Darstellung wie gerendert; Wechsel der Stufe aktualisiert sofort. Toolbox-Icon nutzt `currentColor` (Dark-Mode-lesbar). 12. **Domain-Doku:** „Callout“ ins `GLOSSARY.md` (_Avoid_: Warning box, Alert, Admonition); ADR-0005 Blockliste `warning` → `callout` inkl. Notiz zum Weiterlesen alter `warning`-Blöcke. Kein neues ADR. ### Akzeptanzkriterien - [ ] Bestehende `warning`-Blöcke werden korrekt gelesen und als Warnung dargestellt. - [ ] Alle vier Stufen sind in Light und Dark Mode korrekt eingefärbt (Icon, Rahmen, Hintergrund) – im Editor wie im Rendering. - [ ] Stufenwechsel im Editor aktualisiert die Darstellung sofort. - [ ] Tests für `parseRichText`/`toEditorJson` decken `callout` (alle Stufen, ungültige Stufe) und Legacy-`warning` ab. - [ ] `@editorjs/warning` ist entfernt; Übersetzungen (de/en) ergänzt. - [ ] CHANGELOG: _Changed_ „Warnungen sind jetzt Callouts mit vier Stufen“, _Fixed_ „Icon im Dark Mode lesbar“. - [ ] GLOSSARY.md und ADR-0005 aktualisiert.
Author
Owner

Umgesetzt in #63 (feature/62-callouts → development).

Umgesetzt in #63 (feature/62-callouts → development).
miko closed this issue 2026-11-04 09:26:25 +01:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
MassiveDynamic/kataba#62
No description provided.