Class Dialog

Hierarchy (View Summary)

Dialog

Constructors

constructor

new Dialog(options: DialogOptions): Dialog
Parameters
- options: DialogOptions
Returns Dialog
- Defined in types/generated/interface/dialog.d.ts:226
new Dialog(id: string, options: DialogOptions): Dialog
Parameters
- id: string
- options: DialogOptions
Returns Dialog
- Defined in types/generated/interface/dialog.d.ts:227

Properties

`Optional`buttons

buttons?: string[]

cancel_on_click_outside

cancel_on_click_outside: boolean

cancelIndex

cancelIndex: number

`Optional`component

component?: Component

configuration

configuration: DialogOptions

confirmIndex

confirmIndex: number

content_vue

content_vue: any

darken

darken: boolean

draggable

draggable: boolean

`Optional`form

form?: InputForm

form_config

form_config: InputFormConfig

`Optional`form_first

form_first?: boolean

id

id: string

`Optional`keyboard_actions

keyboard_actions?: {
    [id: string]: {
        condition?: any;
        keybind: Keybind;
        run: (event: KeyboardEvent) => void;
    };
}

`Optional`lines

lines?: DialogLineOptions[]

`Optional`max_label_width

max_label_width?: number

object

object: HTMLElement

onBuild

onBuild: (object: HTMLElement) => void

onOpen

onOpen: () => void

onResize

onResize: () => void

`Optional`part_order

part_order?: string[]

`Optional`progress_bar

progress_bar?: {
    node?: HTMLDivElement;
    progress?: number;
    setProgress(value: number): void;
}

Type Declaration

Optionalnode?: HTMLDivElement
The progress bar HTML node
Optionalprogress?: number
The current progress
setProgress: function
- setProgress(value: number): void
  Set the progress displayed in the progress bar
  Parameters
  - value: number
    A progress value between 0 and 1
  Returns void
  - Defined in types/generated/interface/dialog.d.ts:183

`Optional`resizable

resizable?: false | "x" | "y" | "xy"

`Optional`sidebar

sidebar?: DialogSidebar

`Optional`singleButton

singleButton?: boolean

title

title: string

`Optional`title_menu

title_menu?: Menu

toolbars

toolbars: Record<string, Toolbar>

`Optional`uses_wide_inputs

uses_wide_inputs?: boolean

width

width: number

`Static`open

open: Dialog

Currently opened dialog

`Static`stack

stack: Dialog[]

Stack of currently open dialogs, ordered by depth

Methods

build

build(): this
Returns this
- Defined in types/generated/interface/dialog.d.ts:255

cancel

cancel(event?: Event): void
Triggers the cancel event of the dialog.
Parameters
- Optionalevent: Event
Returns void
- Defined in types/generated/interface/dialog.d.ts:235

close

close(button?: number, event?: Event): void
Parameters
- Optionalbutton: number
- Optionalevent: Event
Returns void
- Defined in types/generated/interface/dialog.d.ts:254

confirm

confirm(event?: Event): void
Triggers the confirm event of the dialog.
Parameters
- Optionalevent: Event
Returns void
- Defined in types/generated/interface/dialog.d.ts:231

delete

delete(): void
Returns void
- Defined in types/generated/interface/dialog.d.ts:260

focus

focus(): void
Returns void
- Defined in types/generated/interface/dialog.d.ts:258

getFormBar

getFormBar(form_id: string): JQuery<HTMLElement>
Parameters
- form_id: string
Returns JQuery<HTMLElement>
- Defined in types/generated/interface/dialog.d.ts:261

getFormResult

getFormResult(): { [x: string]: FormResultValue }
Returns { [x: string]: FormResultValue }
- Defined in types/generated/interface/dialog.d.ts:251

hide

hide(): this
Returns this
- Defined in types/generated/interface/dialog.d.ts:259

`Optional`onButton

onButton?(button_index: number, event?: Event): boolean | void
Parameters
- button_index: number
- Optionalevent: Event
Returns boolean | void
- Defined in types/generated/interface/dialog.d.ts:219

`Optional`onCancel

onCancel?(event: Event): boolean | void
Parameters
- event: Event
Returns boolean | void
- Defined in types/generated/interface/dialog.d.ts:218

`Optional`onConfirm

onConfirm?(formResult: any, event: Event): boolean | void
Parameters
- formResult: any
- event: Event
Returns boolean | void
- Defined in types/generated/interface/dialog.d.ts:217

`Optional`onFormChange

onFormChange?(form_result: { [key: string]: FormResultValue }): void
Parameters
- form_result: { [key: string]: FormResultValue }
Returns void
- Defined in types/generated/interface/dialog.d.ts:220

setFormToggles

setFormToggles(values: Record<string, boolean>, update?: boolean): void
Set whether the dialog form inputs are toggled on or off. See "toggle_enabled"
Parameters
- values: Record<string, boolean>
- Optionalupdate: boolean
  Whether to update the dialog (call onFormChange) after setting the values. Default is true. Set to false when called from onFormChange
Returns void
- Defined in types/generated/interface/dialog.d.ts:250

setFormValues

setFormValues(values: Record<string, FormResultValue>, update?: boolean): void
Set the values of the dialog form inputs
Parameters
- values: Record<string, FormResultValue>
  The values to set, by form input key
- Optionalupdate: boolean
  Whether to update the dialog (call onFormChange) after setting the values. Default is true. Set to false when called from onFormChange
Returns void
- Defined in types/generated/interface/dialog.d.ts:244

show

show(anchor?: HTMLElement): this
Parameters
- Optionalanchor: HTMLElement
Returns this
- Defined in types/generated/interface/dialog.d.ts:257

updateFormValues

updateFormValues(initial?: boolean): { [x: string]: FormResultValue }
Parameters
- Optionalinitial: boolean
Returns { [x: string]: FormResultValue }
- Defined in types/generated/interface/dialog.d.ts:236

Class Dialog

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Dialog

Parameters

Returns Dialog

Properties

Optionalbuttons

cancel_on_click_outside

cancelIndex

Optionalcomponent

configuration

confirmIndex

content_vue

darken

draggable

Optionalform

form_config

Optionalform_first

id

Optionalkeyboard_actions

Optionallines

Optionalmax_label_width

object

onBuild

onOpen

onResize

Optionalpart_order

Optionalprogress_bar

Type Declaration

Optionalnode?: HTMLDivElement

Optionalprogress?: number

setProgress: function

Parameters

Returns void

Optionalresizable

Optionalsidebar

OptionalsingleButton

title

Optionaltitle_menu

toolbars

Optionaluses_wide_inputs

width

Staticopen

Staticstack

Methods

build

Returns this

cancel

Parameters

Returns void

close

Parameters

Returns void

confirm

Parameters

Returns void

delete

Returns void

focus

Returns void

getFormBar

Parameters

Returns JQuery<HTMLElement>

getFormResult

Returns { [x: string]: FormResultValue }

hide

Returns this

OptionalonButton

Parameters

Returns boolean | void

OptionalonCancel

Parameters

Returns boolean | void

`Optional`buttons

`Optional`component

`Optional`form

`Optional`form_first

`Optional`keyboard_actions

`Optional`lines

`Optional`max_label_width

`Optional`part_order

`Optional`progress_bar

`Optional`node?: HTMLDivElement

`Optional`progress?: number

`Optional`resizable

`Optional`sidebar

`Optional`singleButton

`Optional`title_menu

`Optional`uses_wide_inputs

`Static`open

`Static`stack

`Optional`onButton

`Optional`onCancel

`Optional`onConfirm

`Optional`onFormChange