Class TJSDocumentCreate

Provides a dialog for creating documents that by default is modal and not draggable.

Hierarchy (view full)

Constructors

constructor

Accessors

data elementContent elementTarget managedPromise position reactive state svelte

Methods

maximize minimize onSvelteMount onSvelteRemount wait confirm prompt show wait

Constructors

constructor

  • new TJSDocumentCreate(documentCls, data?, context?, dialogData?): TJSDocumentCreate

  • Create a new Document of the type specified by documentCls by rendering a dialog window to provide basic creation details.

    Parameters

    • documentCls: object

      Document class to create.

    • Optional data: object

      Document data.

    • Optional context: {
          options?: Partial<SvelteApplicationOptions>;
          pack?: object;
          parent?: object;
          renderSheet?: boolean;
      }

      Additional context options or dialog positioning options.

      • Optional options?: Partial<SvelteApplicationOptions>

        Rest of options to pass to TJSDialog / Application.

      • Optional pack?: object

        A Compendium pack identifier within which the Documents should be modified.

      • Optional parent?: object

        A parent Document within which these Documents should be embedded.

      • Optional renderSheet?: boolean

        Render the sheet for the new document.

    • Optional dialogData: TJSDialogOptions

      Optional data to modify dialog.

    Returns TJSDocumentCreate

Accessors

data

elementContent

  • get elementContent(): HTMLElement

  • Returns the content element if an application shell is mounted.

    Returns HTMLElement

    Content element.

elementTarget

  • get elementTarget(): HTMLElement

  • Returns the target element or main element if no target defined.

    Returns HTMLElement

    Target element.

managedPromise

position

  • get position(): TJSPosition

  • Returns the TJSPosition instance.

    Returns TJSPosition

    The TJSPosition instance.

reactive

  • get reactive(): SvelteReactive

  • Returns the reactive accessors & Svelte stores for SvelteApplication.

    Returns SvelteReactive

    The reactive accessors & Svelte stores.

state

svelte

  • get svelte(): GetSvelteData

  • Returns the Svelte helper class w/ various methods to access mounted Svelte components.

    Returns GetSvelteData

    GetSvelteData

Methods

maximize

  • maximize(opts?): 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 SvelteApplication.minimize to animate the content area.

    Parameters

    • Optional opts: {
          animate?: boolean;
          duration?: number;
      }

      Optional parameters.

      • Optional animate?: boolean

        When true perform default maximizing animation.

      • Optional duration?: number

        Controls content area animation duration in seconds.

    Returns Promise<void>

minimize

  • minimize(opts?): 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 SvelteApplication.minimize to animate the content area.

    Parameters

    • Optional opts: {
          animate?: boolean;
          duration?: number;
      }

      Optional parameters

      • Optional animate?: boolean

        When true perform default minimizing animation.

      • Optional duration?: number

        Controls content area animation duration in seconds.

    Returns Promise<void>

onSvelteMount

  • onSvelteMount(mountedAppShell?): void

  • Provides a callback after all Svelte components are initialized.

    Parameters

    Returns void

onSvelteRemount

  • onSvelteRemount(mountedAppShell?): 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.

    Parameters

    Returns void

wait

  • wait<T>(options?): 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

    • Optional options: {
          reuse?: boolean;
      }

      Options.

      • Optional reuse?: 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.

Static confirm

  • confirm<T_1>(data?, options?): Promise<T_1>

  • 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_1

    Parameters

    • Optional data: TJSDialogOptions & {
          onNo?: string | ((application) => any);
          onYes?: string | ((application) => any);
      }

      Confirm dialog options.

    • Optional options: SvelteApplicationOptions

      SvelteApplication options passed to the TJSDialog constructor.

    Returns Promise<T_1>

    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);

Static prompt

  • prompt<T_2>(data?, options?): Promise<T_2>

  • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

    Type Parameters

    • T_2

    Parameters

    • Optional data: TJSDialogOptions & {
          icon?: string;
          label?: string;
          onOk?: string | ((application) => any);
      }

      Prompt dialog options that includes any TJSDialog options along with the following optional fields:

    • Optional options: SvelteApplicationOptions

      SvelteApplication options passed to the TJSDialog constructor.

    Returns Promise<T_2>

    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);

Static show

  • show(documentCls, data?, context?, dialogData?): Promise<object>

  • Create a new Document of the type specified by documentCls by rendering a dialog window to provide basic creation details.

    Parameters

    • documentCls: object

      Document class to create.

    • Optional data: object

      Document data.

    • Optional context: {
          options?: SvelteApplicationOptions;
          pack?: object;
          parent?: object;
          renderSheet?: boolean;
      }

      Additional context options or dialog positioning options.

      • Optional options?: SvelteApplicationOptions

        Rest of options to pass to TJSDialog / Application.

      • Optional pack?: object

        A Compendium pack identifier within which the Documents should be modified.

      • Optional parent?: object

        A parent Document within which these Documents should be embedded.

      • Optional renderSheet?: boolean

        Render the sheet for the new document.

    • Optional dialogData: TJSDialogOptions

      Optional data to modify dialog.

    Returns Promise<object>

    The newly created document 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_3>(data, options?): Promise<T_3>

  • 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_3

    Parameters

    Returns Promise<T_3>

    A Promise that resolves to the chosen result.

Settings

Member Visibility

Theme

On This Page