Type Alias SvelteApplicationOptions

SvelteApplicationOptions: {
    defaultCloseAnimation?: boolean;
    draggable?: boolean;
    focusAuto?: boolean;
    focusKeep?: boolean;
    focusSource?: A11yFocusSource;
    focusTrap?: boolean;
    headerButtonNoClose?: boolean;
    headerButtonNoLabel?: boolean;
    headerIcon?: string;
    headerNoTitleMinimized?: boolean;
    minHeight?: number;
    minWidth?: number;
    positionable?: boolean;
    positionInitial?: InitialSystem;
    positionOrtho?: boolean;
    positionValidator?: ValidatorOption;
    sessionStorage?: WebStorage;
    svelte?: TJSSvelteConfig;
    transformOrigin?: TransformOrigin;
}

Options for SvelteApplication. Note: that this extends the Foundry ApplicationOptions.

Type declaration

  • OptionaldefaultCloseAnimation?: boolean

    If false the default slide close animation is not run.

  • Optionaldraggable?: boolean

    If true then application shells are draggable.

  • OptionalfocusAuto?: boolean

    When true auto-management of app focus is enabled.

  • OptionalfocusKeep?: boolean

    When focusAuto and focusKeep is true; keeps internal focus.

  • OptionalfocusSource?: A11yFocusSource
    • Defines A11yHelper focus source to apply when application closes.
  • OptionalfocusTrap?: boolean

    When true focus trapping / wrapping is enabled keeping focus inside app.

  • OptionalheaderButtonNoClose?: boolean

    If true then the close header button is removed.

  • OptionalheaderButtonNoLabel?: boolean

    If true then header button labels are removed.

  • OptionalheaderIcon?: string

    Sets a header icon given an image URL.

  • OptionalheaderNoTitleMinimized?: boolean

    If true then header title is hidden when minimized.

  • OptionalminHeight?: number

    Assigned to position. Number specifying minimum window height.

  • OptionalminWidth?: number

    Assigned to position. Number specifying minimum window width.

  • Optionalpositionable?: boolean

    If false then position.set does not take effect.

  • OptionalpositionInitial?: InitialSystem

    A helper for initial position placement.

  • OptionalpositionOrtho?: boolean

    When true TJSPosition is optimized for orthographic use.

  • OptionalpositionValidator?: ValidatorOption

    A validator function or data or list of validators.

  • OptionalsessionStorage?: WebStorage

    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 TJSSessionStorage instance is created per SvelteApplication.

  • Optionalsvelte?: TJSSvelteConfig

    A Svelte configuration object defining the main component.

  • OptionaltransformOrigin?: TransformOrigin

    By default, 'top / left' respects rotation when minimizing.

Settings

Member Visibility