Widget properties of the widgets built with the finAPI design system, which mirror the widget library's base-widget-fds package. The design system fills the core's theming slot with the theme and themeOverrides properties.

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

Hierarchy (view full)

Properties

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
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.

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.

theme?: string

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

Default

finapi
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.

Generated using TypeDoc