default
FitFileViewer - API Documentation v29.4.0
FitFileViewer - API Documentation / utils/dom/domHelpers / default
Variable: default
default: {
addClass: (el:Element|null|undefined,className:string) =>void;clearElement: (el:Element|null|undefined) =>void;focus: (el:Element|null|undefined) =>void;getChecked: (el:Element|null|undefined) =>boolean|undefined;getData: (el:Element|null|undefined,key:string) =>string|undefined;getValue: (el:Element|null|undefined) =>string|undefined;isHTMLElement: (el:any) =>el is HTMLElement;on: (el:Element|null|undefined,type:string,handler: (ev:Event) =>void) =>void;query: (selector:string,root?:ParentNode) =>HTMLElement|null;queryAll: (selector:string,root?:ParentNode) =>HTMLElement[];removeClass: (el:Element|null|undefined,className:string) =>void;requireElement: (selector:string,root?:ParentNode) =>HTMLElement;setChecked: (el:Element|null|undefined,checked:boolean) =>void;setData: (el:Element|null|undefined,key:string,value:string) =>void;setDisabled: (el:Element|null|undefined,disabled:boolean) =>void;setStyle: (el:Element|null|undefined,prop:string,value:string) =>void;setText: (el:Element|null|undefined,value:string|number|null|undefined) =>void;setValue: (el:Element|null|undefined,value:string|number|null|undefined) =>void; }
Defined in: utils/dom/domHelpers.js:266
Type Declaration
addClass()
addClass: (
el:Element|null|undefined,className:string) =>void
Add a class to an element if present.
Parameters
el
Element | null | undefined
className
string
Returns
void
Throws
If className is empty
clearElement()
clearElement: (
el:Element|null|undefined) =>void
Remove all children from an element (no-op if invalid).
Parameters
el
Element | null | undefined
Returns
void
focus()
focus: (
el:Element|null|undefined) =>void
Focus an element if possible.
Parameters
el
Element | null | undefined
Returns
void
getChecked()
getChecked: (
el:Element|null|undefined) =>boolean|undefined
Get checked state for checkbox/radio if supported.
Parameters
el
Element | null | undefined
Returns
boolean | undefined
getData()
getData: (
el:Element|null|undefined,key:string) =>string|undefined
Dataset convenience getter.
Parameters
el
Element | null | undefined
key
string
Returns
string | undefined
getValue()
getValue: (
el:Element|null|undefined) =>string|undefined
Get value for input-like elements (returns undefined if unavailable).
Parameters
el
Element | null | undefined
Returns
string | undefined
isHTMLElement()
isHTMLElement: (
el:any) =>el is HTMLElement
Type guard to assert a value is an HTMLElement (vs generic Element or null).
Parameters
el
any
Returns
el is HTMLElement
on()
on: (
el:Element|null|undefined,type:string,handler: (ev:Event) =>void) =>void
Attach an event listener with automatic type narrowing and safe guard.
Parameters
el
Element | null | undefined
type
string
handler
(ev: Event) => void
Returns
void
query()
query: (
selector:string,root?:ParentNode) =>HTMLElement|null
Query a single element, returning a narrowed HTMLElement or null.
Parameters
selector
string
root?
ParentNode = document
Returns
HTMLElement | null
queryAll()
queryAll: (
selector:string,root?:ParentNode) =>HTMLElement[]
Query all matching elements as an array of HTMLElements (filters out non-HTMLElements).
Parameters
selector
string
root?
ParentNode = document
Returns
HTMLElement[]
removeClass()
removeClass: (
el:Element|null|undefined,className:string) =>void
Remove a class from an element if present.
Parameters
el
Element | null | undefined
className
string
Returns
void
Throws
If className is empty
requireElement()
requireElement: (
selector:string,root?:ParentNode) =>HTMLElement
Assert a required element exists and return it as HTMLElement. Throws a descriptive error if not found.
Parameters
selector
string
root?
ParentNode = document
Returns
HTMLElement
setChecked()
setChecked: (
el:Element|null|undefined,checked:boolean) =>void
Set checked state for checkbox/radio if supported.
Parameters
el
Element | null | undefined
checked
boolean
Returns
void
setData()
setData: (
el:Element|null|undefined,key:string,value:string) =>void
Dataset convenience setter.
Parameters
el
Element | null | undefined
key
string
value
string
Returns
void
setDisabled()
setDisabled: (
el:Element|null|undefined,disabled:boolean) =>void
Toggle disabled flag for form controls (HTMLElement subset supporting disabled). Silent no-op if element does not support the property.
Parameters
el
Element | null | undefined
disabled
boolean
Returns
void
setStyle()
setStyle: (
el:Element|null|undefined,prop:string,value:string) =>void
Apply a style property if possible.
Parameters
el
Element | null | undefined
prop
string
value
string
Returns
void
setText()
setText: (
el:Element|null|undefined,value:string|number|null|undefined) =>void
Safely set textContent on an element if it exists.
Parameters
el
Element | null | undefined
value
string | number | null | undefined
Returns
void
setValue()
setValue: (
el:Element|null|undefined,value:string|number|null|undefined) =>void
Set value for input-like elements if possible.
Parameters
el
Element | null | undefined
value
string | number | null | undefined
Returns
void