Document to delete.
Optional
opts: { Additional context options or dialog positioning options.
Optional
context?: objectDocumentModificationContext.
Optional
options?: SvelteApplicationOptionsRest of options to pass to TJSDialog / Application.
Optional
dialogData: TJSDialogOptionsOptional data to modify dialog.
Returns the dialog data.
Dialog data.
Returns the content element if an application shell is mounted.
Content element.
Returns the target element or main element if no target defined.
Target element.
Returns the managed promise.
Returns the TJSPosition instance.
The TJSPosition instance.
Returns the reactive accessors & Svelte stores for SvelteApplication.
The reactive accessors & Svelte stores.
Returns the application state manager.
The application state manager.
Returns the Svelte helper class w/ various methods to access mounted Svelte components.
GetSvelteData
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.
Optional
opts: { Optional parameters.
Optional
animate?: booleanWhen true perform default maximizing animation.
Optional
duration?: numberControls content area animation duration in seconds.
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.
Optional
opts: { Optional parameters
Optional
animate?: booleanWhen true perform default minimizing animation.
Optional
duration?: numberControls content area animation duration in seconds.
Provides a callback after all Svelte components are initialized.
Optional
mountedAppShell: MountedAppShellThe mounted app shell elements.
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.
Optional
mountedAppShell: MountedAppShellThe mounted app shell elements.
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.
Optional
options: { Options.
Optional
reuse?: booleanWhen true if there is an existing managed Promise this allows multiple sources to await on the same result.
A promise for dialog resolution.
Static
confirmA 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
.
Optional
data: TJSDialogOptions & { Confirm dialog options.
Optional
options: SvelteApplicationOptionsSvelteApplication options passed to the TJSDialog constructor.
A promise which resolves with result of yes / no callbacks or true / false.
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
promptA helper factory method to display a basic "prompt" style TJSDialog with a single button.
Optional
data: TJSDialogOptions & { Prompt dialog options that includes any TJSDialog options along with the following optional fields:
Optional
options: SvelteApplicationOptionsSvelteApplication options passed to the TJSDialog constructor.
The returned value from the provided callback function or true
if the button
is pressed.
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
showShows a modal / non-draggable dialog to delete a document.
Document to delete.
Optional
opts: { Additional context options or dialog positioning options.
Optional
context?: objectDocumentModificationContext.
Optional
options?: SvelteApplicationOptionsRest of options to pass to TJSDialog / Application.
Optional
dialogData: TJSDialogOptionsOptional data to modify dialog.
The document if deleted or a falsy value; either
'false' for cancelling or 'null' if the user closed the dialog via <Esc>
or the close header button.
Static
waitCreates 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.
Dialog data passed to the TJSDialog constructor.
Optional
options: SvelteApplicationOptionsSvelteApplication options passed to the TJSDialog constructor.
A Promise that resolves to the chosen result.
Provides a reactive dialog for deleting documents that by default is modal and not draggable. An additional set of accessors for the document assigned are available via the
this.reactive.document
. You may swap out the document at any time by setting it to a different document.