Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • latest - stable release version that is tested and synced with the live production environment.

  • alpha - an unstable pre-release version that might be out of sync with the live production environment.

Configuring the Web Form Loader

Docs

Web Form Loader typedoc can be found here: https://webform-dist.finapi.io/latest/docs/modules.html.

Working with custom environments

The loader works by default with the Live environment (https://webform-live.finapi.io), but it might happen that you have a custom environment working on another subdomain, e.g. https://custom-webform.finapi.io. In such cases, please use the targetUrl parameter provided by the loader in order to overwrite the default behavior. You can always clarify with our Customer Support team if it applies to your setup.

Adjusting the layout of the web form

By default, the embedded web form will choose its layout config based on the current viewport size. Due to technical limitations, only the size of the “main” viewport is taken into consideration and the size of the actual web form component is ignored. That sometimes might lead to an undesired “look and feel” of the web page. In such cases, the default layout config can be overridden via the Loader property layoutConfig, where you can either use one of the predefined values (xs, sm, md, and lg) or provide your custom breakpoints. For the type definition of the property, check the typedoc.

Frontend callbacks

When embedding a web form in either way described above, callback functions can be passed directly to the web form loader during the initialization phase. These functions, if provided, will be triggered when the corresponding event occurs, e.g., when the web form is completed. In that way, you can either avoid using our “server” callbacks (listed in this section) or combine both approaches in order to provide the best user experience.

...