katanakit-js / IDomService

Interface: IDomService

Defined in: src/types/index.ts:189

Contract of the DOM facade.

Methods

useAddClass()

useAddClass(target, className): void;

Defined in: src/types/index.ts:203

Parameters

Parameter	Type
target	string | Element
className	string

Returns

void

---

useAppend()

useAppend(target, child): void;

Defined in: src/types/index.ts:224

Parameters

Parameter	Type
target	string | Element
child	string | Element

Returns

void

---

useCreateElement()

useCreateElement<T>(tagName, options?): HTMLElementTagNameMap[T];

Defined in: src/types/index.ts:218

Type Parameters

Type Parameter
T extends keyof HTMLElementTagNameMap

Parameters

Parameter	Type
tagName	T
options?	ElementCreationOptions

Returns

HTMLElementTagNameMap[T]

---

useGetAttribute()

useGetAttribute(target, attr): string | null;

Defined in: src/types/index.ts:207

Parameters

Parameter	Type
target	string | Element
attr	string

Returns

string | null

---

useGetBody()

useGetBody(): HTMLBodyElement | null;

Defined in: src/types/index.ts:192

Returns

HTMLBodyElement | null

---

useGetDataAttribute()

useGetDataAttribute(target, key): string | undefined;

Defined in: src/types/index.ts:210

Parameters

Parameter	Type
target	string | HTMLElement
key	string

Returns

string | undefined

---

useGetElementByClass()

useGetElementByClass<T>(className): T | null;

Defined in: src/types/index.ts:194

Type Parameters

Type Parameter	Default type
T extends HTMLElement	HTMLElement

Parameters

Parameter	Type
className	string

Returns

T | null

---

useGetElementById()

useGetElementById<T>(id): T | null;

Defined in: src/types/index.ts:193

Type Parameters

Type Parameter	Default type
T extends HTMLElement	HTMLElement

Parameters

Parameter	Type
id	string

Returns

T | null

---

useGetRoot()

useGetRoot(): HTMLElement | null;

Defined in: src/types/index.ts:191

Returns

HTMLElement | null

---

useHasClass()

useHasClass(target, className): boolean;

Defined in: src/types/index.ts:206

Parameters

Parameter	Type
target	string | Element
className	string

Returns

boolean

---

useIsBrowser()

useIsBrowser(): boolean;

Defined in: src/types/index.ts:190

Returns

boolean

---

useOn()

useOn<K>(
   target, 
   event, 
   callback, 
   options?
): (() => void) | null;

Defined in: src/types/index.ts:212

Type Parameters

Type Parameter
K extends keyof HTMLElementEventMap

Parameters

Parameter	Type
target	string | EventTarget
event	K
callback	(event) => void
options?	boolean | AddEventListenerOptions

Returns

(() => void) | null

---

useQuerySelector()

Call Signature

useQuerySelector<K>(selector): HTMLElementTagNameMap[K] | null;

Defined in: src/types/index.ts:195

Type Parameters

Type Parameter
K extends keyof HTMLElementTagNameMap

Parameters

Parameter	Type
selector	K

Returns

HTMLElementTagNameMap[K] | null

Call Signature

useQuerySelector<E>(selector): E | null;

Defined in: src/types/index.ts:198

Type Parameters

Type Parameter	Default type
E extends Element	HTMLElement

Parameters

Parameter	Type
selector	string

Returns

E | null

---

useQuerySelectorAll()

Call Signature

useQuerySelectorAll<K>(selector): HTMLElementTagNameMap[K][];

Defined in: src/types/index.ts:199

Type Parameters

Type Parameter
K extends keyof HTMLElementTagNameMap

Parameters

Parameter	Type
selector	K

Returns

HTMLElementTagNameMap[K][]

Call Signature

useQuerySelectorAll<E>(selector): E[];

Defined in: src/types/index.ts:202

Type Parameters

Type Parameter	Default type
E extends Element	HTMLElement

Parameters

Parameter	Type
selector	string

Returns

E[]

---

useRemove()

useRemove(target): void;

Defined in: src/types/index.ts:225

Parameters

Parameter	Type
target	string | Element

Returns

void

---

useRemoveAttribute()

useRemoveAttribute(target, attr): void;

Defined in: src/types/index.ts:209

Parameters

Parameter	Type
target	string | Element
attr	string

Returns

void

---

useRemoveClass()

useRemoveClass(target, className): void;

Defined in: src/types/index.ts:204

Parameters

Parameter	Type
target	string | Element
className	string | string[]

Returns

void

---

useSetAttribute()

useSetAttribute(
   target, 
   attr, 
   value
): void;

Defined in: src/types/index.ts:208

Parameters

Parameter	Type
target	string | Element
attr	string
value	string

Returns

void

---

useSetDataAttribute()

useSetDataAttribute(
   target, 
   key, 
   value
): void;

Defined in: src/types/index.ts:211

Parameters

Parameter	Type
target	string | HTMLElement
key	string
value	string

Returns

void

---

useSetHtml()

useSetHtml(target, html): void;

Defined in: src/types/index.ts:222

Parameters

Parameter	Type
target	string | Element
html	string

Returns

void

---

useSetText()

useSetText(target, text): void;

Defined in: src/types/index.ts:223

Parameters

Parameter	Type
target	string | Element
text	string

Returns

void

---

useToggleClass()

useToggleClass(
   target, 
   className, 
   force?
): boolean | undefined;

Defined in: src/types/index.ts:205

Parameters

Parameter	Type
target	string | Element
className	string
force?	boolean

Returns

boolean | undefined