Returns the draggable app option.
Draggable app option.
Sets this.options.draggable
which is reactive for application shells.
Sets the draggable option.
Returns the current dragging UI state.
Dragging UI state.
Returns the focusAuto app option.
When true auto-management of app focus is enabled.
Sets this.options.focusAuto
which is reactive for application shells.
Sets the focusAuto option.
Returns the focusKeep app option.
When focusAuto
and focusKeep
is true; keeps internal focus.
Sets this.options.focusKeep
which is reactive for application shells.
Sets the focusKeep option.
Returns the focusTrap app option.
When true focus trapping / wrapping is enabled keeping focus inside app.
Sets this.options.focusTrap
which is reactive for application shells.
Sets the focusTrap option.
Returns the headerButtonNoClose app option.
Remove the close the button in header app option.
Sets this.options.headerButtonNoClose
which is reactive for application shells.
Sets the headerButtonNoClose option.
Returns the headerButtonNoLabel app option.
Remove the labels from buttons in header app option.
Sets this.options.headerButtonNoLabel
which is reactive for application shells.
Sets the headerButtonNoLabel option.
Returns the headerIcon app option.
URL for header app icon.
Sets this.options.headerIcon
which is reactive for application shells.
Sets the headerButtonNoLabel option.
Returns the headerNoTitleMinimized app option.
When true removes the header title when minimized.
Sets this.options.headerNoTitleMinimized
which is reactive for application shells.
Sets the headerNoTitleMinimized option.
Returns the minimizable app option.
Minimizable app option.
Sets this.options.minimizable
which is reactive for application shells that are also pop out.
Sets the minimizable option.
Returns the current minimized UI state.
Minimized UI state.
Returns the Foundry popOut state; ApplicationOptions.popOut
Positionable app option.
Sets this.options.popOut
which is reactive for application shells. This will add / remove this application
from ui.windows
.
Sets the popOut option.
Returns the positionable app option; SvelteApplicationOptions.positionable
Positionable app option.
Sets this.options.positionable
enabling / disabling SvelteApplication.position.
Sets the positionable option.
Returns the resizable option.
Resizable app option.
Sets this.options.resizable
which is reactive for application shells.
Sets the resizable option.
Returns the current resizing UI state.
Resizing UI state.
Returns TJSWebStorage (session) instance.
Returns the store for app options.
App options store.
Returns the store for UI options.
UI options store.
Returns the title accessor from the parent Application class; ApplicationOptions.title
Title.
Sets this.options.title
which is reactive for application shells.
Note: Will set empty string if title is undefined or null.
Application title; will be localized, so a translation key is fine.
Provides a way to safely get this applications options given an accessor string which describes the
entries to walk. To access deeper entries into the object format the accessor string with .
between entries
to walk.
The path / key to set. You can set multiple levels.
Optional
defaultValue: anyA default value returned if the accessor is not found.
Value at the accessor.
Provides a way to safely set this applications options given an accessor string which describes the
entries to walk. To access deeper entries into the object format the accessor string with .
between entries
to walk.
Additionally, if an application shell Svelte component is mounted and exports the appOptions
property then
the application options is set to appOptions
potentially updating the application shell / Svelte component.
The path / key to set. You can set multiple levels.
Value to set.
Updates the UI Options store with the current header buttons. You may dynamically add / remove header buttons
if using an application shell Svelte component. In either overriding _getHeaderButtons
or responding to the
Hooks fired return a new button array and the uiOptions store is updated and the application shell will render
the new buttons.
Optionally you can set in the SvelteApplication app options SvelteApplicationOptions.headerButtonNoClose to remove the close button and SvelteApplicationOptions.headerButtonNoLabel to true and labels will be removed from the header buttons.
Optional
opts: { Optional parameters (for internal use)
Optional
headerThe value for headerButtonNoClose
.
Optional
headerThe value for headerButtonNoLabel
.
Contains the reactive functionality / Svelte stores associated with SvelteApplication and retrievable by SvelteApplication.reactive.
There are several reactive getters for UI state such and for two-way bindings / stores see SvelteReactive.storeUIState:
There are also reactive getters / setters for SvelteApplicationOptions and Foundry ApplicationOptions. You can use the following as one way bindings and update the associated stores. For two-way bindings / stores see SvelteReactive.storeAppOptions.
An instance of TJSWebStorage (session) / TJSSessionStorage is accessible via SvelteReactive.sessionStorage. Optionally you can pass in an existing TJSWebStorage instance that can be shared across multiple SvelteApplications by setting SvelteApplicationOptions.sessionStorage.
This API is not sealed, and it is recommended that you extend it with accessors to get / set data that is reactive in your application. An example of setting an exported prop
document
from the main mounted application shell.Example