Columns in Pages #68

Closed
opened 2026-11-04 09:52:29 +01:00 by miko · 1 comment
Owner

Blocked by: #64, #67

Aus #64 ausgelagert: Admins können Inhalte einer Page in Columns anordnen, also in 2 oder 3 gleich breiten Spalten nebeneinander.

Verhalten

  • Ein Columns-Block hat 2 oder 3 gleich breite Spalten, alle oben ausgerichtet. Andere Aufteilungen und vertikale Ausrichtung gibt es nicht.
  • Columns gibt es nur im Page-Editor.
  • Eine Spalte darf alle Page-Blöcke enthalten: Absatz, Überschrift, Liste, Code, Zitat, Callout, Tabelle und Bild. Weitere Columns sind darin nicht erlaubt, es gibt also keine Verschachtelung.
  • Spaltenzahl ändern: Über das Block-Tune-Menü schaltet man zwischen 2 und 3 Spalten um. Beim Wechsel von 3 auf 2 werden die Blöcke der dritten Spalte ans Ende der zweiten gehängt, damit nichts verloren geht.
  • Löschen: Der ganze Block wird über das normale Löschen in Editor.js entfernt.
  • Darstellung: Ab md stehen die Spalten nebeneinander, im Editor wie in der gerenderten Page. Darunter werden sie in ihrer Reihenfolge von links nach rechts gestapelt. Im Editor hat jede Spalte einen dezenten Rahmen.

Technischer Ansatz

Ein eigenes Editor.js-Tool mit einem verschachtelten Editor pro Spalte. Die Begründung steht in ADR 0016: Das Plugin @calumk/editorjs-columns ist Beta, setzt innerHTML und hat bekannte Fehler, und Marker-Blöcke würden die Spalten im Editor nicht nebeneinander zeigen.

  • Format: {type: "columns", data: {cols: [{blocks: [...]}, ...]}}. Jede Spalte enthält nur ihre blocks, ohne time und version.
  • Parser (src/richText/document.ts): Er prüft die Blöcke jeder Spalte rekursiv gegen dieselbe Allow-List, ohne columns.
  • plainText und toEditorJson arbeiten ebenfalls rekursiv, dadurch findet die Suche auch Text in Spalten.
  • Renderer (src/richText/RichText.tsx): Er bekommt einen columns-Fall, der die Spalten als responsives Raster ausgibt.
  • Tool-Konfiguration: Eine gemeinsame Fabrik in src/richText/ baut sie. Hauptfenster und jede Spalte bekommen ein eigenes Objekt daraus, gegen zirkuläre Referenzen. Die Spalten erhalten dieselben Tools und i18n-Strings wie der Page-Editor, nur ohne columns.
  • DOM: Das Tool baut HTML nur über DOM-APIs auf, nie über innerHTML.
  • Tastatur und Zwischenablage: Tastatur-, paste-, copy- und cut-Ereignisse werden an der Spaltengrenze gestoppt.
    • Enter erzeugt einen neuen Block in derselben Spalte.
    • Tab wirkt nur in der Spalte.
    • Aus einer Spalte heraus kommt man per Maus oder über die Pfeiltasten am Anfang oder Ende der Spalte.
  • Bilder (#67): Die Suche nach referenzierten PageImages läuft rekursiv durch die Spalten, damit Bilder in Spalten beim Speichern nicht als verwaist gelöscht werden.

Bekannte Grenze

  • Undo wirkt nur innerhalb des jeweiligen Editors, also in einer Spalte oder im Hauptfenster. Ein gemeinsames Undo über beide gibt es nicht.

Doku

  • ADR 0016 (eigenes Tool mit verschachtelten Editoren, rekursives Format als Erweiterung von ADR 0005)
  • Glossar-Eintrag Columns

Akzeptanzkriterien

  • Ein Admin kann im Page-Editor einen Columns-Block mit 2 oder 3 Spalten einfügen, befüllen und zwischen 2 und 3 umschalten. Beim Wechsel von 3 auf 2 geht kein Inhalt verloren.
  • In anderen Editoren (Guide, Step, Category) gibt es Columns nicht. Innerhalb einer Spalte gibt es keine weiteren Columns.
  • Der Parser hat Round-Trip-Tests für Columns. Unzulässige Blöcke und verschachtelte Columns werden verworfen.
  • Die gerenderte Page zeigt die Spalten ab md nebeneinander und darunter gestapelt.
  • Die Suche findet Text in Spalten.
  • Bilder in Spalten überleben das Speichern. Aus einer Spalte entfernte Bilder werden aufgeräumt (Test).
  • Die Tool-Beschriftungen sind in den Spalten übersetzt.
  • Playwright-E2E-Tests:
    • Enter bleibt in der Spalte.
    • Tab wirkt nicht im Hauptfenster.
    • Einfügen landet nur in der Spalte, ohne Duplikate.
  • Vor dem Merge testest du von Hand im Browser.
Blocked by: #64, #67 Aus #64 ausgelagert: Admins können Inhalte einer Page in **Columns** anordnen, also in 2 oder 3 gleich breiten Spalten nebeneinander. ## Verhalten - Ein Columns-Block hat **2 oder 3 gleich breite Spalten**, alle oben ausgerichtet. Andere Aufteilungen und vertikale Ausrichtung gibt es nicht. - Columns gibt es **nur im Page-Editor**. - Eine Spalte darf alle Page-Blöcke enthalten: Absatz, Überschrift, Liste, Code, Zitat, Callout, Tabelle und Bild. Weitere Columns sind darin **nicht** erlaubt, es gibt also keine Verschachtelung. - **Spaltenzahl ändern:** Über das Block-Tune-Menü schaltet man zwischen 2 und 3 Spalten um. Beim Wechsel von 3 auf 2 werden die Blöcke der dritten Spalte ans Ende der zweiten gehängt, damit nichts verloren geht. - **Löschen:** Der ganze Block wird über das normale Löschen in Editor.js entfernt. - **Darstellung:** Ab `md` stehen die Spalten nebeneinander, im Editor wie in der gerenderten Page. Darunter werden sie in ihrer Reihenfolge von links nach rechts gestapelt. Im Editor hat jede Spalte einen dezenten Rahmen. ## Technischer Ansatz Ein eigenes Editor.js-Tool mit **einem verschachtelten Editor pro Spalte**. Die Begründung steht in ADR 0016: Das Plugin `@calumk/editorjs-columns` ist Beta, setzt `innerHTML` und hat bekannte Fehler, und Marker-Blöcke würden die Spalten im Editor nicht nebeneinander zeigen. - **Format:** `{type: "columns", data: {cols: [{blocks: [...]}, ...]}}`. Jede Spalte enthält nur ihre `blocks`, ohne `time` und `version`. - **Parser** (`src/richText/document.ts`): Er prüft die Blöcke jeder Spalte rekursiv gegen dieselbe Allow-List, ohne `columns`. - **`plainText` und `toEditorJson`** arbeiten ebenfalls rekursiv, dadurch findet die Suche auch Text in Spalten. - **Renderer** (`src/richText/RichText.tsx`): Er bekommt einen `columns`-Fall, der die Spalten als responsives Raster ausgibt. - **Tool-Konfiguration:** Eine gemeinsame Fabrik in `src/richText/` baut sie. Hauptfenster und jede Spalte bekommen ein eigenes Objekt daraus, gegen zirkuläre Referenzen. Die Spalten erhalten dieselben Tools und i18n-Strings wie der Page-Editor, nur ohne `columns`. - **DOM:** Das Tool baut HTML nur über DOM-APIs auf, nie über `innerHTML`. - **Tastatur und Zwischenablage:** Tastatur-, `paste`-, `copy`- und `cut`-Ereignisse werden an der Spaltengrenze gestoppt. - Enter erzeugt einen neuen Block in derselben Spalte. - Tab wirkt nur in der Spalte. - Aus einer Spalte heraus kommt man per Maus oder über die Pfeiltasten am Anfang oder Ende der Spalte. - **Bilder** (#67): Die Suche nach referenzierten `PageImage`s läuft rekursiv durch die Spalten, damit Bilder in Spalten beim Speichern nicht als verwaist gelöscht werden. ## Bekannte Grenze - Undo wirkt nur innerhalb des jeweiligen Editors, also in einer Spalte oder im Hauptfenster. Ein gemeinsames Undo über beide gibt es nicht. ## Doku - ADR 0016 (eigenes Tool mit verschachtelten Editoren, rekursives Format als Erweiterung von ADR 0005) - Glossar-Eintrag **Columns** ## Akzeptanzkriterien - [ ] Ein Admin kann im Page-Editor einen Columns-Block mit 2 oder 3 Spalten einfügen, befüllen und zwischen 2 und 3 umschalten. Beim Wechsel von 3 auf 2 geht kein Inhalt verloren. - [ ] In anderen Editoren (Guide, Step, Category) gibt es Columns nicht. Innerhalb einer Spalte gibt es keine weiteren Columns. - [ ] Der Parser hat Round-Trip-Tests für Columns. Unzulässige Blöcke und verschachtelte Columns werden verworfen. - [ ] Die gerenderte Page zeigt die Spalten ab `md` nebeneinander und darunter gestapelt. - [ ] Die Suche findet Text in Spalten. - [ ] Bilder in Spalten überleben das Speichern. Aus einer Spalte entfernte Bilder werden aufgeräumt (Test). - [ ] Die Tool-Beschriftungen sind in den Spalten übersetzt. - [ ] Playwright-E2E-Tests: - Enter bleibt in der Spalte. - Tab wirkt nicht im Hauptfenster. - Einfügen landet nur in der Spalte, ohne Duplikate. - [ ] Vor dem Merge testest du von Hand im Browser.
miko changed title from Layout-Spalten in Pages to Columns in Pages 2026-11-04 10:09:34 +01:00
Author
Owner

Umgesetzt in PR #74 (feature/68-columns → development): Columns-Block mit 2/3 Spalten im Page-Editor, rekursives Format (ADR 0016), Suche und Bilder in Spalten; dazu Page-Inhalt und Editor in voller Breite.

Umgesetzt in PR #74 (feature/68-columns → development): Columns-Block mit 2/3 Spalten im Page-Editor, rekursives Format (ADR 0016), Suche und Bilder in Spalten; dazu Page-Inhalt und Editor in voller Breite.
miko closed this issue 2026-11-04 12:47:20 +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.

Depends on
#64 Pages (Inhaltsseiten)
MassiveDynamic/kataba
#67 Bild-Block in Pages
MassiveDynamic/kataba
Reference
MassiveDynamic/kataba#68
No description provided.