Class DialogV2

A lightweight Application that renders a dialog containing a form with arbitrary content, and some buttons.

Example: Prompt the user to confirm an action.

const proceed = await foundry.applications.api.DialogV2.confirm({
  content: "Are you sure?",
  rejectClose: false,
  modal: true
});
if ( proceed ) console.log("Proceed.");
else console.log("Do not proceed.");

Example: Prompt the user for some input.

let guess;
try {
  guess = await foundry.applications.api.DialogV2.prompt({
    window: { title: "Guess a number between 1 and 10" },
    content: '<input name="guess" type="number" min="1" max="10" step="1" autofocus>',
    ok: {
      label: "Submit Guess",
      callback: (event, button, dialog) => button.form.elements.guess.valueAsNumber
    }
  });
} catch {
  console.log("User did not make a guess.");
  return;
}
const n = Math.ceil(CONFIG.Dice.randomUniform() * 10);
if ( n === guess ) console.log("User guessed correctly.");
else console.log("User guessed incorrectly.");

Example: A custom dialog.

new foundry.applications.api.DialogV2({
  window: { title: "Choose an option" },
  content: `
    <label><input type="radio" name="choice" value="one" checked> Option 1</label>
    <label><input type="radio" name="choice" value="two"> Option 2</label>
    <label><input type="radio" name="choice" value="three"> Options 3</label>
  `,
  buttons: [{
    action: "choice",
    label: "Make Choice",
    default: true,
    callback: (event, button, dialog) => button.form.elements.choice.value
  }, {
    action: "all",
    label: "Take All"
  }],
  submit: result => {
    if ( result === "all" ) console.log("User picked all options.");
    else console.log(`User picked option: ${result}`);
  }
}).render({ force: true });

Hierarchy (View Summary)

ApplicationV2
- DialogV2
  - ShowToPlayersDialog
  - FolderExport

Index

Constructors

constructor

new DialogV2(
options?: Partial<ApplicationConfiguration & DialogV2Configuration>,
): DialogV2
Applications are constructed by providing an object of configuration options.
Parameters
- Optionaloptions: Partial<ApplicationConfiguration & DialogV2Configuration> = {}
  Options used to configure the Application instance
Returns DialogV2
Inherited from ApplicationV2.constructor

Properties

options

options: Readonly<ApplicationConfiguration & DialogV2Configuration>

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.

`Static`BASE_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.

`Static`DEFAULT_OPTIONS

DEFAULT_OPTIONS: {
    classes: string[];
    form: { closeOnSubmit: boolean };
    id: string;
    tag: string;
    window: { frame: boolean; minimizable: boolean; positioned: boolean };
} = ...

Inherit Doc

`Static`emittedEvents

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

`Static`RENDER_STATES

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

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

`Static`TABS

TABS: Record<string, ApplicationTabsConfiguration> = {}

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

Accessors

classList

get classList(): DOMTokenList
The CSS class list of this Application instance

Returns DOMTokenList
Inherited from ApplicationV2.classList

element

get element(): HTMLElement
The HTMLElement which renders this Application into the DOM.

Returns HTMLElement
Inherited from ApplicationV2.element

form

get form(): null | HTMLFormElement
Does this Application have a top-level form element?

Returns null | HTMLFormElement
Inherited from ApplicationV2.form

hasFrame

get hasFrame(): boolean
Does this Application instance render within an outer window frame?

Returns boolean
Inherited from ApplicationV2.hasFrame

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
Inherited from ApplicationV2.id

minimized

get minimized(): boolean
Is this Application instance currently minimized?

Returns boolean
Inherited from ApplicationV2.minimized

rendered

get rendered(): boolean
Is this Application instance currently rendered?

Returns boolean
Inherited from ApplicationV2.rendered

state

get state(): number
The current render state of the Application.

Returns number
Inherited from ApplicationV2.state

title

get title(): string
A convenience reference to the title of the Application window.

Returns string
Inherited from ApplicationV2.title

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;
}
Inherited from ApplicationV2.window

Methods

_attachFrameListeners

_attachFrameListeners(): void
Returns void
Inherit Doc
Overrides ApplicationV2._attachFrameListeners

_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>
Inherited from ApplicationV2._awaitTransition

_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

Inherited from ApplicationV2._doEvent

_initializeApplicationOptions

_initializeApplicationOptions(options: any): any
Parameters
- options: any
Returns any
Inherit Doc
Overrides ApplicationV2._initializeApplicationOptions

_onFirstRender

_onFirstRender(_context: any, _options: any): Promise<void>
Parameters
- _context: any
- _options: any
Returns Promise<void>
Overrides ApplicationV2._onFirstRender

_renderHTML

_renderHTML(_context: any, _options: any): Promise<HTMLFormElement>
Parameters
- _context: any
- _options: any
Returns Promise<HTMLFormElement>
Overrides ApplicationV2._renderHTML

_replaceHTML

_replaceHTML(result: any, content: any, _options: any): void
Parameters
- result: any
- content: any
- _options: any
Returns void
Overrides ApplicationV2._replaceHTML

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

Inherited from ApplicationV2.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
Inherited from ApplicationV2.bringToFront

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
Inherited from ApplicationV2.changeTab

close

close(options?: Partial<ApplicationClosingOptions>): Promise<DialogV2>
Close the Application, removing it from the DOM.
Parameters
- Optionaloptions: Partial<ApplicationClosingOptions> = {}
  Options which modify how the application is closed.
Returns Promise<DialogV2>
A Promise which resolves to the closed Application instance

Inherited from ApplicationV2.close

dispatchEvent

dispatchEvent(event: Event): boolean
Dispatch an event on this target.
Parameters
- event: Event
  The Event to dispatch
Returns boolean
Was default behavior for the event prevented?

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

Inherited from ApplicationV2.dispatchEvent

maximize

maximize(): Promise<void>
Restore the Application to its original dimensions.

Returns Promise<void>
Inherited from ApplicationV2.maximize

minimize

minimize(): Promise<void>
Minimize the Application, collapsing it to a minimal header.

Returns Promise<void>
Inherited from ApplicationV2.minimize

removeEventListener

removeEventListener(type: string, listener: EmittedEventListener): void
Remove an event listener for a certain type of event.
Parameters
- type: string
  The type of event being removed
- listener: EmittedEventListener
  The listener function being removed
Returns void
See
https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener

Inherited from ApplicationV2.removeEventListener

render

render(
options?: boolean | ApplicationRenderOptions,
_options?: ApplicationRenderOptions,
): Promise<DialogV2>
Render the Application, creating its HTMLElement and replacing its innerHTML. Add it to the DOM if it is not currently rendered and rendering is forced. Otherwise, re-render its contents.
Parameters
- Optionaloptions: boolean | ApplicationRenderOptions = {}
  Options which configure application rendering behavior. A boolean is interpreted as the "force" option.
- Optional_options: ApplicationRenderOptions = {}
  Legacy options for backwards-compatibility with the original ApplicationV1#render signature.
Returns Promise<DialogV2>
A Promise which resolves to the rendered Application instance

Inherited from ApplicationV2.render

setPosition

setPosition(position?: Partial<ApplicationPosition>): void | ApplicationPosition
Update the Application element position using provided data which is merged with the prior position.
Parameters
- Optionalposition: Partial<ApplicationPosition>
  New Application positioning data
Returns void | ApplicationPosition
The updated application position

Inherited from ApplicationV2.setPosition

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.

Inherited from ApplicationV2.submit

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

Inherited from ApplicationV2.toggleControls

`Protected`_canRender

_canRender(options: ApplicationRenderOptions): false | void
Protected
Test whether this Application is allowed to be rendered.
Parameters
- options: ApplicationRenderOptions
  Provided render options
Returns false | void
Return false to prevent rendering

Throws
An Error to display a warning message

Inherited from ApplicationV2._canRender

`Protected`_configureRenderOptions

_configureRenderOptions(options: ApplicationRenderOptions): void
Protected
Modify the provided options passed to a render request.
Parameters
- options: ApplicationRenderOptions
  Options which configure application rendering behavior
Returns void
Inherited from ApplicationV2._configureRenderOptions

`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

Inherited from ApplicationV2._createContextMenu

`Protected`_getHeaderControls

_getHeaderControls(): ApplicationHeaderControlsEntry[]
Protected
Configure the array of header control menu options

Returns ApplicationHeaderControlsEntry[]
Inherited from ApplicationV2._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
Inherited from ApplicationV2._getTabsConfig

`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
Inherited from ApplicationV2._headerControlButtons

`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
Inherited from ApplicationV2._insertElement

`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
Inherited from ApplicationV2._onChangeForm

`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
Inherited from ApplicationV2._onClickAction

`Protected`_onClickTab

_onClickTab(event: PointerEvent): void
Protected
Handle click events on a tab within the Application.
Parameters
- event: PointerEvent
Returns void
Inherited from ApplicationV2._onClickTab

`Protected`_onClose

_onClose(options: ApplicationRenderOptions): void
Protected
Actions performed after closing the Application. Post-close steps are not awaited by the close process.
Parameters
- options: ApplicationRenderOptions
  Provided render options
Returns void
Inherited from ApplicationV2._onClose

`Protected`_onKeyDown

_onKeyDown(event: KeyboardEvent): void
Protected
Handle keypresses within the dialog.
Parameters
- event: KeyboardEvent
  The triggering event.
Returns void

`Protected`_onPosition

_onPosition(position: ApplicationPosition): void
Protected
Actions performed after the Application is re-positioned.
Parameters
- position: ApplicationPosition
  The requested application position
Returns void
Inherited from ApplicationV2._onPosition

`Protected`_onRender

_onRender(
context: ApplicationRenderContext,
options: ApplicationRenderOptions,
): Promise<void>
Protected
Actions performed after any render of the Application.
Parameters
- context: ApplicationRenderContext
  Prepared context data
- options: ApplicationRenderOptions
  Provided render options
Returns Promise<void>
Inherited from ApplicationV2._onRender

`Protected`_onSubmit

_onSubmit(
target: HTMLButtonElement,
event: PointerEvent | SubmitEvent,
): Promise<DialogV2>
Protected
Handle submitting the dialog.
Parameters
- target: HTMLButtonElement
  The button that was clicked or the default button.
- event: PointerEvent | SubmitEvent
  The triggering event.
Returns Promise<DialogV2>

`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>
Inherited from ApplicationV2._onSubmitForm

`Protected`_postRender

_postRender(
context: ApplicationRenderContext,
options: ApplicationRenderOptions,
): Promise<void>
Protected
Perform post-render finalization actions.
Parameters
- context: ApplicationRenderContext
  Prepared context data.
- options: ApplicationRenderOptions
  Provided render options.
Returns Promise<void>
Inherited from ApplicationV2._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
- options: ApplicationRenderOptions
  Provided render options
Returns Promise<void>
Inherited from ApplicationV2._preClose

`Protected`_preFirstRender

_preFirstRender(
context: ApplicationRenderContext,
options: ApplicationRenderOptions,
): Promise<void>
Protected
Actions performed before a first render of the Application.
Parameters
- context: ApplicationRenderContext
  Prepared context data
- options: ApplicationRenderOptions
  Provided render options
Returns Promise<void>
Inherited from ApplicationV2._preFirstRender

`Protected`_prepareContext

_prepareContext(
options: ApplicationRenderOptions,
): Promise<ApplicationRenderContext>
Protected
Prepare application rendering context data for a given render request. If exactly one tab group is configured for this application, it will be prepared automatically.
Parameters
- options: ApplicationRenderOptions
  Options which configure application rendering behavior
Returns Promise<ApplicationRenderContext>
Context data for the render operation

Inherited from ApplicationV2._prepareContext

`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>
Inherited from ApplicationV2._prepareTabs

`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
- position: ApplicationPosition
  The requested application position
Returns void
Inherited from ApplicationV2._prePosition

`Protected`_preRender

_preRender(
context: ApplicationRenderContext,
options: ApplicationRenderOptions,
): Promise<void>
Protected
Actions performed before any render of the Application. Pre-render steps are awaited by the render process.
Parameters
- context: ApplicationRenderContext
  Prepared context data
- options: ApplicationRenderOptions
  Provided render options
Returns Promise<void>
Inherited from ApplicationV2._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
Inherited from ApplicationV2._removeElement

`Protected`_renderButtons

_renderButtons(): string
Protected
Render configured buttons.

Returns string

`Protected`_renderFrame

_renderFrame(options: ApplicationRenderOptions): Promise<HTMLElement>
Protected
Render the outer framing HTMLElement which wraps the inner HTML of the Application.
Parameters
- options: ApplicationRenderOptions
  Options which configure application rendering behavior
Returns Promise<HTMLElement>
Inherited from ApplicationV2._renderFrame

`Protected`_renderHeaderControl

_renderHeaderControl(control: ApplicationHeaderControlsEntry): HTMLLIElement
Protected
Render a header control button.
Parameters
- control: ApplicationHeaderControlsEntry
Returns HTMLLIElement
Inherited from ApplicationV2._renderHeaderControl

`Protected`_tearDown

_tearDown(options: ApplicationClosingOptions): void
Protected
Remove elements from the DOM and trigger garbage collection as part of application closure.
Parameters
- options: ApplicationClosingOptions
Returns void
Inherited from ApplicationV2._tearDown

`Protected`_updateFrame

_updateFrame(options: ApplicationRenderOptions): void
Protected
When the Application is rendered, optionally update aspects of the window frame.
Parameters
- options: ApplicationRenderOptions
  Options provided at render-time
Returns void
Inherited from ApplicationV2._updateFrame

`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
- position: ApplicationPosition
  Requested Application positioning data
Returns ApplicationPosition
Resolved Application positioning data

Inherited from ApplicationV2._updatePosition

`Static`_handleQuery

_handleQuery(
    __namedParameters: {
        config: object;
        type: "input" | "wait" | "prompt" | "confirm";
    },
): Promise<any>
Internal
The dialog query handler.
Parameters
- __namedParameters: { config: object; type: "input" | "wait" | "prompt" | "confirm" }
Returns Promise<any>

`Static`confirm

confirm(
    config?: Partial<
        ApplicationConfiguration & DialogV2Configuration & DialogV2WaitOptions,
    >,
): Promise<any>
A utility helper to generate a dialog with yes and no buttons.
Parameters
- Optionalconfig: Partial<ApplicationConfiguration & DialogV2Configuration & DialogV2WaitOptions> = {}
  - yes
    Options to overwrite the default yes button configuration.
  - no
    Options to overwrite the default no button configuration.
Returns Promise<any>
Resolves to true if the yes button was pressed, or false if the no button was pressed. If additional buttons were provided, the Promise resolves to the identifier of the one that was pressed, or the value returned by its callback. If the dialog was dismissed, and rejectClose is false, the Promise resolves to null.

`Static`inheritanceChain

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
Inherited from ApplicationV2.inheritanceChain

`Static`input

input(
    config?: Partial<
        ApplicationConfiguration & DialogV2Configuration & DialogV2WaitOptions,
    >,
): Promise<any>
A utility helper to generate a dialog for user input.
Parameters
- Optionalconfig: Partial<ApplicationConfiguration & DialogV2Configuration & DialogV2WaitOptions> = {}
  - ok
    Options to overwrite the default confirmation button configuration.
Returns Promise<any>
Resolves to the data of the form if the ok button was pressed, or the value returned by that button's callback. If additional buttons were provided, the Promise resolves to the identifier of the one that was pressed, or the value returned by its callback. If the dialog was dismissed, and rejectClose is false, the Promise resolves to null.

`Static`parseCSSDimension

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

Inherited from ApplicationV2.parseCSSDimension

`Static`prompt

prompt(
    config?: Partial<
        ApplicationConfiguration & DialogV2Configuration & DialogV2WaitOptions,
    >,
): Promise<any>
A utility helper to generate a dialog with a single confirmation button.
Parameters
- Optionalconfig: Partial<ApplicationConfiguration & DialogV2Configuration & DialogV2WaitOptions> = {}
  - ok
    Options to overwrite the default confirmation button configuration.
Returns Promise<any>
Resolves to the identifier of the button used to submit the dialog, or the value returned by that button's callback. If additional buttons were provided, the Promise resolves to the identifier of the one that was pressed, or the value returned by its callback. If the dialog was dismissed, and rejectClose is false, the Promise resolves to null.

`Static`query

query(
    user: any,
    type: "input" | "wait" | "prompt" | "confirm",
    config?: object,
): Promise<any>
Present an asynchronous Dialog query to a specific User for response.
Parameters
- user: any
  A User instance or a User id
- type: "input" | "wait" | "prompt" | "confirm"
  The type of Dialog to present
- Optionalconfig: object = {}
  Dialog configuration forwarded on to the Dialog.prompt, Dialog.confirm, Dialog.input, or Dialog.wait function depending on the query type. Callback options are not supported.
Returns Promise<any>
The query response or null if no response was provided
See

`Static`wait

wait(
    config?: Partial<
        ApplicationConfiguration & DialogV2Configuration & DialogV2WaitOptions,
    >,
): Promise<any>
Spawn a dialog and wait for it to be dismissed or submitted.
Parameters
- Optionalconfig: Partial<ApplicationConfiguration & DialogV2Configuration & DialogV2WaitOptions> = {}
Returns Promise<any>
Resolves to the identifier of the button used to submit the dialog, or the value returned by that button's callback. If the dialog was dismissed, and rejectClose is false, the Promise resolves to null.

`Static`waitForImages

waitForImages(element: HTMLElement): Promise<void>
Wait for any images in the given element to load.
Parameters
- element: HTMLElement
  The element.
Returns Promise<void>
Inherited from ApplicationV2.waitForImages

`Protected` `Static`_onClickButton

_onClickButton(
    ...this: any,
    event: PointerEvent,
    target: HTMLButtonElement,
): void
Protected
Redirect all clicks of buttons with action specifications to the submit handler.
Parameters
- ...this: any
- event: PointerEvent
  The originating click event.
- target: HTMLButtonElement
  The button element that was clicked.
Returns void

Class DialogV2

Example: Prompt the user to confirm an action.

Example: Prompt the user for some input.

Example: A custom dialog.

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns DialogV2

Properties

options

position

tabGroups

Static Internal_appId

Static Internal_maxZ

StaticBASE_APPLICATION

StaticDEFAULT_OPTIONS

Inherit Doc

StaticemittedEvents

StaticRENDER_STATES

StaticTABS

Accessors

classList

Returns DOMTokenList

element

Returns HTMLElement

form

Returns null | HTMLFormElement

hasFrame

Returns boolean

id

Returns string

minimized

Returns boolean

rendered

Returns boolean

state

Returns number

title

Returns string

window

Methods

_attachFrameListeners

Returns void

Inherit Doc

_awaitTransition

Parameters

Returns Promise<void>

_doEvent

Parameters

Optionalasync?: boolean

OptionaldebugText?: string

OptionaleventName?: string

OptionalhandlerArgs?: any[]

OptionalhookArgs?: any[]

OptionalhookName?: string

OptionalhookResponse?: boolean

OptionalparentClassHooks?: boolean

Returns void | Promise<void>

_initializeApplicationOptions

Parameters

Returns any

Inherit Doc

_onFirstRender

Parameters

Returns Promise<void>

_renderHTML

Parameters

Returns Promise<HTMLFormElement>

_replaceHTML

Parameters

Returns void

addEventListener

Parameters

Optionalonce?: boolean

`Static` `Internal`_appId

`Static` `Internal`_maxZ

`Static`BASE_APPLICATION

`Static`DEFAULT_OPTIONS

`Static`emittedEvents

`Static`RENDER_STATES

`Static`TABS

`Optional`async?: boolean

`Optional`debugText?: string

`Optional`eventName?: string

`Optional`handlerArgs?: any[]

`Optional`hookArgs?: any[]

`Optional`hookName?: string

`Optional`hookResponse?: boolean

`Optional`parentClassHooks?: boolean

`Optional`once?: boolean

`Optional`event?: Event

`Optional`force?: boolean

`Optional`navElement?: HTMLElement

`Optional`updatePosition?: boolean

`Optional`animate?: boolean

`Protected`_canRender

`Protected`_configureRenderOptions

`Protected`_createContextMenu

`Optional`container?: HTMLElement

`Optional`hookName?: string

`Optional`parentClassHooks?: boolean

`Protected`_getHeaderControls

`Protected`_getTabsConfig

`Protected`_headerControlButtons

`Protected`_insertElement

`Protected`_onChangeForm

`Protected`_onClickAction