JavaScript/Tutorials/DOM/Einbindung in HTML
Text-Info
- 10-15min
- einfach
- Kenntnisse in
● HTML
● JavaScript
JavaScript ist eine Programmiersprache, die als Zusatztechnik in Webseiten eingebunden wird. Im modernen Webdesign erhalten Webseiten so neben der Inhaltsstruktur und dem Aussehen eine Verhaltensschicht.
DOM-Scripting (Unobtrusive JavaScript)
JavaScript kommt in diesem Konzept die Aufgabe zu, dem Dokument »Verhalten« (Behaviour) hinzuzufügen. Damit ist gemeint, dass das Dokument auf gewisse Anwenderereignisse reagiert und z. B. Änderungen im Dokument vornimmt. Diese Interaktivität wird dem Dokument automatisch hinzugefügt – im HTML-Code sollte sich kein JavaScript in Form von Event-Handler-Attributen befinden (onload, onclick, onmouseover usw.). Im Idealfall steht im <head>-Element das ein oder andere <script>-Element, um eine externe JavaScript-Datei einzubinden, die dann ihrerseits aktiv wird und die Eventhandler an die jeweiligen Elemente anbringt. Dazu können Elemente, denen ein bestimmtes Verhalten hinzugefügt werden soll, z. B. mit einer Klasse markiert oder bei Bedarf sogar mit einer ID ausgezeichnet werden.
Zeitgemäße Scripte werden automatisch beim Laden des Dokuments aktiv und starten die Ereignisüberwachung an den betreffenden Elementen. Diese Anwendung von JavaScript nennt sich Unobtrusive JavaScript, »unaufdringliches« JavaScript, oder auch DOM Scripting.
Einbindung
JavaScript-Quelltexte werden in HTML in einem script-Element notiert oder referenziert. Das script-Element darf dabei im body oder head des HTML-Dokuments notiert werden.
script-Elemente dürfen auch innerhalb von Flusselementen notiert werden.
<script> … </script>
JavaScript Code direkt in HTML notieren
<!doctype html>
<html>
<head>
<meta charset="utf-8">
<title>JavaScript: Hallo Welt</title>
<script>
alert('Hallo Welt!');
</script>
<noscript>
Sie haben JavaScript deaktiviert.
</noscript>
</head>
<body>
<p>Diese Seite tut nichts weiter, als eine Hinweisbox auszugeben.</p>
</body>
</html>
Im obigen Beispiel wird mithilfe von JavaScript ein Meldungsfenster mit dem Text „Hallo Welt!“ am Bildschirm ausgegeben.
Früher war es üblich, Skripte in einen CDATA-Block einzuschließen. Die Notwendigkeit dafür bestand nur für XHTML-Dokumente, wurde aber von vielen als „das muss so sein“ aufgefasst und überall eingesetzt. Es hat auch nicht gestört. Für HTML 5 gibt es zwar auch eine XML Notation, aber solange Sie ein solches Dokument nicht mit einem XML Tool verarbeiten wollen, ist die CDATA-Notation nicht mehr notwendig.
--> zu verwenden. Der Versuch, einen solchen Script-Block mit einem HTML-Kommentar komplett auszublenden, führt dazu, dass der Kommentar dann bei dem --> im Script endet.JavaScript-Dateien in HTML referenzieren
Das direkte Notieren von JavaScript in HTML ist im allgemeinen schlechte Praxis. Viel besser ist es, Scripte in eigenen Dateien zu notieren und diese dann einzubinden. Die Datei wird an der entsprechenden Stelle so ausgeführt, als ob der Code direkt notiert wurde. Sie können diese externen JavaScript-Dateien in beliebig viele Webseiten einbinden.
function Quadrat() {
let Eingabe = document.getElementById('Eingabe');
lt Ergebnis = Eingabe.value * Eingabe.value;
alert('Das Quadrat von ' + Eingabe.value + ' = ' + Ergebnis);
Eingabe.value = 0;
}
let los = document.getElementById('los');
los.addEventListener ('click', Quadrat, true);
Die externe JavaScript-Datei enthält eine Funktion Quadrat, in der mit document.getElementById auf das Eingabefeld zugegriffen wird. Der Variable Ergebnis wird das Quadrat des Wertes der Eingabe zugewiesen. Dieses wird dann mit einer kurzen Erklärung ausgegeben. Der Wert der Eingabe wird dann zurückgesetzt.
In den letzten 2 Zeilen wird mit document.getElementById mit der id los auf den Button zugegriffen und ihm über addEventListener der Event-Handler onclick zugewiesen. Ein Klick auf den Button ruft die Funktion Quadrat auf.
Damit dieser Event-Handler zugewiesen werden kann, muss das Element schon existieren. Deshalb sollte das Script entweder am Ende des HTML-Dokuments aufgerufen werden oder nach dem endgültigen Laden der Seite (mittels load) durch eine Funktion aufgerufen werden.
<!DOCTYPE html>
<html lang="de">
<head>
<meta charset="utf-8">
<title>externes JavaScript in HTML einbinden</title>
</head>
<body>
<h1>externes JavaScript in HTML einbinden</h1>
<input type="number" id="Eingabe" value="0" size="3">
<button type="button" id="los">Quadrat errechnen</button>
<script src="quadrat.js"></script>
</body>
</html>
Das src-Attribut (source = "Quelle") hat als Wert den URI zum Script. (Mehr Informationen über Referenzieren in HTML)
document.body.addEventListener("load",test); geladen werden.Script in den head oder ans Ende des body-Elements?
Eine immer wieder gestellte Frage ist, welche der beiden Positionen besser ist.
Wenn ein Browser eine Webseite lädt, folgt er einer festen Routine:
- Der Browser holt sich die HTML-Datei
- Das HTML-Markup wird geparst
- Der Parser trifft auf ein script-Element, das ein externes JavaScript referenziert
- Der Browser sendet einen Request, dass das Skript geladen werden soll. In der Zwischenzeit wird das Parsen des restlichen HTML-Markups eingestellt.
- Nach einiger Zeit ist das Skript heruntergeladen und wird ausgeführt.
- Der Browser setzt mit dem Parsen des restlichen HTML fort.
Warum kommt es bei Schritt 4 zu einer Unterbrechung? Skripte können mit document.write() oder anderen DOM-Manipulationen HTML einfügen oder verändern. Deshalb wartet der Parser, bis das Skript heruntergeladen und ausgeführt ist, bevor er den Rest des Dokuments parst.
Aus diesem Grund empfahlen früher viele, JavaScript am Schluss einzubinden, indem das script-Element vor das schließende body-Tag gesetzt wurde. Dieser Ansatz birgt aber das Problem, dass dadurch der Browser die Skripte erst downloaden kann, wenn das ganze HTML-Dokument geladen und geparst ist. Gerade bei größeren Seiten mit vielen Stylesheets, Skripten und eingebundenen Bibliotheken kann dies zu einer schlechteren Konversionsrate führen, wenn Nutzer nach erfolglosem Warten auf die Webseite entnervt aufgeben.
Also sollten Skripte so schnell wie möglich geladen werden.
Fazit: in den head
Durch die Attribute async und defer können Sie dem Browser mitteilen, dass er mit dem Parsen fortfahren kann, während er Skripte herunterlädt.
- Browserunterstützung
- caniuse.com
Eine weitere Alternative sind ECMASCript 2015-Module. Sie werden durch ein <script>-Element mit type="module" geladen und verhalten sich bezüglich ihres Timings genau wie defer-Scripte. Sie setzen allerdings einen ECMAScript 2015-fähigen Browser voraus und sind nicht geeignet, wenn Altbrowser unterstützt werden sollen.
<script src="script1.js" async></script>
<script src="script2.js" async></script>
Die wenigen alten Browser, die diese Attribute noch nicht kennen, ignorieren sie. Statt dessen wird Ihr Script synchron geladen und sofort ausgeführt. Wollen Sie solche Browser unterstützen, müssen Sie Ihr Script so schreiben, dass es zu jedem Ausführungszeitpunkt funktioniert.
Bei den Beispielen im Wiki sollten Sie JavaScript immer im head einbinden, da im body vorhandene Skripte im Frickl-Editor zwar angezeigt, beim Ausführen durch den im HTML-Markup vorhandenen OriginalCode aber wieder überschrieben werden.
Attribute im script-Element
Timing von defer-Scripten
Man kann keine Aussage darüber treffen, wann ein mit defer oder async markiertes Script zur Verfügung steht. Bei defer-Scripten wissen Sie bei einem nicht zu alten Browser aber immerhin genau, wann es gestartet wird: Nach dem Parsen des DOM, und vor dem Auslösen des DOMContentLoaded-Events. Ebenfalls ist festgelegt, dass defer-Scripte in der Reihenfolge ausgeführt werden, wie sie im HTML angetroffen werden.
Wenn Ihr defer-Script mit der Ausführung an der Reihe ist, aber noch nicht fertig geladen wurde, wartet der Browser.
Für eine Altbrowser-Unterstützung sollten Sie
- den Initialisungscode Ihres Scripts, der vom DOM abhängt, in eine Funktion verpacken
- zu Beginn einen Test einbauen, ob ein HTML Element, das im Quellcode hinter Ihrem Script steht, im DOM gefunden werden kann.
Wird das Element gefunden, hat defer funktioniert und Sie können die Initialisierungsfunktion sofort aufrufen.
Wenn nicht, müssen Sie die Ihre Initialisierungsfunktion als Eventhandler für DOMContentLoaded registrieren.
Timing von async-Scripten
Ein async-Script wird vom Browser ebenfalls im Hintergrund geladen. Sobald es bereit steht (und gerade kein anderes Script läuft), wird es gestartet. Das kann noch während des Parsens der Seite geschehen, zwischen zwei defer-Scripten oder auch erst, nachdem die Seite schon längst angezeigt wird.
Sie können sich daher weder darauf verlassen, welcher Anteil des DOM bereits verfügbar ist, noch darauf, dass ein von Ihnen registrierter DOMContentLoaded Handler noch an die Reihe kommt. Eine Möglichkeit, sich über den Zustand der Seite zu orientieren, ist die Eigenschaft readystate des document-Objekts. Finden Sie dort den Wert "loading" vor, dann wurde DOMContentLoaded noch nicht ausgeführt und Sie sollten Ihre Initialisierung in einem Handler für dieses Event ausführen. Bei anderen Werten von readyState sollte das DOM bereitstehen.
Für eine Altbrowser-Unterstützung ist das allerdings nicht hinreichend, weil bis zum Internet Explorer 10 auf readyState kein Verlass ist. Hier ist es sicherer, im DOM ein möglichst weit am Ende des HTML Quelltextes befindliches Element zu suchen. Wenn es fehlt, registrieren Sie einen DOMContentLoaded Handler für die Initialisierung (ab Internet Explorer 9).
Timing bei gleichzeitiger Angabe von defer und async
Grundsätzlich hat in diesem Fall das async-Attribut Vorrang. Es gibt jedoch alte Browser, die async nicht kennen, defer aber schon. Um in solchen Browsern asynchron geladene Scripte anbieten zu können, kann man beide Attribute angeben. Ein besonderer Programmieraufwand im Script entsteht deswegen nicht. Wenn Ihr Script mit async zurecht kommt, dann funktioniert es auch mit defer.
Interaktion von async-Scripten
Wenn Sie mehrere async-Scripte laden und in einem Script darauf angewiesen sind, dass ein anderes async-Script bereits gelaufen ist, dann sollten Sie Ihr Design überarbeiten. Es gibt keine Garantie für die Reihenfolge, in der async-Scripte gestartet werden. Über ein im DOM verstecktes Element oder Attribut könnten Sie zwar feststellen, ob das vorausgesetzte Script bereits gelaufen ist, aber wenn nicht, gibt es keinen fertigen Mechanismus, um auf das fehlende Script zu warten. Natürlich kann man einen solchen Mechanismus bauen, aber Sie sollten das Rad hier nicht neu erfinden. Versuchen Sie, Ihr Problem mit defer-Scripten oder ECMAScript 2015-Modulen zu lösen, oder verwenden Sie eine JavaScript-Bibliothek wie require.js zur Koordination der Modulabhängigkeiten.
if (document.getElementById("speichernButton"))
registriereClickHandler()
else
document.addEventListener("DOMContentLoaded", registriereClickHandler);
function registriereClickHandler() {
document.getElementById("speichernButton")
.addEventListener("click", function(event) {
// Code zum Speichern hier
});
}
Weblinks
- stackoverflow: Where is the best place to put <script> tags in HTML markup?
- Google.developers: JavaScript-Code entfernen, der das Rendern blockiert
- html5rocks: Deep dive into the murky waters of script loading von Jake Archibald
(sehr ausführlicher Artikel, der anschaulich erklärt, wie JavaScript im Browser geladen und ausgeführt wird)
registriereClickHandlergebündelt. Der Vorspann des Scripts prüft zunächst, ob der Button bereits zu finden ist. Wenn ja, ruft er die Registrierfunktion direkt auf. Andernfalls wird sie als EventHandler für DOMContentLoaded registriert.