Type Alias FVTTSidebarReplaceData

FVTTSidebarReplaceData: {
    condition?: boolean | (() => boolean);
    icon: string | TJSSvelteConfig;
    id: string;
    mergeAppImpl?: object;
    popoutApplication?: SvelteApplication;
    popoutOptions?: object;
    svelte: TJSSvelteConfig;
    title?: string;
    tooltip?: string;
}

The configuration object to replace a core sidebar with a Svelte sidebar.

Type declaration

  • Optionalcondition?: boolean | (() => boolean)

    A boolean value or function to invoke that returns a boolean value to control sidebar replacement. This is executed in the renderSidebar callback internally.

  • icon: string | TJSSvelteConfig

    The FontAwesome icon css classes or a Svelte configuration object to load a custom Svelte component to use as the "icon".

  • id: string

    The ID for the sidebar to replace. This must be an existing sidebar tab ID.

  • OptionalmergeAppImpl?: object

    Provides a custom base implementation for the object instance for this sidebar app stored in globalThis.ui.<SIDEBAR ID>.

  • OptionalpopoutApplication?: SvelteApplication

    Provides a custom SvelteApplication class to instantiate for the popout sidebar.

  • OptionalpopoutOptions?: object

    Provides SvelteApplication options overrides for the default popout sidebar.

  • svelte: TJSSvelteConfig

    A Svelte configuration object.

  • Optionaltitle?: string

    The popout application title text or i18n lang key.

  • Optionaltooltip?: string

    The sidebar tab tooltip text or i18n lang key.

Settings

Member Visibility