Type Alias FVTTSidebarReplaceData
condition?: boolean | (() => boolean);
icon: string | Embed;
id: string;
mergeAppImpl?: object;
popoutApplication?: SvelteApp;
popoutOptions?: object;
popoutPostInitialize?: (app: SvelteApp) => void;
sidebarClasses?: Iterable<string>;
svelte: Embed;
title?: string;
tooltip?: string;
}
Properties
Optionalcondition
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
The FontAwesome icon css classes or a Svelte configuration object to load a custom Svelte component to use as the "icon".
id
The ID for the sidebar to replace. This must be an existing sidebar tab ID.
OptionalmergeAppImpl
Provides a custom base implementation for the object instance for this sidebar
app stored in globalThis.ui.<SIDEBAR ID>.
OptionalpopoutApplication
Provides a custom SvelteApp class to instantiate for the popout sidebar.
OptionalpopoutOptions
Provides SvelteApp options overrides for the default popout sidebar.
OptionalpopoutPostInitialize
An optional function invoked after the popout app has been created.
OptionalsidebarClasses
Additional CSS classes to add to the outer sidebar wrapper.
svelte
A Svelte configuration object.
Optionaltitle
The popout application title text or i18n lang key.
Optionaltooltip
The sidebar tab tooltip text or i18n lang key.
The configuration object to replace a core sidebar with a Svelte sidebar.