Interface Options
baseApplication: string;
classes: string[];
defaultCloseAnimation: boolean;
draggable: boolean;
focusAuto: boolean;
focusKeep: boolean;
focusSource: A11yFocusSource;
focusTrap: boolean;
headerButtonNoClose: boolean;
headerButtonNoLabel: boolean;
headerIcon: string;
headerNoTitleMinimized: boolean;
height: string | number;
id: string;
left: string | number;
minHeight: number;
minimizable: boolean;
minWidth: number;
popOut: boolean;
positionable: boolean;
positionInitial: InitialSystem;
positionOrtho: boolean;
positionValidator: ValidatorOption;
resizable: boolean;
scale: number;
sessionStorage: WebStorage;
svelte: TJSSvelteConfig;
title: string;
top: string | number;
transformOrigin: TransformOrigin;
width: string | number;
}
Hierarchy
- ApplicationOptions
- Options
Index
Properties
Properties
baseApplication
A named base application which generates an additional hook.
classes
An array of CSS string classes to apply to the rendered HTML.
defaultCloseAnimation
If false the default slide close animation is not run.
draggable
If true then application shells are draggable.
focusAuto
When true auto-management of app focus is enabled.
focusKeep
When focusAuto and focusKeep is true; keeps internal focus.
focusSource
Defines A11yHelper focus source to apply when application closes.
@defaultValue: undefined
focusTrap
When true focus trapping / wrapping is enabled keeping focus inside app.
headerButtonNoClose
If true then the close header button is removed.
headerButtonNoLabel
If true then header button labels are removed.
headerIcon
Sets a header icon given an image URL.
headerNoTitleMinimized
If true then header title is hidden when minimized.
height
The default pixel height for app. You may also use relative units including percentages.
#runtime/svelte/store/position|Data.TJSPositionDataRelative.
id
The default CSS id to assign to the rendered HTML.
left
The default left offset position for app. You may also use relative units including percentages.
#runtime/svelte/store/position|Data.TJSPositionDataRelative.
minHeight
Assigned to position. Number specifying minimum window height.
minimizable
Whether the rendered application can be minimized (popOut only).
minWidth
Assigned to position. Number specifying minimum window width.
popOut
Whether to display the application as a pop-out container.
positionable
If false then position.set does not take effect.
positionInitial
A helper for initial position placement.
positionOrtho
When true TJSPosition is optimized for orthographic use.
positionValidator
A validator function or data or list of validators.
resizable
Whether the rendered application can be drag-resized (popOut only).
scale
A transformation scale for the app.
sessionStorage
An instance of WebStorage (session) to share across SvelteApplications. This is only required to share a WebStorage instance across multiple SvelteApplications. By default, a unique #runtime/svelte/store/web-storage|TJSSessionStorage instance is created per SvelteApplication.
svelte
A Svelte configuration object defining the main component.
title
A default window title string (popOut only); may be a language key.
top
The default top offset position for app. You may also use relative units including percentages.
#runtime/svelte/store/position|Data.TJSPositionDataRelative.
transformOrigin
By default, 'top / left' respects rotation when minimizing.
width
The default pixel height for app. You may also use relative units including percentages.
#runtime/svelte/store/position|Data.TJSPositionDataRelative.
Options for SvelteApplication. Note: that this extends the Foundry
ApplicationOptions.