Vorlagenunterseite für API-Ereignisse

Hinweis:>Entfernen Sie diese gesamte erklärende Anmerkung vor der Veröffentlichung.

Seitenanfang:

Der Seitenanfang oben auf der Seite wird verwendet, um "Seitenmetadaten" zu definieren. Die Werte sollten entsprechend für das jeweilige Ereignis aktualisiert werden.

md
---
title: "NameOfTheParentInterface: NameOfTheEvent event"
slug: Web/API/NameOfTheParentInterface/NameOfTheEvent_event
page-type: web-api-event
status:
  - deprecated
  - experimental
  - non-standard
browser-compat: path.to.feature.NameOfTheEvent_event
---
title

Der Titelkopf wird oben auf der Seite angezeigt. Formatieren Sie ihn als "NameOfTheParentInterface: NameOfTheEvent event". Zum Beispiel hat das animationcancel Ereignis der Window Schnittstelle einen title von Window: animationcancel event.

slug

Das Ende des URL-Pfads nach https://developer.mozilla.org/de/docs/. Dies wird formatiert wie Web/API/NameOfTheParentInterface/NameOfTheEvent_event.

page-type

Der page-type-Schlüssel für Web/API-Ereignisse ist immer web-api-event.

status

Flags, die den Status dieser Funktion beschreiben. Ein Array, das einen oder mehrere der folgenden enthalten kann: experimental, deprecated, non-standard. Dieser Schlüssel sollte nicht manuell gesetzt werden: Er wird automatisch anhand der Werte in den Browser-Kompatibilitätsdaten für die Funktion gesetzt. Siehe Wie Funktionsstatus hinzugefügt oder aktualisiert werden.

browser-compat

Ersetzen Sie den Platzhalterwert path.to.feature.NameOfTheEvent_event mit der Abfragezeichenfolge für das Ereignis im Browser compat data repo. Die Toolchain verwendet den Schlüssel automatisch, um die Kompatibilitäts- und Spezifikationsabschnitte zu füllen (ersetzen der {{Compat}} und {{Specifications}} Makros).

Beachten Sie, dass Sie möglicherweise zunächst einen Eintrag für das Ereignis in unserem Browser compat data repo erstellen/aktualisieren müssen, und dieser Eintrag muss Spezifikationsinformationen enthalten. Siehe unseren Leitfaden, wie Sie dies tun.

Makros am Anfang der Seite

Eine Reihe von Makroaufrufen erscheint am Anfang des Inhaltsbereichs (unmittelbar unterhalb der Seitenanfangsdaten).

Diese Makros werden automatisch von der Toolchain hinzugefügt (es ist nicht erforderlich, diese hinzuzufügen/zu entfernen):

  • {{SeeCompatTable}} — dies erzeugt ein Dies ist eine experimentelle Technologie-Banner, das darauf hinweist, dass die Technologie experimentell ist. Wenn es experimentell ist und die Technologie in Firefox hinter einem Präfix verborgen ist, sollten Sie auch einen Eintrag dafür auf der Seite Experimentelle Funktionen in Firefox ausfüllen.
  • {{Deprecated_Header}} — dies erzeugt ein Veraltet-Banner, das darauf hinweist, dass die Verwendung der Technologie nicht empfohlen ist.
  • {{Non-standard_Header}} — dies erzeugt ein Nicht standardmäßig-Banner, das darauf hinweist, dass die Funktion nicht Teil einer Spezifikation ist.

Sie sollten das folgende Makro gemäß dem folgenden Hinweis aktualisieren oder löschen:

  • {{SecureContext_Header}} — dies erzeugt ein Sicherer Kontext-Banner, das darauf hinweist, dass die Technologie nur in einem sicheren Kontext verfügbar ist. Wenn dies nicht der Fall ist, können Sie den Makroaufruf entfernen. Wenn dies der Fall ist, sollten Sie auch einen Eintrag dafür auf der Seite Funktionen, die auf sichere Kontexte beschränkt sind ausfüllen.
  • {{AvailableInWorkers}} — dies erzeugt einen Verfügbar in Workern-Hinweis, der darauf hinweist, dass die Technologie im Worker-Kontext verfügbar ist. Wenn es nur im Fensterkontext verfügbar ist, können Sie den Makroaufruf entfernen. Wenn es auch im Worker-Kontext oder nur dort verfügbar ist, müssen Sie möglicherweise einen Parameter übergeben, um seine Verfügbarkeit anzugeben (siehe {{AvailableInWorkers}} Makro-Quellcode für alle verfügbaren Werte), und Sie müssen möglicherweise auch einen Eintrag auf der Seite Webapis verfügbar in Workern ausfüllen.
  • {{APIRef("GroupDataName")}} — dies erzeugt die linksseitige Referenz-Sidebar mit schnellen Referenzlinks zur aktuellen Seite. Zum Beispiel hat jede Seite in der WebVR API dieselbe Sidebar, die auf die anderen Seiten in der API verweist. Um die richtige Sidebar für Ihre API zu erstellen, müssen Sie einen GroupData-Eintrag in unserem GitHub-Repo hinzufügen und den Eintragsnamen im Makroaufruf anstelle von GroupDataName einfügen. Siehe unseren Leitfaden zu API-Referenz-Sidebars für Informationen, wie dies getan wird.

Status-Header-Makros sollten nicht manuell bereitgestellt werden. Lesen Sie den Abschnitt "Wie Funktionsstatus hinzugefügt oder aktualisiert werden", um diese Status zu den Seiten hinzuzufügen.

Beispiele der Sicherer Kontext, Verfügbar in Workern, Experimentell, Veraltet und Nicht standardmäßig-Banner werden direkt nach diesem Hinweisblock angezeigt.

Link auf übergeordnetes Objekt

Fügen Sie einen Link zu dieser neuen Seite aus dem Abschnitt Events des übergeordneten Objekts hinzu. Zum Beispiel ist Element: wheel event aus Element Events verlinkt.

Wenn das übergeordnete Objekt keinen Events-Abschnitt hat, dann fügen Sie einen hinzu. Wenn es sich um eine neue "Klasse" von Ereignis handelt, sollten Sie einen Link zu diesem Abschnitt des übergeordneten Elements aus der Ereignisreferenz hinzufügen.

Denken Sie daran, diese gesamte erklärende Anmerkung vor der Veröffentlichung zu entfernen.

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Hinweis: Diese Funktion ist in Web Workers verfügbar.

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

Veraltet: Diese Funktion wird nicht mehr empfohlen. Obwohl einige Browser sie möglicherweise noch unterstützen, könnte sie bereits aus den relevanten Webstandards entfernt worden sein, in Kürze entfernt werden oder nur noch aus Kompatibilitätsgründen bestehen. Vermeiden Sie die Verwendung und aktualisieren Sie vorhandenen Code, falls möglich; siehe die Kompatibilitätstabelle am Ende dieser Seite, um Ihre Entscheidung zu unterstützen. Beachten Sie, dass diese Funktion jederzeit aufhören könnte zu funktionieren.

Nicht standardisiert: Diese Funktion ist nicht standardisiert. Wir raten davon ab, nicht-standardisierte Funktionen auf produktiven Webseiten zu verwenden, da sie nur von bestimmten Browsern unterstützt werden und sich in Zukunft ändern oder entfernt werden können. Unter Umständen kann sie jedoch eine geeignete Option sein, wenn es keine standardisierte Alternative gibt.

Beginnen Sie den Inhalt auf der Seite mit einem einleitenden Absatz — beginnen Sie damit, das Ereignis zu benennen, welcher Schnittstelle es angehört und was es tut. Dies sollte idealerweise ein bis zwei kurze Sätze umfassen. Sie können das meiste davon von der Zusammenfassung der Eigenschaft auf der entsprechenden API-Referenzseite übernehmen.

Syntax

Verwenden Sie den Ereignisnamen in Methoden wie addEventListener() oder setzen Sie eine Ereignishandler-Eigenschaft.

js
addEventListener("NameOfTheEvent", (event) => { })

onNameOfTheEvent = (event) => { }

Ereignistyp

Wenn das Ereignis einen speziellen Typ hat, erwähnen Sie ihn zusammen mit seiner Vererbung. Wenn nicht, geben Sie an, dass es sich um ein generisches Ereignis handelt:

Ein generisches Event.

Oder, zum Beispiel:

Ein XRSessionEvent. Erbt von Event.

Event XRSessionEvent

Ereigniseigenschaften

Wenn das Ereignis nicht nur ein generisches Event ist, listen Sie die zusätzlichen Eigenschaften auf, die das Ereignis hat.

Neben den unten aufgeführten Eigenschaften sind die Eigenschaften der übergeordneten Schnittstelle, Event, verfügbar.

session Schreibgeschützt

Die XRSession, auf die sich das Ereignis bezieht.

Beschreibung

Wenn Sie zusätzlichen Text bereitstellen möchten (zu lang für die Zusammenfassung), fügen Sie einen Abschnitt "Beschreibung" hinzu. Dieser kann die Überschriften

Auslöser

und

Anwendungsfälle

enthalten, die weitere Informationen bieten können.

Beispiele

Beachten Sie, dass wir den Plural "Beispiele" verwenden, auch wenn die Seite nur ein Beispiel enthält.

Eine beschreibende Überschrift

Jedes Beispiel muss eine H3-Überschrift (###) haben, die das Beispiel benennt. Die Überschrift sollte beschreibend sein, was das Beispiel tut. Zum Beispiel sagt "Ein einfaches Beispiel" nichts über das Beispiel aus und ist daher keine gute Überschrift. Die Überschrift sollte prägnant sein. Für eine längere Beschreibung verwenden Sie den Absatz nach der Überschrift.

Siehe unseren Leitfaden, wie Sie Code-Beispiele hinzufügen für weitere Informationen.

Hinweis: Manchmal möchten Sie auf Beispiele verlinken, die auf einer anderen Seite gegeben werden.

Szenario 1: Wenn Sie einige Beispiele auf dieser Seite haben und weitere Beispiele auf einer anderen Seite:

Fügen Sie eine H3-Überschrift (###) für jedes Beispiel auf dieser Seite hinzu und dann eine letzte H3-Überschrift (###) mit dem Text "Weitere Beispiele", unter der Sie auf die Beispiele auf anderen Seiten verlinken können. Zum Beispiel:

md
## Beispiele

### Nutzung der Fetch-API

Beispiel für Fetch

### Weitere Beispiele

Links zu weiteren Beispielen auf anderen Seiten

Szenario 2: Wenn Sie nur Beispiele auf einer anderen Seite und keine auf dieser Seite haben:

Fügen Sie keine H3-Überschriften hinzu; fügen Sie die Links direkt unter der H2-Überschrift "Beispiele" hinzu. Zum Beispiel:

md
## Beispiele

Für Beispiele zu dieser API siehe [die Seite über fetch()](https://example.org/).

Spezifikationen

{{Specifications}}

Um dieses Makro zu verwenden, entfernen Sie die Rückstriche und Anführungszeichen in der Markdown-Datei.

Browser-Kompatibilität

{{Compat}}

Um dieses Makro zu verwenden, entfernen Sie die Rückstriche und Anführungszeichen in der Markdown-Datei.

Siehe auch

Fügen Sie Links zu Referenzseiten und Leitfäden hinzu, die mit der aktuellen API in Zusammenhang stehen. Für weitere Richtlinien siehe den Abschnitt Siehe auch im Schreibrichtlinienleitfaden.

  • link1
  • link2
  • external_link (year)