Class Element

An element within the DOM.

Hierarchy (view full)

NodeWithChildren
- Element

Index

Constructors

Constructors

constructor

new Element(name, attribs, children?, type?): Element
Parameters
- name: string
  Name of the tag, eg. div, span.
- attribs: {
  [name: string]: string;
  }
  Object mapping attribute names to attribute values.
  - [name: string]: string
- children: ChildNode[] = []
  Children of the node.
- type: Script | Style | Tag = ...
Returns Element
Overrides NodeWithChildren.constructor
- Defined in src/node.ts:280

Properties

attribs

attribs: {
[name: string]: string;
}

Object mapping attribute names to attribute values.

Type declaration

[name: string]: string

children

children: ChildNode[]

Children of the node. Only certain node types can have children.

endIndex

endIndex: null | number = null

The end index of the node. Requires withEndIndices on the handler to be `true.

name

name: string

Name of the tag, eg. div, span.

`Optional` namespace

namespace?: string

Element namespace (parse5 only).

next: null | ChildNode = null

Next sibling

parent

parent: null | ParentNode = null

Parent of the node

prev: null | ChildNode = null

Previous sibling

`Optional` sourceCodeLocation

sourceCodeLocation?: null | TagSourceCodeLocation

parse5 source code location info, with start & end tags.

Available if parsing with parse5 and location info is enabled.

startIndex

startIndex: null | number = null

The start index of the node. Requires withStartIndices on the handler to be `true.

type

type: Script | Style | Tag = ...

The type of the node.

`Optional` x-attribsNamespace

x-attribsNamespace?: Record<string, string>

Element attribute namespaces (parse5 only).

`Optional` x-attribsPrefix

x-attribsPrefix?: Record<string, string>

Element attribute namespace-related prefixes (parse5 only).

Accessors

attributes

get attributes(): Attribute[]
Returns Attribute[]
- Defined in src/node.ts:321

childNodes

get childNodes(): ChildNode[]
Same as children. DOM spec-compatible alias.

Returns ChildNode[]
Inherited from NodeWithChildren.childNodes
- Defined in src/node.ts:227
set childNodes(children): void
Parameters
- children: ChildNode[]
Returns void
Inherited from NodeWithChildren.childNodes
- Defined in src/node.ts:231

firstChild

get firstChild(): null | ChildNode
First child of the node.

Returns null | ChildNode
Inherited from NodeWithChildren.firstChild
- Defined in src/node.ts:212

lastChild

get lastChild(): null | ChildNode
Last child of the node.

Returns null | ChildNode
Inherited from NodeWithChildren.lastChild
- Defined in src/node.ts:217

nextSibling

get nextSibling(): null | ChildNode
Same as next. DOM spec-compatible alias.

Returns null | ChildNode
Inherited from NodeWithChildren.nextSibling
- Defined in src/node.ts:109
set nextSibling(next): void
Parameters
- next: null | ChildNode
Returns void
Inherited from NodeWithChildren.nextSibling
- Defined in src/node.ts:113

nodeType

get nodeType(): 1
DOM spec-compatible node type.

Returns 1
Overrides NodeWithChildren.nodeType
- Defined in src/node.ts:296

parentNode

get parentNode(): null | ParentNode
Same as parent. DOM spec-compatible alias.

Returns null | ParentNode
Inherited from NodeWithChildren.parentNode
- Defined in src/node.ts:85
set parentNode(parent): void
Parameters
- parent: null | ParentNode
Returns void
Inherited from NodeWithChildren.parentNode
- Defined in src/node.ts:89

previousSibling

get previousSibling(): null | ChildNode
Same as prev. DOM spec-compatible alias.

Returns null | ChildNode
Inherited from NodeWithChildren.previousSibling
- Defined in src/node.ts:97
set previousSibling(prev): void
Parameters
- prev: null | ChildNode
Returns void
Inherited from NodeWithChildren.previousSibling
- Defined in src/node.ts:101

tagName

get tagName(): string
Same as name. DOM spec-compatible alias.

Returns string
- Defined in src/node.ts:313
set tagName(name): void
Parameters
- name: string
Returns void
- Defined in src/node.ts:317

Methods

cloneNode

cloneNode<T>(this, recursive?): T
Clone this node, and optionally its children.
Type Parameters
- T extends Node
Parameters
- this: T
- recursive: boolean = false
  Clone child nodes as well.
Returns T
A clone of the node.
Inherited from NodeWithChildren.cloneNode
- Defined in src/node.ts:123

Class Element

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

name: string

attribs: { [name: string]: string; }

[name: string]: string

children: ChildNode[] = []

type: Script | Style | Tag = ...

Returns Element

Properties

attribs

Type declaration

[name: string]: string

children

endIndex

name

Optional namespace

next

parent

prev

Optional sourceCodeLocation

startIndex

type

Optional x-attribsNamespace

Optional x-attribsPrefix

Accessors

attributes

Returns Attribute[]

childNodes

Returns ChildNode[]

Parameters

children: ChildNode[]

Returns void

firstChild

Returns null | ChildNode

lastChild

Returns null | ChildNode

nextSibling

Returns null | ChildNode

Parameters

next: null | ChildNode

Returns void

nodeType

Returns 1

parentNode

Returns null | ParentNode

Parameters

parent: null | ParentNode

Returns void

previousSibling

Returns null | ChildNode

Parameters

prev: null | ChildNode

Returns void

tagName

Returns string

Parameters

name: string

Returns void

Methods

cloneNode

Type Parameters

T extends Node

Parameters

this: T

recursive: boolean = false

Returns T

Settings

Member Visibility

Theme

On This Page

attribs: {
[name: string]: string;
}

`Optional` namespace

`Optional` sourceCodeLocation

`Optional` x-attribsNamespace

`Optional` x-attribsPrefix