Type Alias FVTTSidebarAddData
beforeId?: string;
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
Optional
beforeId
The ID for the tab to place the new sidebar before. This must be an existing sidebar tab ID. THe stock Foundry sidebar tab IDs from left to right are:
Optional
condition
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 unique Sidebar ID / name. Used for CSS ID and retrieving the sidebar.
Optional
mergeAppImpl
Provides a custom base implementation for the object instance
for this sidebar app stored in globalThis.ui.<SIDEBAR ID>
.
Optional
popoutApplication
Provides a custom SvelteApp class to instantiate for the popout sidebar.
Optional
popoutOptions
Provides SvelteApp options overrides for the default popout sidebar.
Optional
popoutPostInitialize
An optional function invoked after the popout app has been created.
Optional
sidebarClasses
Additional CSS classes to add to the outer sidebar wrapper.
svelte
A Svelte configuration object.
Optional
title
The popout application title text or i18n lang key.
Optional
tooltip
The sidebar tab tooltip text or i18n lang key.
The configuration object to add a Svelte sidebar.