Class Settings

The sidebar settings tab.

Mixes

HandlebarsApplication

Hierarchy (View Summary)

Constructors

constructor

Properties

options position tabGroups _appId _maxZ BASE_APPLICATION DEFAULT_OPTIONS emittedEvents PARTS RENDER_STATES tabName TABS

Accessors

active classList element form hasFrame id isPopout minimized popout rendered state tabName title window

Methods

_awaitTransition _doEvent _initializeApplicationOptions _onClose _onFirstRender _onRender _prepareContext _renderFrame _renderHTML activate addEventListener bringToFront changeTab close dispatchEvent maximize minimize removeEventListener render renderPopout setPosition submit toggleControls _attachFrameListeners _canRender _configureRenderOptions _createContextMenu _getHeaderControls _getTabsConfig _headerControlButtons _insertElement _onActivate _onChangeForm _onClickAction _onClickTab _onDeactivate _onPosition _onSubmitForm _postRender _preClose _preFirstRender _prepareTabs _prePosition _preRender _removeElement _renderHeaderControl _replaceHTML _tearDown _updateFrame _updatePosition inheritanceChain parseCSSDimension waitForImages

Constructors

constructor

  • new Settings(options?: Partial<ApplicationConfiguration>): Settings

    Applications are constructed by providing an object of configuration options.

    Parameters

    Returns Settings

Properties

options

options: Readonly<ApplicationConfiguration>

Application instance configuration options.

position

position: ApplicationPosition = ...

The current position of the application with respect to the window.document.body.

tabGroups

tabGroups: Record<string, null | string> = ...

If this Application uses tabbed navigation groups, this mapping is updated whenever the changeTab method is called. Reports the active tab for each group, with a value of null indicating no tab is active. Subclasses may override this property to define default tabs for each group.

Static Internal_appId

_appId: number = 0

An incrementing integer Application ID.

Static Internal_maxZ

_maxZ: number = ...

The current maximum z-index of any displayed Application.

StaticBASE_APPLICATION

BASE_APPLICATION: typeof ApplicationV2 = ApplicationV2

Designates which upstream Application class in this class' inheritance chain is the base application. Any DEFAULT_OPTIONS of super-classes further upstream of the BASE_APPLICATION are ignored. Hook events for super-classes further upstream of the BASE_APPLICATION are not dispatched.

StaticDEFAULT_OPTIONS

DEFAULT_OPTIONS: {
    actions: {
        notifyUpdate: (event: any) => Promise<void>;
        openApp: (...this: any, event: any) => Promise<void>;
    };
    window: { title: string };
} = ...

StaticemittedEvents

emittedEvents: readonly [
    "render",
    "close",
    "position",
    "activate",
    "deactivate",
] = ...

StaticPARTS

PARTS: { settings: { root: boolean; template: string } } = ...

StaticRENDER_STATES

RENDER_STATES: Record<string, number> = ...

The sequence of rendering states that describe the Application life-cycle.

StatictabName

tabName: string = "settings"

StaticTABS

TABS: Record<string, ApplicationTabsConfiguration> = {}

Configuration of application tabs, with an entry per tab group.

Accessors

active

  • get active(): boolean

    Whether this tab is currently active in the sidebar.

    Returns boolean

classList

  • get classList(): DOMTokenList

    The CSS class list of this Application instance

    Returns DOMTokenList

element

  • get element(): HTMLElement

    The HTMLElement which renders this Application into the DOM.

    Returns HTMLElement

form

  • get form(): null | HTMLFormElement

    Does this Application have a top-level form element?

    Returns null | HTMLFormElement

hasFrame

  • get hasFrame(): boolean

    Does this Application instance render within an outer window frame?

    Returns boolean

id

  • get id(): string

    The HTML element ID of this Application instance. This provides a readonly view into the internal ID used by this application. This getter should not be overridden by subclasses, which should instead configure the ID in DEFAULT_OPTIONS or by defining a uniqueId during _initializeApplicationOptions.

    Returns string

isPopout

  • get isPopout(): boolean

    Whether this is the popped-out tab or the in-sidebar one.

    Returns boolean

minimized

  • get minimized(): boolean

    Is this Application instance currently minimized?

    Returns boolean

popout

rendered

  • get rendered(): boolean

    Is this Application instance currently rendered?

    Returns boolean

state

  • get state(): number

    The current render state of the Application.

    Returns number

tabName

  • get tabName(): string

    The base name of the sidebar tab.

    Returns string

title

  • get title(): string

    A convenience reference to the title of the Application window.

    Returns string

window

  • get window(): {
        close: HTMLButtonElement;
        content: HTMLElement;
        controls: HTMLButtonElement;
        controlsDropdown: HTMLDivElement;
        header: HTMLElement;
        icon: HTMLElement;
        onDrag: Function;
        onResize: Function;
        pointerMoveThrottle: boolean;
        pointerStartPosition: ApplicationPosition;
        resize: HTMLElement;
        title: HTMLHeadingElement;
    }

    Convenience references to window header elements.

    Returns {
        close: HTMLButtonElement;
        content: HTMLElement;
        controls: HTMLButtonElement;
        controlsDropdown: HTMLDivElement;
        header: HTMLElement;
        icon: HTMLElement;
        onDrag: Function;
        onResize: Function;
        pointerMoveThrottle: boolean;
        pointerStartPosition: ApplicationPosition;
        resize: HTMLElement;
        title: HTMLHeadingElement;
    }

Methods

_awaitTransition

  • _awaitTransition(element: HTMLElement, timeout: number): Promise<void>
    Internal

    Wait for a CSS transition to complete for an element.

    Parameters

    • element: HTMLElement

      The element which is transitioning

    • timeout: number

      A timeout in milliseconds in case the transitionend event does not occur

    Returns Promise<void>

_doEvent

  • _doEvent(
        handler: Function,
        options?: {
            async?: boolean;
            debugText?: string;
            eventName?: string;
            handlerArgs?: any[];
            hookArgs?: any[];
            hookName?: string;
            hookResponse?: boolean;
            parentClassHooks?: boolean;
        },
    ): void
    | Promise<void>
    Internal

    Perform an event in the application life-cycle. Await an internal life-cycle method defined by the class. Optionally dispatch an event for any registered listeners.

    Parameters

    • handler: Function

      A handler function to call

    • options: {
          async?: boolean;
          debugText?: string;
          eventName?: string;
          handlerArgs?: any[];
          hookArgs?: any[];
          hookName?: string;
          hookResponse?: boolean;
          parentClassHooks?: boolean;
      } = {}

      Options which configure event handling

      • Optionalasync?: boolean

        Await the result of the handler function?

      • OptionaldebugText?: string

        Debugging text to log for the event

      • OptionaleventName?: string

        An event name to dispatch for registered listeners

      • OptionalhandlerArgs?: any[]

        Arguments passed to the handler function

      • OptionalhookArgs?: any[]

        Arguments passed to the requested hook function

      • OptionalhookName?: string

        A hook name to dispatch for this and all parent classes

      • OptionalhookResponse?: boolean

        Add the handler response to hookArgs

      • OptionalparentClassHooks?: boolean

        Call hooks for parent classes in the inheritance chain?

    Returns void | Promise<void>

    A promise which resoles once the handler is complete if async is true

_initializeApplicationOptions

_onClose

  • _onClose(options: any): void

    Parameters

    • options: any

    Returns void

    Inherit Doc

_onFirstRender

  • _onFirstRender(context: any, options: any): Promise<void>

    Parameters

    • context: any
    • options: any

    Returns Promise<void>

    Inherit Doc

_onRender

  • _onRender(context: any, options: any): Promise<void>

    Parameters

    • context: any
    • options: any

    Returns Promise<void>

    Inherit Doc

_prepareContext

  • _prepareContext(
        options: any,
    ): Promise<
        ApplicationRenderContext & {
            canConfigure: boolean;
            canEditWorld: boolean;
            canManagePlayers: boolean;
            canReturnSetup: boolean;
            coreUpdate: null
            | string;
            isDemo: any;
            issues: number;
            modules: any;
            release: any;
            system: System;
            systemUpdate: null | string;
            versionDisplay: string;
        },
    >

    Parameters

    • options: any

    Returns Promise<
        ApplicationRenderContext & {
            canConfigure: boolean;
            canEditWorld: boolean;
            canManagePlayers: boolean;
            canReturnSetup: boolean;
            coreUpdate: null
            | string;
            isDemo: any;
            issues: number;
            modules: any;
            release: any;
            system: System;
            systemUpdate: null | string;
            versionDisplay: string;
        },
    >

    Inherit Doc

_renderFrame

  • _renderFrame(options: any): Promise<HTMLElement>

    Parameters

    • options: any

    Returns Promise<HTMLElement>

    Inherit Doc

Abstract_renderHTML

  • _renderHTML(
        context: ApplicationRenderContext,
        options: ApplicationRenderOptions,
    ): Promise<any>

    Render an HTMLElement for the Application. An Application subclass must implement this method in order for the Application to be renderable.

    Parameters

    Returns Promise<any>

    The result of HTML rendering may be implementation specific. Whatever value is returned here is passed to _replaceHTML

activate

  • activate(): void

    Activate this tab in the sidebar.

    Returns void

addEventListener

  • addEventListener(
        type: string,
        listener: EmittedEventListener,
        options?: { once?: boolean },
    ): void

    Add a new event listener for a certain type of event.

    Parameters

    • type: string

      The type of event being registered for

    • listener: EmittedEventListener

      The listener function called when the event occurs

    • Optionaloptions: { once?: boolean } = {}

      Options which configure the event listener

      • Optionalonce?: boolean

        Should the event only be responded to once and then removed

    Returns void

    See

    https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener

bringToFront

  • bringToFront(): void

    Bring this Application window to the front of the rendering stack by increasing its z-index. Once ApplicationV1 is deprecated we should switch from _maxZ to ApplicationV2#maxZ We should also eliminate ui.activeWindow in favor of only ApplicationV2#frontApp

    Returns void

changeTab

  • changeTab(
        tab: string,
        group: string,
        options?: {
            event?: Event;
            force?: boolean;
            navElement?: HTMLElement;
            updatePosition?: boolean;
        },
    ): void

    Change the active tab within a tab group in this Application instance.

    Parameters

    • tab: string

      The name of the tab which should become active

    • group: string

      The name of the tab group which defines the set of tabs

    • Optionaloptions: {
          event?: Event;
          force?: boolean;
          navElement?: HTMLElement;
          updatePosition?: boolean;
      } = {}

      Additional options which affect tab navigation

      • Optionalevent?: Event

        An interaction event which caused the tab change, if any

      • Optionalforce?: boolean

        Force changing the tab even if the new tab is already active

      • OptionalnavElement?: HTMLElement

        An explicit navigation element being modified

      • OptionalupdatePosition?: boolean

        Update application position after changing the tab?

    Returns void

close

  • close(options?: Partial<ApplicationClosingOptions>): Promise<Settings>

    Close the Application, removing it from the DOM.

    Parameters

    Returns Promise<Settings>

    A Promise which resolves to the closed Application instance

dispatchEvent

maximize

  • maximize(): Promise<void>

    Restore the Application to its original dimensions.

    Returns Promise<void>

minimize

  • minimize(): Promise<void>

    Minimize the Application, collapsing it to a minimal header.

    Returns Promise<void>

removeEventListener

render

  • render(options: any, _options: any): Promise<Settings>

    Parameters

    • options: any
    • _options: any

    Returns Promise<Settings>

    Inherit Doc

renderPopout

setPosition

  • setPosition(position?: Partial<ApplicationPosition>): void | ApplicationPosition

    Update the Application element position using provided data which is merged with the prior position.

    Parameters

    Returns void | ApplicationPosition

    The updated application position

submit

  • submit(submitOptions?: object): Promise<any>

    Programmatically submit an ApplicationV2 instance which implements a single top-level form.

    Parameters

    • OptionalsubmitOptions: object = {}

      Arbitrary options which are supported by and provided to the configured form submission handler.

    Returns Promise<any>

    A promise that resolves to the returned result of the form submission handler, if any.

toggleControls

  • toggleControls(
        expanded?: boolean,
        options?: { animate?: boolean },
    ): Promise<void>

    Toggle display of the Application controls menu. Only applicable to window Applications.

    Parameters

    • Optionalexpanded: boolean

      Set the controls visibility to a specific state. Otherwise, the visible state is toggled from its current value

    • Optionaloptions: { animate?: boolean } = {}

      Options to configure the toggling behavior.

      • Optionalanimate?: boolean

        Animate the controls toggling.

    Returns Promise<void>

    A Promise which resolves once the control expansion animation is complete

Protected_attachFrameListeners

  • _attachFrameListeners(): void
    Protected

    Attach event listeners to the Application frame.

    Returns void

Protected_canRender

  • _canRender(options: ApplicationRenderOptions): false | void
    Protected

    Test whether this Application is allowed to be rendered.

    Parameters

    Returns false | void

    Return false to prevent rendering

    Throws

    An Error to display a warning message

Protected_configureRenderOptions

  • _configureRenderOptions(options: ApplicationRenderOptions): void
    Protected

    Modify the provided options passed to a render request.

    Parameters

    Returns void

Protected_createContextMenu

  • _createContextMenu(
        handler: () => ContextMenuEntry[],
        selector: string,
        options?: {
            container?: HTMLElement;
            hookName?: string;
            parentClassHooks?: boolean;
        },
    ): null
    | ContextMenu
    Protected

    Create a ContextMenu instance used in this Application.

    Parameters

    • handler: () => ContextMenuEntry[]

      A handler function that provides initial context options

    • selector: string

      A CSS selector to which the ContextMenu will be bound

    • Optionaloptions: { container?: HTMLElement; hookName?: string; parentClassHooks?: boolean } = {}

      Additional options which affect ContextMenu construction

      • Optionalcontainer?: HTMLElement

        A parent HTMLElement which contains the selector target

      • OptionalhookName?: string

        The hook name

      • OptionalparentClassHooks?: boolean

        Whether to call hooks for the parent classes in the inheritance chain.

    Returns null | ContextMenu

    A created ContextMenu or null if no menu items were defined

Protected_getHeaderControls

Protected_getTabsConfig

  • _getTabsConfig(group: string): null | ApplicationTabsConfiguration
    Protected

    Get the configuration for a tabs group.

    Parameters

    • group: string

      The ID of a tabs group

    Returns null | ApplicationTabsConfiguration

Protected_headerControlButtons

  • _headerControlButtons(): Generator<ApplicationHeaderControlsEntry, any, any>
    Protected

    Iterate over header control buttons, filtering for controls which are visible for the current client.

    Returns Generator<ApplicationHeaderControlsEntry, any, any>

    Yields

Protected_insertElement

  • _insertElement(element: HTMLElement): void
    Protected

    Insert the application HTML element into the DOM. Subclasses may override this method to customize how the application is inserted.

    Parameters

    • element: HTMLElement

      The element to insert

    Returns void

Protected_onActivate

  • _onActivate(): void
    Protected

    Actions performed when this tab is activated in the sidebar.

    Returns void

Protected_onChangeForm

  • _onChangeForm(formConfig: ApplicationFormConfiguration, event: Event): void
    Protected

    Handle changes to an input element within the form.

    Parameters

    • formConfig: ApplicationFormConfiguration

      The form configuration for which this handler is bound

    • event: Event

      An input change event within the form

    Returns void

Protected_onClickAction

  • _onClickAction(event: PointerEvent, target: HTMLElement): void
    Protected

    A generic event handler for action clicks which can be extended by subclasses. Action handlers defined in DEFAULT_OPTIONS are called first. This method is only called for actions which have no defined handler.

    Parameters

    • event: PointerEvent

      The originating click event

    • target: HTMLElement

      The capturing HTML element which defined a [data-action]

    Returns void

Protected_onClickTab

  • _onClickTab(event: PointerEvent): void
    Protected

    Handle click events on a tab within the Application.

    Parameters

    • event: PointerEvent

    Returns void

Protected_onDeactivate

  • _onDeactivate(): void
    Protected

    Actions performed when this tab is deactivated in the sidebar.

    Returns void

Protected_onPosition

  • _onPosition(position: ApplicationPosition): void
    Protected

    Actions performed after the Application is re-positioned.

    Parameters

    Returns void

Protected_onSubmitForm

  • _onSubmitForm(
        formConfig: ApplicationFormConfiguration,
        event: Event | SubmitEvent,
    ): Promise<void>
    Protected

    Handle submission for an Application which uses the form element.

    Parameters

    • formConfig: ApplicationFormConfiguration

      The form configuration for which this handler is bound

    • event: Event | SubmitEvent

      The form submission event

    Returns Promise<void>

Protected_postRender

Protected_preClose

  • _preClose(options: ApplicationRenderOptions): Promise<void>
    Protected

    Actions performed before closing the Application. Pre-close steps are awaited by the close process.

    Parameters

    Returns Promise<void>

Protected_preFirstRender

Protected_prepareTabs

  • _prepareTabs(group: string): Record<string, ApplicationTab>
    Protected

    Prepare application tab data for a single tab group.

    Parameters

    • group: string

      The ID of the tab group to prepare

    Returns Record<string, ApplicationTab>

Protected_prePosition

  • _prePosition(position: ApplicationPosition): void
    Protected

    Actions performed before the Application is re-positioned. Pre-position steps are not awaited because setPosition is synchronous.

    Parameters

    Returns void

Protected_preRender

Protected_removeElement

  • _removeElement(element: HTMLElement): void
    Protected

    Remove the application HTML element from the DOM. Subclasses may override this method to customize how the application element is removed.

    Parameters

    • element: HTMLElement

      The element to be removed

    Returns void

Protected_renderHeaderControl

Protected_replaceHTML

  • _replaceHTML(
        result: any,
        content: HTMLElement,
        options: ApplicationRenderOptions,
    ): void
    Protected

    Replace the HTML of the application with the result provided by the rendering backend. An Application subclass should implement this method in order for the Application to be renderable.

    Parameters

    • result: any

      The result returned by the application rendering backend

    • content: HTMLElement

      The content element into which the rendered result must be inserted

    • options: ApplicationRenderOptions

      Options which configure application rendering behavior

    Returns void

Protected_tearDown

  • _tearDown(options: ApplicationClosingOptions): void
    Protected

    Remove elements from the DOM and trigger garbage collection as part of application closure.

    Parameters

    Returns void

Protected_updateFrame

  • _updateFrame(options: ApplicationRenderOptions): void
    Protected

    When the Application is rendered, optionally update aspects of the window frame.

    Parameters

    Returns void

Protected_updatePosition

  • _updatePosition(position: ApplicationPosition): ApplicationPosition
    Protected

    Translate a requested application position updated into a resolved allowed position for the Application. Subclasses may override this method to implement more advanced positioning behavior.

    Parameters

    Returns ApplicationPosition

    Resolved Application positioning data

StaticinheritanceChain

  • inheritanceChain(): Generator<typeof ApplicationV2, void, unknown>

    Iterate over the inheritance chain of this Application. The chain includes this Application itself and all parents until the base application is encountered.

    Returns Generator<typeof ApplicationV2, void, unknown>

    See

    ApplicationV2.BASE_APPLICATION

    Yields

StaticparseCSSDimension

  • parseCSSDimension(style: string, parentDimension: number): number | void

    Parse a CSS style rule into a number of pixels which apply to that dimension.

    Parameters

    • style: string

      The CSS style rule

    • parentDimension: number

      The relevant dimension of the parent element

    Returns number | void

    The parsed style dimension in pixels

StaticwaitForImages

  • waitForImages(element: HTMLElement): Promise<void>

    Wait for any images in the given element to load.

    Parameters

    • element: HTMLElement

      The element.

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods