Class default

Index

Constructors

Properties

Methods

append appendMany appendTo attr class classOff classOn cleanup clear getHTML getText getValue html id on prepend prependMany qs qsa query style styleJs swapRef text un val from qs qsa

Constructors

constructor

new default(elm): default
Create a new instance of the HTML class.
Parameters
- elm: string | HTMLElement
  The HTML element to be created or classified from.
Returns default
- Defined in src/HTML.ts:8

Properties

elm

elm: HTMLInputElement | HTMLElement

The HTML element referenced in this instance. Change using .swapRef(), or remove using .cleanup().

Methods

append

append(elem): default
Append an element. Typically used as a .append(new HTML(...)) call.
Parameters
- elem: string | default | HTMLElement
  The element to append.
Returns default
HTML
- Defined in src/HTML.ts:186

appendMany

appendMany(...elements): default
Append multiple elements. Typically used as a .appendMany(new HTML(...), new HTML(...) call.
Parameters
- Rest ...elements: any[]
  The elements to append.
Returns default
HTML
- Defined in src/HTML.ts:222

appendTo

appendTo(parent): default
Append this element to another element. Uses appendChild() on the parent.
Parameters
- parent: string | default | HTMLElement
  Element to append to. HTMLElement, HTML, and string (as querySelector) are supported.
Returns default
HTML
- Defined in src/HTML.ts:170

attr

attr(obj): default
Set attributes (object method.)
Parameters
- obj: {
  [x: string]: any;
  }
  The attributes to set (as an object of key: value;)
  - [x: string]: any
Returns default
HTML
- Defined in src/HTML.ts:255

class

class(...val): default
Toggle on/off a class.
Parameters
- Rest ...val: string[]
  The class to toggle.
Returns default
HTML
- Defined in src/HTML.ts:87

classOff

classOff(...val): default
Toggles OFF a class.
Parameters
- Rest ...val: string[]
  The class to disable.
Returns default
HTML
- Defined in src/HTML.ts:111

classOn

classOn(...val): default
Toggles ON a class.
Parameters
- Rest ...val: string[]
  The class to enable.
Returns default
HTML
- Defined in src/HTML.ts:99

cleanup

cleanup(): default
Safely remove the element. Can be used in combination with a .swapRef() to achieve a "delete & swap" result.

Returns default
HTML
- Defined in src/HTML.ts:36

clear

clear(): default
Clear the innerHTML of the element.

Returns default
HTML
- Defined in src/HTML.ts:245

getHTML

getHTML(): string
Retrieve HTML content from the element.

Returns string
string
- Defined in src/HTML.ts:289

getText

getText(): string
Retrieve text content from the element. (as innerText, not trimmed)

Returns string
string
- Defined in src/HTML.ts:281

getValue

getValue(): string
Retrieve the value of the element. Only applicable if it is an input or textarea.

Returns string
string
- Defined in src/HTML.ts:297

html

html(val): default
Sets the text of the current element.
Parameters
- val: string
  The text to set to.
Returns default
HTML
- Defined in src/HTML.ts:27

id

id(val): default
Sets the ID of the element.
Parameters
- val: string
  The ID to set.
Returns default
HTML
- Defined in src/HTML.ts:77

on

on(ev, cb): default
Apply an event listener.
Parameters
- ev: string
  The event listener type to add.
- cb: EventListenerOrEventListenerObject
  The event listener callback to add.
Returns default
HTML
- Defined in src/HTML.ts:149

prepend

prepend(elem): default
Prepend an element. Typically used as a .prepend(new HTML(...)) call.
Parameters
- elem: string | default | HTMLElement
  The element to prepend.
Returns default
HTML
- Defined in src/HTML.ts:204

prependMany

prependMany(...elements): default
Prepend multiple elements. Typically used as a .prependMany(new HTML(...), new HTML(...) call.
Parameters
- Rest ...elements: any[]
  The elements to prepend.
Returns default
HTML
- Defined in src/HTML.ts:234

qs

qs(query): null | default
An easier querySelector method.
Parameters
- query: string
  The string to query
Returns null | default
a new HTML
- Defined in src/HTML.ts:55

qsa

qsa(query): null | (null | default)[]
An easier querySelectorAll method.
Parameters
- query: string
  The string to query
Returns null | (null | default)[]
a new HTML
- Defined in src/HTML.ts:64

query

query(selector): null | HTMLElement
querySelector something.
Parameters
- selector: string
  The query selector.
Returns null | HTMLElement
The HTML element (not as HTML)
- Defined in src/HTML.ts:46

style

style(obj): default
Apply CSS styles (dashed method.) Keys use CSS syntax, e.g. background-color.
Parameters
- obj: {
  [x: string]: string | null;
  }
  The styles to apply (as an object of key: value;.)
  - [x: string]: string | null
Returns default
HTML
- Defined in src/HTML.ts:123

styleJs

styleJs(obj): default
Apply CSS styles (JS method.) Keys use JS syntax, e.g. backgroundColor.
Parameters
- obj: {
  [key: string]: string | null;
  }
  The styles to apply (as an object of key: value;)
  - [key: string]: string | null
Returns default
HTML
- Defined in src/HTML.ts:135

swapRef

swapRef(elm): default
Swap the local elm with a new HTMLElement.
Parameters
- elm: HTMLElement
  The element to swap with.
Returns default
HTML
- Defined in src/HTML.ts:306

text

text(val): default
Sets the text of the current element.
Parameters
- val: string
  The text to set to.
Returns default
HTML
- Defined in src/HTML.ts:17

un

un(ev, cb): default
Remove an event listener.
Parameters
- ev: string
  The event listener type to remove.
- cb: EventListenerOrEventListenerObject
  The event listener callback to remove.
Returns default
HTML
- Defined in src/HTML.ts:160

val

val(str): default
Set the text value of the element. Only works if element is input or textarea.
Parameters
- str: any
  The value to set.
Returns default
HTML
- Defined in src/HTML.ts:271

`Static` from

from(elm): null | default
An alternative method to create an HTML instance.
Parameters
- elm: string | HTMLElement
  Element to create from.
Returns null | default
HTML
- Defined in src/HTML.ts:316

`Static` qs

qs(query): null | default
An easier querySelector method.
Parameters
- query: string
  The string to query
Returns null | default
a new HTML
- Defined in src/HTML.ts:330

`Static` qsa

qsa(query): null | (null | default)[]
An easier querySelectorAll method.
Parameters
- query: string
  The string to query
Returns null | (null | default)[]
a new HTML
- Defined in src/HTML.ts:339

Generated using TypeDoc