IDomService
katanakit-js / IDomService
Interface: IDomService
Section titled “Interface: IDomService”Defined in: types/core/dom.ts:29
Contract of the DOM facade.
Methods
Section titled “Methods”useAddClass()
Section titled “useAddClass()”useAddClass(target, className): void;Defined in: types/core/dom.ts:43
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
target |
string | Element |
className |
string |
Returns
Section titled “Returns”void
useAppend()
Section titled “useAppend()”useAppend(target, child): void;Defined in: types/core/dom.ts:64
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
target |
string | Element |
child |
string | Element |
Returns
Section titled “Returns”void
useCreateElement()
Section titled “useCreateElement()”useCreateElement<T>(tagName, options?): HTMLElementTagNameMap[T];Defined in: types/core/dom.ts:58
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
T extends keyof HTMLElementTagNameMap |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
tagName |
T |
options? |
ElementCreationOptions |
Returns
Section titled “Returns”HTMLElementTagNameMap[T]
useGetAttribute()
Section titled “useGetAttribute()”useGetAttribute(target, attr): string | null;Defined in: types/core/dom.ts:47
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
target |
string | Element |
attr |
string |
Returns
Section titled “Returns”string | null
useGetBody()
Section titled “useGetBody()”useGetBody(): HTMLBodyElement | null;Defined in: types/core/dom.ts:32
Returns
Section titled “Returns”HTMLBodyElement | null
useGetDataAttribute()
Section titled “useGetDataAttribute()”useGetDataAttribute(target, key): string | undefined;Defined in: types/core/dom.ts:50
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
target |
string | HTMLElement |
key |
string |
Returns
Section titled “Returns”string | undefined
useGetElementByClass()
Section titled “useGetElementByClass()”useGetElementByClass<T>(className): T | null;Defined in: types/core/dom.ts:34
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
T extends HTMLElement |
HTMLElement |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
className |
string |
Returns
Section titled “Returns”T | null
useGetElementById()
Section titled “useGetElementById()”useGetElementById<T>(id): T | null;Defined in: types/core/dom.ts:33
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
T extends HTMLElement |
HTMLElement |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
string |
Returns
Section titled “Returns”T | null
useGetRoot()
Section titled “useGetRoot()”useGetRoot(): HTMLElement | null;Defined in: types/core/dom.ts:31
Returns
Section titled “Returns”HTMLElement | null
useHasClass()
Section titled “useHasClass()”useHasClass(target, className): boolean;Defined in: types/core/dom.ts:46
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
target |
string | Element |
className |
string |
Returns
Section titled “Returns”boolean
useIsBrowser()
Section titled “useIsBrowser()”useIsBrowser(): boolean;Defined in: types/core/dom.ts:30
Returns
Section titled “Returns”boolean
useOn()
Section titled “useOn()”useOn<K>( target, event, callback, options?): (() => void) | null;Defined in: types/core/dom.ts:52
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
K extends keyof HTMLElementEventMap |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
target |
string | EventTarget |
event |
K |
callback |
(event) => void |
options? |
boolean | AddEventListenerOptions |
Returns
Section titled “Returns”(() => void) | null
useQuerySelector()
Section titled “useQuerySelector()”Call Signature
Section titled “Call Signature”useQuerySelector<K>(selector): HTMLElementTagNameMap[K] | null;Defined in: types/core/dom.ts:35
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
K extends keyof HTMLElementTagNameMap |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
selector |
K |
Returns
Section titled “Returns”HTMLElementTagNameMap[K] | null
Call Signature
Section titled “Call Signature”useQuerySelector<E>(selector): E | null;Defined in: types/core/dom.ts:38
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
E extends Element |
HTMLElement |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
selector |
string |
Returns
Section titled “Returns”E | null
useQuerySelectorAll()
Section titled “useQuerySelectorAll()”Call Signature
Section titled “Call Signature”useQuerySelectorAll<K>(selector): HTMLElementTagNameMap[K][];Defined in: types/core/dom.ts:39
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
K extends keyof HTMLElementTagNameMap |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
selector |
K |
Returns
Section titled “Returns”HTMLElementTagNameMap[K][]
Call Signature
Section titled “Call Signature”useQuerySelectorAll<E>(selector): E[];Defined in: types/core/dom.ts:42
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
E extends Element |
HTMLElement |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
selector |
string |
Returns
Section titled “Returns”E[]
useRemove()
Section titled “useRemove()”useRemove(target): void;Defined in: types/core/dom.ts:65
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
target |
string | Element |
Returns
Section titled “Returns”void
useRemoveAttribute()
Section titled “useRemoveAttribute()”useRemoveAttribute(target, attr): void;Defined in: types/core/dom.ts:49
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
target |
string | Element |
attr |
string |
Returns
Section titled “Returns”void
useRemoveClass()
Section titled “useRemoveClass()”useRemoveClass(target, className): void;Defined in: types/core/dom.ts:44
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
target |
string | Element |
className |
string | string[] |
Returns
Section titled “Returns”void
useSetAttribute()
Section titled “useSetAttribute()”useSetAttribute( target, attr, value): void;Defined in: types/core/dom.ts:48
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
target |
string | Element |
attr |
string |
value |
string |
Returns
Section titled “Returns”void
useSetDataAttribute()
Section titled “useSetDataAttribute()”useSetDataAttribute( target, key, value): void;Defined in: types/core/dom.ts:51
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
target |
string | HTMLElement |
key |
string |
value |
string |
Returns
Section titled “Returns”void
useSetHtml()
Section titled “useSetHtml()”useSetHtml(target, html): void;Defined in: types/core/dom.ts:62
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
target |
string | Element |
html |
string |
Returns
Section titled “Returns”void
useSetText()
Section titled “useSetText()”useSetText(target, text): void;Defined in: types/core/dom.ts:63
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
target |
string | Element |
text |
string |
Returns
Section titled “Returns”void
useToggleClass()
Section titled “useToggleClass()”useToggleClass( target, className, force?): boolean | undefined;Defined in: types/core/dom.ts:45
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
target |
string | Element |
className |
string |
force? |
boolean |
Returns
Section titled “Returns”boolean | undefined