@finapi/web-form - v2.38.0

Index

Interfaces

Type aliases

Functions

load
unload

Type aliases

Environment

Environment: PublicEnvironment | "staging" | "releaseStaging"

All environments

LayoutConfig

LayoutConfig: "xs" | "sm" | "md" | "lg" | { lg: number; md: number; sm: number; xl: number; xs: number }

Responsive Layout Configuration.

PublicEnvironment

PublicEnvironment: "sandbox" | "live"

Publicly accessible environments.

WebFormLanguage

WebFormLanguage: "cs" | "de" | "en" | "fr" | "nl" | "pl" | "sk" | "tr"

Functions

load

load(target: HTMLElement, properties: WebFormProps, handlers?: WebFormHandlers, ownerDocument?: Document): void

Injects Web Component into the target HTMLElement. When this function is called for the first time, it will also create a new script tag that will fetch the Web Component source js file. Before the new Web Component, any previous instance will be first automatically unloaded.

Parameters
- target: HTMLElement
  
  a target element into which the Web Form will be appended as a child
- properties: WebFormProps
  
  Web Form properties
- Optional handlers: WebFormHandlers
  
  Web Form event handlers
- Optional ownerDocument: Document
  
  a document into which body a script tag that loads Web Component source is injected. If undefined, the globally-scoped document is selected.
Returns void

unload

unload(ownerDocument?: Document): void

Removes Web Component from the document.

Parameters
- Optional ownerDocument: Document
  
  a document in which the web component was injected
Returns void

Generated using TypeDoc