Dom

dom.js

Mitglieder

statisch , Konstante $

Findet einen einzelnen DOM-Element-Abstimmungsselektor im optionalen Kontext eines anderen DOM-Elements (standardmäßig auf Dokument).

statisch , Konstante $$

Findet einen Selektor für alle DOM-Elemente im optionalen Kontext eines anderen DOM-Elements (standardmäßig auf Dokument).

Methoden

statisch addClass(Element, classToAdd) → {Element}

Fügen Sie einem Element einen Klassennamen hinzu.

Parameter:
Nennen Typ Beschreibung
Element Element

Element, dem der Klassennamen hinzugefügt werden soll.

ClassToAdd String

Der hinzuzufügende Klassenname.

Gibt zurück:
Element -

Das DOM-Element mit dem hinzugefügten Klassennamen.

statischer AppendContent(el, Inhalt) → {Element}

Normalisiert und hängt Inhalt an ein Element an.

Parameter:
Nennen Typ Beschreibung
el Element

Element, an das normalisierten Inhalt angehängt werden soll.

Inhalt Modul:DOM~contentDescriptor

Ein Wert für Inhaltsdeskriptor.

Gibt zurück:
Element -

Das Element mit angehängtem normalisiertem Inhalt.

statisch blockTextSelection()

Versuchen Sie, die Textauswahl zu blockieren.

statisch creaTeel(TagNameopt, Eigenschaftenopt, Attributeopt, Inhalt) → {Element}

Erstellt ein Element und wendet Eigenschaften und Attribute an und fügt Inhalte ein.

Parameter:
Nennen Typ Attribute Standardwert Beschreibung
tagName String <optional>
'tauch'

Name des zu erstellenden Tags.

immobilien Objekt <optional>
{}

Anzuwendende Elementeigenschaften.

Attribute Objekt <optional>
{}

Anzuwendende Elementattribute.

Inhalt Modul:DOM~contentDescriptor

Ein Inhaltsdeskriptorobjekt.

Gibt zurück:
Element -

Das Element, das erstellt wurde.

statisch emptyEl(el) → {Element}

Leert den Inhalt eines Elements.

Parameter:
Nennen Typ Beschreibung
el Element

Das Element zum Leeren von Kindern

Gibt zurück:
Element -

Das Element ohne Kinder

statische FindPosition(el) → {module:dom~Position}

Rufen Sie die Position eines Elements im DOM ab.

Verwendet getBoundingClientRect Technik von John Resig.

Parameter:
Nennen Typ Beschreibung
el Element

Element, von dem der Offset abgerufen werden soll.

Gibt zurück:
Modul:dom~Position -

Die Position des Elements, das übergeben wurde.

Siehe:

statisches getAttribute(el, Attribut) → {string}

Rufen Sie den Wert des Attributs eines Elements ab.

Parameter:
Nennen Typ Beschreibung
el Element

Ein DOM-Element.

Attribut String

Attribut, um den Wert zu erhalten.

Gibt zurück:
string -

Der Wert des Attributs.

statisches getAttributes(Tag) → {Objekt}

Rufen Sie die Attributwerte eines Elements ab, wie im HTML-Tag definiert.

Attribute sind nicht dasselbe wie Eigenschaften. Sie werden im Tag oder mit setAttribute definiert.

Parameter:
Nennen Typ Beschreibung
Etikett Element

Element, von dem Tag-Attribute abzurufen sind.

Gibt zurück:
Objekt -

Alle Attribute des Elements. Boolesche Attribute sind wahr oder falsch , andere werden Strings sein.

static getBoundingClientRect(el) → {object|undefiniert}

Identisch mit den Einheimischen getBoundingClientRect Funktion, sondern stellt sicher, dass die Methode überhaupt unterstützt wird (es ist in allen Browsern die wir behaupten zu unterstützen) und dass sich das Element im DOM befindet, bevor Sie fortfahren.

Diese Wrapper-Funktion verschiebt auch Eigenschaften, die von einigen älteren Browsern (namentlich IE8) nicht bereitgestellt werden.

Darüber hinaus unterstützen einige Browser das Hinzufügen von Eigenschaften zu a . nicht ClientRect/DOMRect Objekt; Also kopieren wir es flach mit den Standardeigenschaften (außer x und ja die nicht weit verbreitet sind). Dies hilft, Implementierungen zu vermeiden, bei denen Schlüssel nicht aufzählbar sind.

Parameter:
Nennen Typ Beschreibung
el Element

Element, dessen ClientRect wir wollen rechnen.

Gibt zurück:
Objekt | unbestimmtes -

Gibt immer ein einfaches Objekt zurück - oder nicht definiert wenn es nicht kann.

static getPointerPosition(el, event) → {module:DOM~Coordinates}

Rufen Sie die Zeigerposition innerhalb eines Elements ab.

Die Basis auf den Koordinaten ist unten links vom Element.

Parameter:
Nennen Typ Beschreibung
el Element

Element, für das die Zeigerposition abgerufen werden soll.

Ereignis eventTarget~Event

Event-Objekt.

Gibt zurück:
Modul:dom~Koordinaten -

Ein Koordinatenobjekt entsprechend der Mausposition.

statisch hasClass(element, classToCheck) → {boolean}

Prüfen Sie, ob ein Element einen Klassennamen hat.

Parameter:
Nennen Typ Beschreibung
Element Element

Zu überprügendes Element

ClasstoCheck String

Klassenname, auf den geprüft werden soll

Wirft:

Löst einen Fehler aus, wenn ClassToCheck Leerzeichen hat.

Typ
Fehler
Gibt zurück:
boolescher Wert -

Wird sein wahr Wenn das Element eine Klasse hat, falsch Andernfalls.

statischer InsertContent(el, Inhalt) → {Element}

Normalisiert und fügt Inhalt in ein Element ein; dies ist identisch mit appendContent (), außer dass es das Element zuerst leert.

Parameter:
Nennen Typ Beschreibung
el Element

Element, in das normalisierten Inhalt eingefügt werden soll.

Inhalt Modul:DOM~contentDescriptor

Ein Wert für Inhaltsdeskriptor.

Gibt zurück:
Element -

Das Element mit eingefügtem normalisiertem Inhalt.

statischer ISel(Wert) → {boolean}

Bestimmt durch Enteneingabe, ob ein Wert ein DOM-Element ist oder nicht.

Parameter:
Nennen Typ Beschreibung
Wert Gemischt

Der zu überprüfende Wert.

Gibt zurück:
boolescher Wert -

Wird sein wahr wenn der Wert ein DOM-Element ist, falsch Andernfalls.

statischer isFrame() → {boolean}

Bestimmt, ob das aktuelle DOM in einen iframe eingebettet ist.

Gibt zurück:
boolescher Wert -

Wird sein wahr wenn das DOM in einen iframe eingebettet ist, falsch Andernfalls.

statisch isReal() → {boolean}

Ob die aktuelle DOM-Schnittstelle real erscheint (dh nicht simuliert).

Gibt zurück:
boolescher Wert -

Wird sein wahr wenn das DOM echt zu sein scheint, falsch Andernfalls.

static isSingleLeftClick(Ereignis) → {boolean}

Überprüfen Sie, ob ein Ereignis ein einzelner Linksklick war.

Parameter:
Nennen Typ Beschreibung
Ereignis eventTarget~Event

Event-Objekt.

Gibt zurück:
boolescher Wert -

Wird sein wahr wenn ein einzelner Linksklick, falsch Andernfalls.

statischer isTextNode(Wert) → {boolean}

Bestimmt durch Duck-Typisierung, ob ein Wert ein Textknoten ist oder nicht.

Parameter:
Nennen Typ Beschreibung
Wert Gemischt

Prüfen Sie, ob dieser Wert ein Textknoten ist.

Gibt zurück:
boolescher Wert -

Wird sein wahr wenn der Wert ein Textknoten ist, falsch Andernfalls.

statischer normalizeContent(Inhalt) → {Array}

Normalisiert den Inhalt für das eventuelle Einfügen in das DOM.

Dies ermöglicht eine breite Palette von Methoden zur Inhaltsdefinition, schützt jedoch davor, in die Falle zu tappen, einfach an . zu schreiben innerHTML , was ein XSS-Problem sein könnte.

Der Inhalt eines Elements kann in mehreren Typen und Kombinationen übergeben werden, deren Verhalten wie folgt lautet:

Parameter:
Nennen Typ Beschreibung
Inhalt Modul:DOM~contentDescriptor

Ein Wert für Inhaltsdeskriptor.

Gibt zurück:
Array -

Der gesamte übergebene Inhalt, normalisiert auf ein Array von Elementen oder Textknoten.

statisch prependTo(Kind, Elternteil)

Fügen Sie ein Element als ersten untergeordneten Knoten eines anderen

Parameter:
Nennen Typ Beschreibung
Kind Element

Einzufügendes Element

Elternteil Element

Element, in das Kind eingefügt werden soll

statisch Attribut entfernen(el, Attribut)

Entfernen Sie das Attribut eines Elements.

Parameter:
Nennen Typ Beschreibung
el Element

Ein DOM-Element.

Attribut String

Zu entfernendes Attribut.

static removeClass(element, classToRemove) → {Element}

Entfernen Sie einen Klassennamen aus einem Element.

Parameter:
Nennen Typ Beschreibung
Element Element

Element, aus dem ein Klassennamen entfernt werden soll.

ClassToRemove String

Zu entfernende Klassenname

Gibt zurück:
Element -

Das DOM-Element mit entferntem Klassennamen.

statisch setAttribute(el, Attribut, Wert)

Legen Sie den Wert des Attributs eines Elements fest.

Parameter:
Nennen Typ Beschreibung
el Element

Ein DOM-Element.

Attribut String

Zu setzendes Attribut.

Wert String

Wert, auf den das Attribut festgelegt werden soll.

statisch setAttribute(el, Attributeopt)

Wenden Sie Attribute auf ein HTML-Element an.

Parameter:
Nennen Typ Attribute Beschreibung
el Element

Element, dem Attribute hinzugefügt werden sollen.

Attribute Objekt <optional>

Zu anwendende Attribute.

statischer TextContent(el, Text) → {Element}

Injiziert Text in ein Element und ersetzt alle vorhandenen Inhalte vollständig.

Parameter:
Nennen Typ Beschreibung
el Element

Das Element, in das Textinhalt hinzugefügt werden soll

Text String

Der hinzuzufügende Textinhalt.

Gibt zurück:
Element -

Das Element mit hinzugefügtem Textinhalt.

static toggleClass(element, classToToggle, Prädikatopt) → {Element}

Fügt einem Element je nach einer optionalen Bedingung oder dem Vorhandensein/Fehlen des Klassennamens einen Klassennamen hinzu oder entfernt ihn.

Parameter:
Nennen Typ Attribute Beschreibung
Element Element

Das Element, für das ein Klassennamen umschalten soll.

ClassToggle String

Die Klasse, die umgeschaltet werden soll.

Prädikat boolesch | module:dom~PredicateCallback <optional>

Siehe Rückgabewert für module:dom~PredicateCallback

Gibt zurück:
Element -

Das Element mit einer Klasse, die umgeschaltet wurde.

statisch unblockTextSelection()

Deaktivieren Sie die Blockierung der Textauswahl.

Geben Sie Definitionen ein

Inhaltsbeschreibung()

Dies ist ein gemischter Wert, der den Inhalt beschreibt, der über eine Methode in das DOM eingefügt werden soll. Es kann von den folgenden Typen sein:

Typ Beschreibung
String Der Wert wird in einen Textknoten normalisiert.
Element Der Wert wird unverändert akzeptiert.
TextNode Der Wert wird unverändert akzeptiert.
Reihe Ein eindimensionales Array von Zeichenfolgen, Elementen, Textknoten oder Funktionen. Diese Funktionen sollten einen String, ein Element oder einen Textknoten zurückgeben (jeder andere Rückgabewert, wie ein Array, wird ignoriert).
Funktion Eine Funktion, von der erwartet wird, dass sie einen String, ein Element, einen Textknoten oder ein Array zurückgibt – einen der anderen oben beschriebenen möglichen Werte. Dies bedeutet, dass ein Inhaltsdeskriptor eine Funktion sein kann, die ein Array von Funktionen zurückgibt, diese Funktionen der zweiten Ebene jedoch Zeichenfolgen, Elemente oder Textknoten zurückgeben müssen.

Koordinaten

Stellt x- und y-Koordinaten für ein DOM-Element oder einen Mauszeiger dar.

Eigenschaften:
Nennen Typ Beschreibung
x Zahl

x-Koordinate in Pixel

ja Zahl

y-Koordinate in Pixel

Position

Stellt die Position eines DOM-Elements auf der Seite dar.

Eigenschaften:
Nennen Typ Beschreibung
links Zahl

Pixel nach links.

oben Zahl

Pixel von oben.

PredicateCallback(Element, classToToggle) → {boolesch | undefiniert}

Die Callback-Definition für toggleClass.

Parameter:
Nennen Typ Beschreibung
Element Element

Das DOM-Element der Komponente.

ClassToggle String

Die Klassenname das will umgeschaltet werden

Gibt zurück:
boolean | undefined -

Wenn wahr zurückgegeben wird, die classToToggle wird hinzugefügt Element. Wenn falsch , das classToToggle wird aus der entfernt Element. Wenn nicht definiert , wird der Rückruf ignoriert.