Dialog<Inputs>

Defined in: js-api/src/widgets/forms.ts:29

A non-modal dialog. Sample: https://public.datagrok.ai/js/samples/ui/dialogs

Example

ui.dialog('Windows')
  .add(ui.)
  .add(ui.span(['People of Earth, your attention, please… ']))
  .onOK(() => { grok.shell.info('OK!'); })
  .show();

Extends

• DartWidget

Extended by

• Wizard

Type Parameters

Type Parameter	Default type
Inputs extends Record<string, InputBase<any>>	object

Constructors

Constructor

new Dialog<Inputs>(dart): Dialog<Inputs>

Defined in: js-api/src/widgets/forms.ts:31

Parameters

Parameter	Type
dart	any

Returns

Dialog<Inputs>

Overrides

DartWidget.constructor

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
_functions	protected	Func[]	[]	-	DartWidget._functions	js-api/src/widgets/base.ts:214
_properties	protected	Property[]	[]	-	DartWidget._properties	js-api/src/widgets/base.ts:213
_root	protected	HTMLElement	undefined	-	DartWidget._root	js-api/src/u2core/component.ts:423
_u2	readonly	ComponentState	undefined	-	DartWidget._u2	js-api/src/u2core/component.ts:76
componentMeta?	public	ComponentMetaBase	undefined	The registry metadata of the tag that built this component, stamped by the spec renderer — the single source the introspection surface below is generated from.	DartWidget.componentMeta	js-api/src/u2core/component.ts:71
dart	public	any	undefined	-	DartWidget.dart	js-api/src/widgets/base.ts:217
factory	public	Func | null	null	Constructor function. No parameters, returns [Widget].	DartWidget.factory	js-api/src/widgets/base.ts:211
isDetached	public	boolean	false	-	DartWidget.isDetached	js-api/src/widgets/base.ts:218
props	public	any	undefined	-	DartWidget.props	js-api/src/widgets/base.ts:215
specProps?	public	Record<string, unknown>	undefined	The props the registry's create was handed, stamped alongside componentMeta: the last resort of the property read below, for a component that keeps a prop under another name or not at all (a create wrapping a bare element). Construction-time values — a live one always wins.	DartWidget.specProps	js-api/src/u2core/component.ts:75
subs	public	Subscription[]	undefined	-	DartWidget.subs	js-api/src/widgets/base.ts:216
temp	public	any	undefined	Contains auxiliary information	DartWidget.temp	js-api/src/widgets/base.ts:208

Accessors

aiDescription

Get Signature

get aiDescription(): string | null

Defined in: js-api/src/widgets/base.ts:457

AI briefing of the underlying Dart widget.

Returns

string | null

Set Signature

set aiDescription(x): void

Defined in: js-api/src/widgets/base.ts:462

A short AI-facing briefing, seeded from the registry's usage or description.

Parameters

Parameter	Type
x	string | null

Returns

void

Inherited from

DartWidget.aiDescription

---

ambientAdoption

Get Signature

get protected ambientAdoption(): boolean

Defined in: js-api/src/widgets/base.ts:272

A widget wrapper minted inside somebody's effect scope must not be auto-disposed with it.

Returns

boolean

Inherited from

DartWidget.ambientAdoption

---

children

Get Signature

get children(): Widget<any>[]

Defined in: js-api/src/widgets/base.ts:304

Parent widget up the DOM tree, or null.

Returns

Widget<any>[]

Inherited from

DartWidget.children

---

helpUrl

Get Signature

get helpUrl(): string

Defined in: js-api/src/widgets/forms.ts:44

When provided, adds a "?" icon to the dialog header on the right.

Returns

string

Set Signature

set helpUrl(url): void

Defined in: js-api/src/widgets/forms.ts:45

Parameters

Parameter	Type
url	string

Returns

void

---

inputs

Get Signature

get inputs(): InputBase<any>[]

Defined in: js-api/src/widgets/forms.ts:52

Returns a list of the dialog's inputs.

Returns

InputBase<any>[]

---

name

Get Signature

get name(): string | undefined

Defined in: js-api/src/u2core/component.ts:67

Unique within a spec: the anchor for selection, patches and automation. An accessor pair (not a field), so a platform descendant's own name accessors override it legally (TS2611).

Returns

string | undefined

Set Signature

set name(x): void

Defined in: js-api/src/u2core/component.ts:68

Parameters

Parameter	Type
x	string | undefined

Returns

void

Inherited from

DartWidget.name

---

namedInputs

Get Signature

get namedInputs(): Inputs

Defined in: js-api/src/widgets/forms.ts:146

gets typed inputs with captions as keys.

Returns

Inputs

---

onAfterOK

Get Signature

get onAfterOK(): Observable<any>

Defined in: js-api/src/widgets/forms.ts:106

Fires after the OK handler completes successfully.

Returns

Observable<any>

---

onBeforeOK

Get Signature

get onBeforeOK(): Observable<any>

Defined in: js-api/src/widgets/forms.ts:103

Fires before the OK handler runs.

Returns

Observable<any>

---

onClose

Get Signature

get onClose(): Observable<any>

Defined in: js-api/src/widgets/forms.ts:98

Returns

Observable<any>

---

onSaveHistoryRequest

Get Signature

get onSaveHistoryRequest(): Observable<any>

Defined in: js-api/src/widgets/forms.ts:109

Fires when the dialog requests to save the current history snapshot.

Returns

Observable<any>

---

parent

Get Signature

get parent(): Widget<any> | null

Defined in: js-api/src/widgets/base.ts:301

Parent widget up the DOM tree, or null.

Returns

Widget<any> | null

Inherited from

DartWidget.parent

---

propertyTarget

Get Signature

get propertyTarget(): unknown

Defined in: js-api/src/widgets/base.ts:450

What this component's properties are read from and written to — prop.get(target) / prop.set(target, v): the component itself, unless an adoption says otherwise.

Returns

unknown

Inherited from

DartWidget.propertyTarget

---

propertyTier

Get Signature

get propertyTier(): boolean

Defined in: js-api/src/widgets/base.ts:276

Every property getProperties declares is a bind step, read and written on propertyTarget.

Returns

boolean

Inherited from

DartWidget.propertyTier

---

root

Get Signature

get root(): HTMLElement

Defined in: js-api/src/widgets/base.ts:449

Returns

HTMLElement

Inherited from

DartWidget.root

---

scope

Get Signature

get scope(): Scope

Defined in: js-api/src/u2core/component.ts:53

Minted on first use; assigned before _scopeMinted fires, so the hook's own this.scope.own(...) reads the stored scope instead of re-entering the mint.

Returns

Scope

Inherited from

DartWidget.scope

---

title

Get Signature

get title(): string

Defined in: js-api/src/widgets/forms.ts:48

Returns the title of a dialog.

Returns

string

Set Signature

set title(t): void

Defined in: js-api/src/widgets/forms.ts:49

Parameters

Parameter	Type
t	string

Returns

void

---

type

Get Signature

get type(): string

Defined in: js-api/src/widgets/base.ts:448

Returns

string

Inherited from

DartWidget.type

Methods

_notifyPropertyChange()

protected _notifyPropertyChange(p): void

Defined in: js-api/src/widgets/base.ts:351

Notifies the property tier. Called from both the addProperty setter (overrides that skip super would otherwise lose props.x = writes) and onPropertyChanged (direct calls); the double notify collapses into one microtask refresh.

Parameters

Parameter	Type
p	Property | null

Returns

void

Inherited from

DartWidget._notifyPropertyChange

---

_ownPropertyChanges()

protected _ownPropertyChanges(): ObservableLike<PropertyChange>

Defined in: js-api/src/widgets/base.ts:356

Returns

ObservableLike<PropertyChange>

Inherited from

DartWidget._ownPropertyChanges

---

_scopeMinted()

protected _scopeMinted(_scope): void

Defined in: js-api/src/widgets/base.ts:320

First-mint hook: a platform descendant wires its lifecycle here. Never fired for a scope provided to init — that path runs inside the constructor chain.

Parameters

Parameter	Type
_scope	Scope

Returns

void

Inherited from

DartWidget._scopeMinted

---

_wireDartLifecycle()

protected _wireDartLifecycle(): void

Defined in: js-api/src/widgets/base.ts:336

Dart-owned lifecycle: the platform kill disposes the scope, and disposing the scope kills the widget through the kill-walk.

Returns

void

Inherited from

DartWidget._wireDartLifecycle

---

_wireJsLifecycle()

protected _wireJsLifecycle(): void

Defined in: js-api/src/widgets/base.ts:327

JS-owned lifecycle: disposing the scope detaches the widget, and vice versa.

Returns

void

Inherited from

DartWidget._wireJsLifecycle

---

_wireLifecycle()

protected _wireLifecycle(): void

Defined in: js-api/src/widgets/base.ts:451

Returns

void

Inherited from

DartWidget._wireLifecycle

---

add()

add(content): Dialog<Inputs>

Defined in: js-api/src/widgets/forms.ts:133

Adds content to the dialog. using addInput() for inputs is preferred, as it provides better type safety.

Parameters

Parameter	Type	Description
content	HTMLElement | Widget<any> | InputBase<any>	-

Returns

Dialog<Inputs>

---

addButton()

addButton(text, action, index?, tooltip?): Dialog<Inputs>

Defined in: js-api/src/widgets/forms.ts:175

Adds command button with the specified text.

Parameters

Parameter	Type	Default value	Description
text	string	undefined	-
action	Function	undefined	-
index	number	0	-
tooltip	any	null	-

Returns

Dialog<Inputs>

---

addContextAction()

addContextAction(text, action): Dialog<Inputs>

Defined in: js-api/src/widgets/forms.ts:185

Adds context action with the specified text.

Parameters

Parameter	Type	Description
text	string	-
action	Function	-

Returns

Dialog<Inputs>

---

addInput()

addInput<K, V>(caption, input): Dialog<Record<K, V> & Inputs>

Defined in: js-api/src/widgets/forms.ts:139

Adds named input, which than can be used in combo with namedInputs, to get inputs in type-safe way

Type Parameters

Type Parameter
K extends string
V extends InputBase<any>

Parameters

Parameter	Type
caption	K
input	V

Returns

Dialog<Record<K, V> & Inputs>

---

apply()

apply(properties): Widget

Defined in: js-api/src/widgets/base.ts:261

Parameters

Parameter	Type	Description
properties	object	-

Returns

Widget

Inherited from

DartWidget.apply

---

awaitOnOK()

awaitOnOK<T>(handler): Promise<T>

Defined in: js-api/src/widgets/forms.ts:76

Sets the OK button handler and returns a promise of the handler callback.

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type	Description
handler	() => Promise<T>	-

Returns

Promise<T>

---

bindProps()

bindProps(): BindProp[]

Defined in: js-api/src/u2core/component.ts:285

The signal-backed subset of the meta props — what a binding picker offers on a named node — plus, under propertyTier, every declared property. Allocates no signal.

Returns

BindProp[]

Inherited from

DartWidget.bindProps

---

bindStep()

bindStep(name): BindSource | Signal<unknown> | null

Defined in: js-api/src/u2core/component.ts:274

One binding step (DD5): a meta-declared prop's same-named Signal member — a named node is a bind source, generated off componentMeta the way getProperties is — then, under propertyTier, a cached signal over the declared property. '' answers the default binding: the component's own value signal, where one exists.

Parameters

Parameter	Type
name	string

Returns

BindSource | Signal<unknown> | null

Inherited from

DartWidget.bindStep

---

clear()

clear(): void

Defined in: js-api/src/widgets/forms.ts:205

Clears the content.

Returns

void

---

close()

close(): void

Defined in: js-api/src/widgets/forms.ts:156

Closes the dialog.

Returns

void

---

detach()

detach(): void

Defined in: js-api/src/widgets/base.ts:308

Gets called when a widget is detached and will no longer be used. Typically used for unsubscribing from events. Be sure to call super.detach() if this method is overridden.

Returns

void

Inherited from

DartWidget.detach

---

dispose()

dispose(): void

Defined in: js-api/src/u2core/component.ts:141

On a never-engaged wrapper the getter mints here and _scopeMinted wires the lifecycle (own(kill) + the platform cleanup for Dart-owned), so dispose still kills it; re-entry from the kill cleanup is a no-op via the scope's disposed flag.

Returns

void

Inherited from

DartWidget.dispose

---

effect()

effect(fn): this

Defined in: js-api/src/u2core/component.ts:128

Parameters

Parameter	Type
fn	() => void

Returns

this

Inherited from

DartWidget.effect

---

fireEvent()

protected fireEvent(eventId, args?): void

Defined in: js-api/src/u2core/component.ts:413

Parameters

Parameter	Type
eventId	string
args?	unknown

Returns

void

Inherited from

DartWidget.fireEvent

---

getButton()

getButton(text): HTMLButtonElement

Defined in: js-api/src/widgets/forms.ts:164

Returns command button with the specified text.

Parameters

Parameter	Type	Description
text	string	-

Returns

HTMLButtonElement

---

getDartProperties()

getDartProperties(): any[]

Defined in: js-api/src/widgets/base.ts:289

Returns

any[]

Inherited from

DartWidget.getDartProperties

---

getFunctions()

getFunctions(): Func[]

Defined in: js-api/src/widgets/base.ts:453

Functions that are applicable to this particular widget. Used in the UI to display context actions, and for the AI integrations.

Returns

Func[]

Inherited from

DartWidget.getFunctions

---

getProperties()

getProperties(): Property[]

Defined in: js-api/src/widgets/base.ts:452

Returns all properties of this widget: the meta-generated ones plus addProperty's.

Returns

Property[]

Inherited from

DartWidget.getProperties

---

getWidgetStatus()

getWidgetStatus(): IWidgetStatus

Defined in: js-api/src/widgets/base.ts:454

Returns the widget's runtime structure for automated testing and introspection.

Returns

IWidgetStatus

Inherited from

DartWidget.getWidgetStatus

---

history()

history(getInput, applyInput): void

Defined in: js-api/src/widgets/forms.ts:194

Initializes the 'history' feature.

Parameters

Parameter	Type	Description
getInput	() => any	collects the input from UI into JSON-serializable object
applyInput	(x) => void	refreshes the UI according to input

Returns

void

---

initDefaultHistory()

initDefaultHistory(): Dialog<Inputs>

Defined in: js-api/src/widgets/forms.ts:199

Initializes default history.

Returns

Dialog<Inputs>

---

initFromLocalStorage()

initFromLocalStorage(): void

Defined in: js-api/src/widgets/forms.ts:215

Initializes the dialog properties from local storage.

Returns

void

---

input()

input(caption): InputBase

Defined in: js-api/src/widgets/forms.ts:55

Returns an input with the specified caption, or throws an exception.

Parameters

Parameter	Type
caption	string

Returns

InputBase

---

link()

link(name, source, twoWay): void

Defined in: js-api/src/u2core/component.ts:246

Keeps this component's name step and source equal, echo-suppressed by value; the reverse direction only where twoWay. A component that took source as its own signal needs no link and gets none; a read-only step cannot follow anything and gets none either.

Parameters

Parameter	Type
name	string
source	Signal<unknown>
twoWay	boolean

Returns

void

Inherited from

DartWidget.link

---

onCancel()

onCancel(handler): Dialog<Inputs>

Defined in: js-api/src/widgets/forms.ts:92

Sets the CANCEL button handler

Parameters

Parameter	Type	Description
handler	Function	-

Returns

Dialog<Inputs>

---

onEvent()

onEvent(eventId?): Observable<any>

Defined in: js-api/src/widgets/base.ts:468

Observes events with the specified eventId. Override in subclasses to provide actual events.

Parameters

Parameter	Type	Default value
eventId	string | null	null

Returns

Observable<any>

Inherited from

DartWidget.onEvent

---

onFrameAttached()

onFrameAttached(dataFrame): void

Defined in: js-api/src/widgets/base.ts:295

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

Inherited from

DartWidget.onFrameAttached

---

onOK()

onOK(handler, options?): Dialog<Inputs>

Defined in: js-api/src/widgets/forms.ts:67

Sets the OK button handler, and shows the OK button

Parameters

Parameter	Type	Description
handler	Function	-
options?	{ closeOnEnter?: boolean; }	-
options.closeOnEnter?	boolean	-

Returns

Dialog<Inputs>

---

onPropertyChanged()

onPropertyChanged(property): void

Defined in: js-api/src/widgets/base.ts:287

Gets called when viewer's property is changed.

Parameters

Parameter	Type	Description
property	Property | null	or null, if multiple properties were changed.

Returns

void

Inherited from

DartWidget.onPropertyChanged

---

own()

own(dispose): this

Defined in: js-api/src/u2core/component.ts:133

Parameters

Parameter	Type
dispose	() => void

Returns

this

Inherited from

DartWidget.own

---

propertyChanges()

protected propertyChanges(): ObservableLike<PropertyChange>

Defined in: js-api/src/widgets/base.ts:366

What refreshes the property tier's cached signals from outside: null where nothing announces a change (one-way).

Returns

ObservableLike<PropertyChange>

Inherited from

DartWidget.propertyChanges

---

registerFunction()

protected registerFunction(f): void

Defined in: js-api/src/u2core/component.ts:409

Parameters

Parameter	Type
f	FuncLike

Returns

void

Inherited from

DartWidget.registerFunction

---

run()

run<T>(fn): T

Defined in: js-api/src/u2core/component.ts:124

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
fn	() => T

Returns

T

Inherited from

DartWidget.run

---

show()

show(options?): Dialog<Inputs>

Defined in: js-api/src/widgets/forms.ts:118

Parameters

Parameter	Type	Description
options?	{ backgroundColor?: string; center?: boolean; centerAt?: Element; fullScreen?: boolean; height?: number; modal?: boolean; resizable?: boolean; showNextTo?: HTMLElement; width?: number; x?: number; y?: number; }	-
options.backgroundColor?	string	-
options.center?	boolean	-
options.centerAt?	Element	-
options.fullScreen?	boolean	-
options.height?	number	-
options.modal?	boolean	-
options.resizable?	boolean	-
options.showNextTo?	HTMLElement	-
options.width?	number	-
options.x?	number	-
options.y?	number	-

Returns

Dialog<Inputs>

---

showModal()

showModal(fullScreen): Dialog<Inputs>

Defined in: js-api/src/widgets/forms.ts:125

Parameters

Parameter	Type	Description
fullScreen	boolean	-

Returns

Dialog<Inputs>

---

sourceRowsChanged()

sourceRowsChanged(): void

Defined in: js-api/src/widgets/base.ts:293

Returns

void

Inherited from

DartWidget.sourceRowsChanged

---

sub()

sub(subscription): void

Defined in: js-api/src/widgets/base.ts:254

Registers a subscription to an external event.

Parameters

Parameter	Type	Description
subscription	Subscription	-

Returns

void

Inherited from

DartWidget.sub

---

toDart()

toDart(): any

Defined in: js-api/src/widgets/base.ts:246

Returns

any

Inherited from

DartWidget.toDart

---

build()

static build(builder): Control

Defined in: js-api/src/u2core/component.ts:470

Builds a control out of plain elements: builder runs with the new control's scope ambient, so signal bindings and nested components inside it are owned by the result. The ambient scope only spans the synchronous part of builder — components constructed after an await inside it are adopted by nobody and must be disposed by hand, or constructed before the first await.

Parameters

Parameter	Type
builder	() => HTMLElement | (string | HTMLElement | Control)[]

Returns

Control

Inherited from

DartWidget.build

---

create()

static create(options?): Dialog

Defined in: js-api/src/widgets/forms.ts:36

Creates a new dialog with the specified options.

Parameters

Parameter	Type
options?	string | { helpUrl?: string; showFooter?: boolean; showHeader?: boolean; title?: string; }

Returns

Dialog

---

find()

static find(root): Widget<any> | null

Defined in: js-api/src/widgets/base.ts:236

Finds existing widget from its visual root.

Parameters

Parameter	Type
root	Element

Returns

Widget<any> | null

Inherited from

DartWidget.find

---

fromRoot()

static fromRoot(root): Widget

Defined in: js-api/src/widgets/base.ts:425

Creates a new widget from the root element.

Parameters

Parameter	Type
root	HTMLElement

Returns

Widget

Inherited from

DartWidget.fromRoot

---

getAll()

static getAll(): Widget<any>[]

Defined in: js-api/src/widgets/base.ts:231

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

DartWidget.getAll

---

getOpenDialogs()

static getOpenDialogs(): Dialog<{ }>[]

Defined in: js-api/src/widgets/forms.ts:210

Returns currently open dialogs.

Returns

Dialog<{ }>[]

---

init()

static init(self, scope?): void

Defined in: js-api/src/u2core/component.ts:83

Per-instance state, for a constructed component and for an adopted platform object alike.

Parameters

Parameter	Type
self	Component
scope?	Scope

Returns

void

Inherited from

DartWidget.init

---

is()

static is(x): x is Control

Defined in: js-api/src/u2core/component.ts:439

Structural probe by methods only — never .scope: the accessor mints.

Parameters

Parameter	Type
x	unknown

Returns

x is Control

Inherited from

DartWidget.is

---

registerCleanup()

static registerCleanup(element, cleanup): void

Defined in: js-api/src/widgets/base.ts:242

Registers a cleanup function to run when [element] is killed — i.e. when its host view or pane closes. Also marks the element so the kill-walk can find it.

Parameters

Parameter	Type
element	Element
cleanup	Function

Returns

void

Inherited from

DartWidget.registerCleanup

---

sameValue()

static sameValue(a, b): boolean

Defined in: js-api/src/u2core/component.ts:105

The equality the property tier and link suppress echoes by: Object.is, arrays element-wise, plain objects key-wise (recursive), everything else by identity.

Parameters

Parameter	Type
a	unknown
b	unknown

Returns

boolean

Inherited from

DartWidget.sameValue