Class TJSFolderExport

Provides a reactive dialog for exporting folders to a compendium that by default is modal and not draggable.

Hierarchy

TJSDialog
- TJSFolderExport (View Summary)

Accessors

closing

get closing(): boolean
Whether the Application is currently closing.

Returns boolean
Inherited from TJSDialog.closing

data

get data(): TJSDialog.Data
Returns the dialog data.

Returns TJSDialog.Data
Dialog data.

Inherited from TJSDialog.data

element

get element(): JQuery
Return the active application element, if it currently exists in the DOM

Returns JQuery
Inherited from TJSDialog.element

elementContent

get elementContent(): HTMLElement
Returns the content element if an application shell is mounted.

Returns HTMLElement
Content element.

Inherited from TJSDialog.elementContent

elementTarget

get elementTarget(): HTMLElement
Returns the target element or main element if no target defined.

Returns HTMLElement
Target element.

Inherited from TJSDialog.elementTarget

id

get id(): string
Return the CSS application ID which uniquely references this UI element

Returns string
Inherited from TJSDialog.id

managedPromise

get managedPromise(): ManagedPromise
Returns ManagedPromise
Returns the managed promise.

Inherited from TJSDialog.managedPromise

popOut

get popOut(): boolean
Control the rendering style of the application. If popOut is true, the application is rendered in its own wrapper window, otherwise only the inner app content is rendered

Returns boolean
Inherited from TJSDialog.popOut

position

get position(): TJSPosition
Returns the TJSPosition instance.

Returns TJSPosition
The TJSPosition instance.

Inherited from TJSDialog.position

reactive

get reactive(): SvelteApp.API.Reactive
Returns the reactive accessors & Svelte stores for SvelteApp.

Returns SvelteApp.API.Reactive
The reactive accessors & Svelte stores.

Inherited from TJSDialog.reactive

rendered

get rendered(): boolean
Return a flag for whether the Application instance is currently rendered

Returns boolean
Inherited from TJSDialog.rendered

state

get state(): SvelteApp.API.State
Returns the application state manager.

Returns SvelteApp.API.State
The application state manager.

Inherited from TJSDialog.state

svelte

get svelte(): SvelteApp.API.Svelte<Options>
Returns the Svelte helper class w/ various methods to access the mounted application shell component.

Returns SvelteApp.API.Svelte<Options>
Svelte / mounted application shell API.

Inherited from TJSDialog.svelte

template

get template(): string
The path to the HTML template file which should be used to render the inner content of the app

Returns string
Inherited from TJSDialog.template

title

get title(): string
An Application window should define its own title definition logic which may be dynamic depending on its data

Returns string
Inherited from TJSDialog.title

`Static`defaultOptions

get defaultOptions(): SvelteApp.Options
Specifies the default options that SvelteApp supports.

Returns SvelteApp.Options
options - Application options.

See
https://foundryvtt.com/api/interfaces/client.ApplicationOptions.html

Inherited from TJSDialog.defaultOptions

Methods

`Protected`_activateCoreListeners

_activateCoreListeners(html: JQuery): void
Activate required listeners which must be enabled on every Application. These are internal interactions which should not be overridden by downstream subclasses.
Parameters
- html: JQuery
Returns void
Inherited from TJSDialog._activateCoreListeners

`Protected`_canDragDrop

_canDragDrop(selector: string): boolean
Define whether a user is able to conclude a drag-and-drop workflow for a given drop selector
Parameters
- selector: string
  The candidate HTML selector for the drop target
Returns boolean
Can the current user drop on this selector?

Inherited from TJSDialog._canDragDrop

`Protected`_canDragStart

_canDragStart(selector: string): boolean
Define whether a user is able to begin a dragstart workflow for a given drag selector
Parameters
- selector: string
  The candidate HTML selector for dragging
Returns boolean
Can the current user drag this selector?

Inherited from TJSDialog._canDragStart

`Protected`_createDragDropHandlers

_createDragDropHandlers(): DragDrop[]
Create drag-and-drop workflow handlers for this Application

Returns DragDrop[]
An array of DragDrop handlers

Inherited from TJSDialog._createDragDropHandlers

`Protected`_createTabHandlers

_createTabHandlers(): Tabs[]
Create tabbed navigation handlers for this Application

Returns Tabs[]
An array of Tabs handlers

Inherited from TJSDialog._createTabHandlers

`Protected`_getHeaderButtons

_getHeaderButtons(): HeaderButton[]
Protected
Specify the set of config buttons which should appear in the SvelteApp header. Buttons should be returned as an Array of objects. The header buttons which are added to the application can be modified by the getApplicationHeaderButtons hook.

SvelteApp extends the button functionality with full reactivity for state changes during callbacks. Callbacks receive the button data and can modify it to update the button state.

Returns HeaderButton[]
All header buttons.

Inherited from TJSDialog._getHeaderButtons

`Protected`_injectHTML

_injectHTML(html: JQuery): void
Customize how a new HTML Application is added and first appears in the DOC
Parameters
- html: JQuery
Returns void
Inherited from TJSDialog._injectHTML

`Protected`_onChangeTab

_onChangeTab(event: MouseEvent, tabs: Tabs, active: string): void
Handle changes to the active tab in a configured Tabs controller
Parameters
- event: MouseEvent
  A left click event
- tabs: Tabs
  The TabsV2 controller
- active: string
  The new active tab name
Returns void
Inherited from TJSDialog._onChangeTab

`Protected`_onDragOver

_onDragOver(event: DragEvent): void
Callback actions which occur when a dragged element is over a drop target.
Parameters
- event: DragEvent
  The originating DragEvent
Returns void
Inherited from TJSDialog._onDragOver

`Protected`_onDragStart

_onDragStart(event: DragEvent): void
Callback actions which occur at the beginning of a drag start workflow.
Parameters
- event: DragEvent
  The originating DragEvent
Returns void
Inherited from TJSDialog._onDragStart

`Protected`_onDrop

_onDrop(event: DragEvent): void
Callback actions which occur when a dragged element is dropped on a target.
Parameters
- event: DragEvent
  The originating DragEvent
Returns void
Inherited from TJSDialog._onDrop

`Protected`_onResize

_onResize(event: any): void
Additional actions to take when the application window is resized
Parameters
- event: any
Returns void
Inherited from TJSDialog._onResize

`Protected`_onSearchFilter

_onSearchFilter(
    event: KeyboardEvent,
    query: string,
    rgx: RegExp,
    html: HTMLElement,
): void
Handle changes to search filtering controllers which are bound to the Application
Parameters
- event: KeyboardEvent
  The key-up event from keyboard input
- query: string
  The raw string input to the search field
- rgx: RegExp
  The regular expression to test against
- html: HTMLElement
  The HTML element which should be filtered
Returns void
Inherited from TJSDialog._onSearchFilter

`Protected`_onToggleMinimize

_onToggleMinimize(ev: any): void
Handle application minimization behavior - collapsing content and reducing the size of the header
Parameters
- ev: any
Returns void
Inherited from TJSDialog._onToggleMinimize

`Protected`_render

_render(force?: boolean, options?: AppV1RenderOptions): Promise<void>
An asynchronous inner function which handles the rendering of the Application
Parameters
- Optionalforce: boolean
  Render and display the application even if it is not currently displayed.
- Optionaloptions: AppV1RenderOptions
  Provided rendering options, see the render function for details
Returns Promise<void>
A Promise that resolves to the Application once rendering is complete

Inherited from TJSDialog._render

`Protected`_renderInner

_renderInner(data: object, options: AppV1RenderOptions): Promise<JQuery>
Render the inner application content
Parameters
- data: object
  The data used to render the inner template
- options: AppV1RenderOptions
Returns Promise<JQuery>
A promise resolving to the constructed jQuery object

Inherited from TJSDialog._renderInner

`Protected`_renderOuter

_renderOuter(options: AppV1RenderOptions): Promise<JQuery>
Render the outer application wrapper
Parameters
- options: AppV1RenderOptions
Returns Promise<JQuery>
A promise resolving to the constructed jQuery object

Inherited from TJSDialog._renderOuter

`Protected`_replaceHTML

_replaceHTML(element: JQuery, html: any, options: Record<string, unknown>): void
Customize how inner HTML is replaced when the application is refreshed
Parameters
- element: JQuery
  The original HTML element
- html: any
  New updated HTML
- options: Record<string, unknown>
Returns void
Inherited from TJSDialog._replaceHTML

`Protected`_restoreScrollPositions

_restoreScrollPositions(html: any): void
Restore the scroll positions of containers within the app after re-rendering the content
Parameters
- html: any
Returns void
Inherited from TJSDialog._restoreScrollPositions

`Protected`_saveScrollPositions

_saveScrollPositions(html: any): void
Persist the scroll positions of containers within the app before re-rendering the content
Parameters
- html: any
Returns void
Inherited from TJSDialog._saveScrollPositions

activateListeners

activateListeners(html: JQuery): void
After rendering, activate event listeners which provide interactivity for the Application. This is where user-defined Application subclasses should attach their event-handling logic.
Parameters
- html: JQuery
Returns void
Inherited from TJSDialog.activateListeners

bringToTop

bringToTop(): void
Bring the application to the top of the rendering stack

Returns void
Inherited from TJSDialog.bringToTop

close

close(options?: { force?: boolean }): Promise<void>
Close the application and un-register references to it within UI mappings This function returns a Promise which resolves once the window closing animation concludes
Parameters
- Optionaloptions: { force?: boolean }
  Options which affect how the Application is closed
Returns Promise<void>
A Promise which resolves once the application is closed

Fires
closeApplication

Inherited from TJSDialog.close

getData

getData(options?: Partial<ApplicationV1Options>): object | Promise<object>
An application should define the data object used to render its template. This function may either return an Object directly, or a Promise which resolves to an Object If undefined, the default implementation will return an empty object allowing only for rendering of static HTML
Parameters
- Optionaloptions: Partial<ApplicationV1Options>
Returns object | Promise<object>
Inherited from TJSDialog.getData

maximize

maximize(opts?: { animate?: boolean; duration?: number }): Promise<void>
Provides a mechanism to update the UI options store for maximized.

Note: the sanity check is duplicated from Application.maximize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApp.minimize to animate the content area.
Parameters
- Optionalopts: { animate?: boolean; duration?: number }
  Optional parameters.
  - Optionalanimate?: boolean
    When true perform default maximizing animation.
  - Optionalduration?: number
    Controls content area animation duration in seconds.
Returns Promise<void>
Inherited from TJSDialog.maximize

minimize

minimize(opts?: { animate?: boolean; duration?: number }): Promise<void>
Provides a mechanism to update the UI options store for minimized.

Note: the sanity check is duplicated from Application.minimize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApp.minimize to animate the content area.
Parameters
- Optionalopts: { animate?: boolean; duration?: number }
  Optional parameters.
  - Optionalanimate?: boolean
    When true perform default minimizing animation.
  - Optionalduration?: number
    Controls content area animation duration in seconds.
Returns Promise<void>
Inherited from TJSDialog.minimize

onSvelteMount

onSvelteMount(): void
Provides a callback after all Svelte components are initialized.

Returns void
Inherited from TJSDialog.onSvelteMount

onSvelteRemount

onSvelteRemount(): void
Provides a callback after the main application shell is remounted. This may occur during HMR / hot module replacement or directly invoked from the elementRootUpdate callback passed to the application shell component context.

Returns void
Inherited from TJSDialog.onSvelteRemount

render

render(force?: boolean, options?: AppV1RenderOptions): this
Render the Application by evaluating it's HTML template against the object of data provided by the getData method If the Application is rendered as a pop-out window, wrap the contained HTML in an outer frame with window controls
Parameters
- Optionalforce: boolean
  Add the rendered application to the DOM if it is not already present. If false, the Application will only be re-rendered if it is already present.
- Optionaloptions: AppV1RenderOptions
  Additional rendering options which are applied to customize the way that the Application is rendered in the DOM.
Returns this
The rendered Application instance

Inherited from TJSDialog.render

wait

wait<T>(options?: { reuse?: boolean }): Promise<T>
Brings to top or renders this dialog returning a Promise that is resolved any button pressed or when the dialog is closed.

Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a choice.

Note: null is returned if the dialog is closed without a user making a choice.
Type Parameters
- T
Parameters
- Optionaloptions: { reuse?: boolean }
  Options.
  - Optionalreuse?: boolean
    When true if there is an existing managed Promise this allows multiple sources to await on the same result.
Returns Promise<T>
A promise for dialog resolution.

Inherited from TJSDialog.wait

`Static`confirm

confirm<T>(
    data?: OptionsData & {
        onNo?: string | ((data?: { application?: TJSDialog }) => any);
        onYes?: string | ((data?: { application?: TJSDialog }) => any);
    },
    options?: OptionsCore,
): Promise<T>
A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. If you require more flexibility, a custom TJSDialog instance is preferred. The default focused button is 'yes'. You can change the default focused button by setting default to yes or no.
Type Parameters
- T
Parameters
- Optionaldata: OptionsData & {
  onNo?: string | ((data?: { application?: TJSDialog }) => any);
  onYes?: string | ((data?: { application?: TJSDialog }) => any);
  }
  Confirm dialog options.
  - OptionalonNo?: string | ((data?: { application?: TJSDialog }) => any)
    Callback function upon no; may be an async function. When defined as a string any matching function by name exported from content Svelte component is invoked.
  - OptionalonYes?: string | ((data?: { application?: TJSDialog }) => any)
    Callback function upon yes; may be an async function. When defined as a string any matching function by name exported from content Svelte component is invoked.
- Optionaloptions: OptionsCore
  SvelteApp options passed to the TJSDialog constructor.
Returns Promise<T>
A promise which resolves with result of yes / no callbacks or true / false.
Example
```
const result = await TJSDialog.confirm({
 title: 'A Yes or No Question',
 content: '<p>Choose wisely.</p>',
 onYes: () => 'YES Result',
 onNo: () => 'NO Result'
});

// Logs 'YES result', 'NO Result', or null if the user closed the dialog without making a selection.
console.log(result);
```
Inherited from TJSDialog.confirm

`Static`prompt

prompt<T>(
    data?: OptionsData & {
        icon?: string;
        label?: string;
        onOk?: string | ((data?: { application?: TJSDialog }) => any);
    },
    options?: OptionsCore,
): Promise<T>
A helper factory method to display a basic "prompt" style TJSDialog with a single button.
Type Parameters
- T
Parameters
- Optionaldata: OptionsData & {
      icon?: string;
      label?: string;
      onOk?: string | ((data?: { application?: TJSDialog }) => any);
  }
  Prompt dialog options that includes any TJSDialog options along with the following optional fields:
  - Optionalicon?: string
    Set another icon besides fas fa-check for button.
  - Optionallabel?: string
    The OK prompt button text.
  - OptionalonOk?: string | ((data?: { application?: TJSDialog }) => any)
    Callback function upon ok; may be an async function. When defined as a string any matching function by name exported from content Svelte component is invoked.
- Optionaloptions: OptionsCore
  SvelteApp options passed to the TJSDialog constructor.
Returns Promise<T>
The returned value from the provided callback function or true if the button is pressed.
Example
```
const result = await TJSDialog.prompt({
 title: 'Are you OK?',
 content: '<p>Are you OK?.</p>',
 label: 'Feeling Fine!',
 onOk: () => 'OK'
});

// Logs 'OK' or null if the user closed the dialog without making a selection.
console.log(result);
```
Inherited from TJSDialog.prompt

`Static`show

show(
    document: Folder,
    opts?: { keepId?: boolean; merge?: boolean; pack?: string } & Partial<
        OptionsCore,
    >,
    dialogData?: OptionsData,
): Promise<false | CompendiumCollection>
Shows a modal / non-draggable dialog to export a folder to an eligible compendium pack.
Parameters
- document: Folder
  Folder to export.
- Optionalopts: { keepId?: boolean; merge?: boolean; pack?: string } & Partial<OptionsCore>
  Additional options.
  - OptionalkeepId?: boolean
    Keep document IDs.
  - Optionalmerge?: boolean
    Update existing entries in the Compendium pack, matching by name
  - Optionalpack?: string
    The name of the compendium pack to provide an initial selection value in the dialog.
  - pack
    The name of the compendium pack to provide an initial selection value in the dialog.
  - merge
    Update existing entries in the Compendium pack, matching by name
  - keepId
    Keep document IDs.
  - options
    Rest of options to pass to TJSDialog / SvelteApp.
- OptionaldialogData: OptionsData
  Optional data to modify dialog.
Returns Promise<false | CompendiumCollection>
The compendium collection the folder is exported to or a falsy value; either 'false' for cancelling or 'null' if the user closed the dialog via <Esc> or the close header button.

`Static`wait

wait<T>(data: OptionsData, options?: OptionsCore): Promise<T>
Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a choice.

Note: By default null is returned if the dialog is closed without a user making a choice.
Type Parameters
- T
Parameters
- data: OptionsData
  Dialog data passed to the TJSDialog constructor.
- Optionaloptions: OptionsCore
  SvelteApp options passed to the TJSDialog constructor.
Returns Promise<T>
A Promise that resolves to the chosen result.

Inherited from TJSDialog.wait

Properties

`Protected`_dragDrop

_dragDrop: DragDrop[]

DragDrop workflow handlers which are active for this Application

`Protected`_element

_element: JQuery

An internal reference to the HTML element this application renders

_minimized

_minimized: boolean

Track whether the Application is currently minimized

_priorState

_priorState: ApplicationRenderState

The prior render state of this Application. This allows for rendering logic to understand if the application is being rendered for the first time.

`Protected`_scrollPositions

_scrollPositions: Record<string, unknown>

Track the most recent scroll positions for any vertically scrolling containers

`Protected`_searchFilters

_searchFilters: SearchFilter[]

SearchFilter handlers which are active for this Application

_state

_state: ApplicationRenderState

Track the render state of the Application

See

`Protected`_tabs

_tabs: Tabs[]

Tab navigation handlers which are active for this Application

appId

appId: number

The application ID is a unique incrementing integer which is used to identify every application window drawn by the VTT

options

options: SvelteApp.Options

The options provided to this application upon initialization

`Protected` `Static`_warnedAppV1

_warnedAppV1: boolean

`Static` `Readonly`RENDER_STATES

RENDER_STATES: {
    CLOSED: -1;
    CLOSING: -2;
    ERROR: 3;
    NONE: 0;
    RENDERED: 2;
    RENDERING: 1;
}

Class TJSFolderExport

Hierarchy

Index

Accessors

Methods

Properties

Accessors

closing

Returns boolean

data

Returns TJSDialog.Data

element

Returns JQuery

elementContent

Returns HTMLElement

elementTarget

Returns HTMLElement

id

Returns string

managedPromise

Returns ManagedPromise

popOut

Returns boolean

position

Returns TJSPosition

reactive

Returns SvelteApp.API.Reactive

rendered

Returns boolean

state

Returns SvelteApp.API.State

svelte

Returns SvelteApp.API.Svelte<Options>

template

Returns string

title

Returns string

StaticdefaultOptions

Returns SvelteApp.Options

See

Methods

Protected_activateCoreListeners

Parameters

Returns void

Protected_canDragDrop

Parameters

Returns boolean

Protected_canDragStart

Parameters

Returns boolean

Protected_createDragDropHandlers

Returns DragDrop[]

Protected_createTabHandlers

Returns Tabs[]

Protected_getHeaderButtons

Returns HeaderButton[]

Protected_injectHTML

Parameters

Returns void

Protected_onChangeTab

Parameters

Returns void

Protected_onDragOver

Parameters

Returns void

Protected_onDragStart

Parameters

Returns void

Protected_onDrop

Parameters

Returns void

Protected_onResize

Parameters

Returns void

Protected_onSearchFilter

Parameters

Returns void

Protected_onToggleMinimize

Parameters

Returns void

`Static`defaultOptions

`Protected`_activateCoreListeners

`Protected`_canDragDrop

`Protected`_canDragStart

`Protected`_createDragDropHandlers

`Protected`_createTabHandlers

`Protected`_getHeaderButtons

`Protected`_injectHTML

`Protected`_onChangeTab

`Protected`_onDragOver

`Protected`_onDragStart

`Protected`_onDrop

`Protected`_onResize

`Protected`_onSearchFilter

`Protected`_onToggleMinimize

`Protected`_render

`Protected`_renderInner

`Protected`_renderOuter

`Protected`_replaceHTML

`Protected`_restoreScrollPositions

`Protected`_saveScrollPositions

`Optional`animate?: boolean

`Optional`duration?: number

`Optional`animate?: boolean

`Optional`duration?: number

`Optional`reuse?: boolean

`Static`confirm

`Optional`onNo?: string | ((data?: { application?: TJSDialog }) => any)

`Optional`onYes?: string | ((data?: { application?: TJSDialog }) => any)

`Static`prompt

`Optional`icon?: string

`Optional`label?: string

`Optional`onOk?: string | ((data?: { application?: TJSDialog }) => any)

`Static`show

`Optional`keepId?: boolean