Widget properties of the widgets built with the finAPI WebForm design system, which mirror the widget library's base-widget-wfds package. The design system is themed with a WebForm profile, therefore it leaves the core's theming slot empty. It contributes no properties of its own yet, and this interface is where they belong once it does.

interface ModBaseWidgetWfdsProperties {
    jsStaticResourcesServer?: string;
    scroll?: {
        enabled?: number;
        scrollYOffset?: number;
    };
    styleOverrides?: string;
}

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.

Generated using TypeDoc