Widget properties supported by every widget, independent of the design system the widget is built with. They mirror the widget library's base-widget-core package, except for the theming properties, which the core declares as a slot that each design system binding fills on its own.

interface ModBaseWidgetCoreProperties {
    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