Lea Verou schreibt über das Design von HTML-APIs und wie wir bessere Dokumentationen für Webdesigner schreiben können. Eine HTML-API ist ein Begriff für eine JavaScript-Bibliothek, die über HTML konfiguriert und gesteuert wird und nicht über JavaScript. Zum Beispiel könnte <div data-open-modal="#modal"></div> einer Bibliothek mitteilen, dass dieses Element für das Öffnen eines Modals zuständig ist. Abgesehen vom Laden der Bibliothek selbst gibt es keine weitere Konfiguration oder Initialisierung.
Mein Lieblingsteil dieses Beitrags ist, wo Lea sich mit etwas auseinandersetzt, das allgemein als einfache Plug-n-Play-JavaScript-Bibliothek angesehen werden könnte
Selbst dieser winzige Codeausschnitt erfordert, dass Leute Objektliterale, Arrays, Variablen, Zeichenketten, wie man eine Referenz auf ein DOM-Element erhält, Ereignisse, wann das DOM bereit ist und vieles mehr verstehen. Dinge, die für Programmierer trivial erscheinen, können für HTML-Autoren ohne JavaScript-Kenntnisse ein harter Kampf sein
Indem wir Leuten eine HTML-API geben, können wir potenzielle Kopfschmerzen vermeiden.
…denken Sie daran, dass viele dieser Leute keine Programmiersprache sprechen, nicht nur JavaScript. Sprechen Sie nicht über Modelle, Ansichten, Controller oder andere Konzepte des Software-Engineerings in Texten, die sie lesen und verstehen sollen. Alles, was Sie erreichen werden, ist, sie zu verwirren und sie abzuschrecken.
Lea hat eine Sammlung von Bibliotheken erstellt, die HTML-APIs haben.