kolibri icon indicating copy to clipboard operation
kolibri copied to clipboard

Event-Nutzung durch Anpassung der Benennung vereinfachen?

Open sdvg opened this issue 9 months ago • 0 comments

Note

  • [x] Ich achte beim Erstellen des Issues darauf, dass ich keine fachlichen und unternehmensinternen Details preisgebe.

Events, die von KoliBri-Komponenten emitted werden, sind zur Zeit mit kol- geprefixt. Die Kebab-Case-Schreibweise verhindert eine einfache Nutzung z.B. in React mit der onKolEventName-Syntax.

Stattdessen müssen zur Zeit etwas umständlich addEventListener und removeEventListener mit einer ref auf die Komponente angesprochen werden.

Vorschlag: Änderung zu camelCase, mglw. Entfernung des Prefix.

kol-changekolChangechange - Auf Prefix ganz verzichten.

  • Aus meiner Sicht kein Breaking Change, da es bisher ein nicht dokumentiertes Feature ist.
  • in Version 2 bleiben beide Event-Schreibweisen, also mit kol- und wir zukünftig ohne Prefix
  • in v2 bleibt kol-* noch erhalten
  • für v3 Ticket, damit kol-* entfernt wird
  • Priorität leitet sich von den Vorteilen der Nachnutzbarkeit ab. Es ist einfacher für die Teams diese, wie gewohnt, Events zu nutzen

sdvg avatar Apr 30 '24 07:04 sdvg