Interface ModBaseWidgetProperties

interface ModBaseWidgetProperties {
    jsStaticResourcesServer?: string;
    scroll?: {
        enabled?: number;
        scrollYOffset?: number;
    };
    styleOverrides?: string;
    theme?: string;
    themeOverrides?: Record<string, unknown>;
    useContainedDialogs?: boolean;
}

Hierarchy (view full)

Properties

jsStaticResourcesServer? scroll? styleOverrides? theme? themeOverrides? useContainedDialogs?

Properties

Optional jsStaticResourcesServer

jsStaticResourcesServer?: string

Server URL where the static resources are hosted.

Static resources are assets required to run the widget but are not included in the widget bundle itself, for example images or fonts.

Default

https://js-static-resources-finapi-general-live.finapi.io

Optional scroll

scroll?: {
    enabled?: number;
    scrollYOffset?: number;
}

Type declaration

  • Optional enabled?: number

    Upon setting this parameter to true window.history.scrollRestoration behaviour will be changed to manual in order for manual scroll to restore its position properly when navigating usign back/forward buttons.

  • Optional scrollYOffset?: number

    ' Sets offset relative to widget element offset. Usually used for adding offset for the main menu.

Optional styleOverrides

styleOverrides?: string

styleOverrides enables you to supply the URL of a stylesheet which will be loaded in the widget scope using <link rel="stylesheet" href={styleOverrides} type="text/css" />. To find out which CSS classes are available for override, please refer to the widget class documentation.

Optional theme

theme?: string

The theme property enables you to select a predefined theme to be applied to the widget.

Default

finapi

Optional themeOverrides

themeOverrides?: Record<string, unknown>

Our theme extends the default Material UI theme, which can be found at https://mui.com/material-ui/customization/default-theme/#main-content. themeOverrides can be used to customize the theme settings for specific cases. If you need help with this, please contact our customer support for assistance.

Optional useContainedDialogs

useContainedDialogs?: boolean

The widget will be embedded in a container that you provide. If useContainedDialogs is set to true, the dialogs and modal elements, along with the overlay, will be contained within the container. If it is set to false, the overlay and modals will cover the entire host page.

Default

true

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc