Skip to main content

.DOM

Direkter Zugriff auf DOM-Elemente und -Styles des Bot-Fensters (RAGAI.DOM).

Hintergrund

body/header/content/footer greifen auf feste, wohlbekannte Element-IDs des Bot-Grundgerüsts zu (bot-container/bot-header/bot-content/bot-footer) und liefern null, falls das jeweilige Element (noch) nicht im DOM existiert. hideHeader/showHeader arbeiten über eine CSS-Klasse auf document.body, hideFooter/showFooter direkt über style.display - beide Mechanismen sind rein präsentational und haben keinen Einfluss auf die Bot-Logik selbst.

Methoden

.body()

Gibt das Bot-Container-Element zurück.

Rückgabewert: HTMLElement | null

Das Container-Element, oder null.

Gibt das Bot-Header-Element zurück.

Rückgabewert: HTMLElement | null

Das Header-Element, oder null.

.content()

Gibt das Bot-Content-Element zurück.

Rückgabewert: HTMLElement | null

Das Content-Element, oder null.

Gibt das Bot-Footer-Element zurück.

Rückgabewert: HTMLElement | null

Das Footer-Element, oder null.

.hideFooter()

Blendet den Bot-Footer aus.

Rückgabewert: void

.showFooter()

Blendet den Bot-Footer ein.

Rückgabewert: void

.hideHeader()

Blendet den Bot-Header aus.

Rückgabewert: void

.showHeader()

Blendet den Bot-Header ein.

Rückgabewert: void

.createElementFromHTML(html)

Erstellt ein DOM-Element aus einem HTML-String.

ParameterTypBeschreibung
htmlstringDer HTML-String.

Rückgabewert: HTMLElement

Das erzeugte Element.

.styleVar(key, value?)

Setzt eine CSS-Custom-Property auf allen Elementen des Bots.

ParameterTypBeschreibung
keystring | z.input<typeof domStyleVarSchema>Name der CSS-Custom-Property, oder ein Objekt gemäß domStyleVarSchema.
valuestringDer zu setzende Wert.

Objekt-Form (validiert über domStyleVarSchema):

FeldTypPflichtBeschreibung
keystringName der CSS-Custom-Property.
valuestringDer zu setzende Wert.

Rückgabewert: void

.loadExternalJS(url)

Lädt ein externes JavaScript dynamisch nach.

ParameterTypBeschreibung
urlstring | z.input<typeof domUrlSchema>URL des Skripts, oder ein Objekt gemäß domUrlSchema.

Objekt-Form (validiert über domUrlSchema):

FeldTypPflichtBeschreibung
urlstringURL der nachzuladenden Ressource.

Rückgabewert: Promise<void>

Nichts, sobald das Skript geladen wurde.

.loadExternalCSS(url)

Lädt ein externes Stylesheet dynamisch nach.

ParameterTypBeschreibung
urlstring | z.input<typeof domUrlSchema>URL des Stylesheets, oder ein Objekt gemäß domUrlSchema.

Objekt-Form (validiert über domUrlSchema):

FeldTypPflichtBeschreibung
urlstringURL der nachzuladenden Ressource.

Rückgabewert: Promise<void>

Nichts, sobald das Stylesheet geladen wurde.

.setBodyColor(color)

Setzt die Hintergrundfarbe des Bot-Containers.

ParameterTypBeschreibung
colorstring | z.input<typeof domColorSchema>Die zu setzende Farbe, oder ein Objekt gemäß domColorSchema.

Objekt-Form (validiert über domColorSchema):

FeldTypPflichtBeschreibung
colorstringDie zu setzende Farbe (CSS-Farbwert).

Rückgabewert: void