DialogProperties

dialogs DialogProperties

Configuration object for building a dialog.

See also

buildDialog

Table of contents

Properties

• cancelable
• canceledOnTouchOutside
• checkBoxChecked
• checkBoxPrompt
• content
• contentColor
• contentLineSpacing
• customView
• icon
• inputHint
• inputPrefill
• items
• itemsColor
• itemsSelectMode
• itemsSelectedIndex
• negative
• negativeColor
• neutral
• neutralColor
• positive
• positiveColor
• progress
• title
• type
• wrapInScrollView

Properties

cancelable

• Optional Readonly cancelable: boolean

Whether the dialog can be dismissed by the user. If false, it can only be closed from code. Default false.

canceledOnTouchOutside

• Optional Readonly canceledOnTouchOutside: boolean

Whether tapping outside the dialog dismisses it. Default true.

checkBoxChecked

• Optional Readonly checkBoxChecked: boolean

Initial checked state of the checkbox.

checkBoxPrompt

• Optional Readonly checkBoxPrompt: string

Label text for the checkbox.

content

• Optional Readonly content: string

Main message body text.

contentColor

• Optional Readonly contentColor: Color

Color of the message text.

contentLineSpacing

• Optional Readonly contentLineSpacing: number

Line-height multiplier for the message; 1.0 is single spacing.

customView

• Optional Readonly customView: any

Custom view (for example from inflateXml). When set, most built-in fields (content, progress, input, etc.) are ignored—you must build those in the custom view.

icon

• Optional Readonly icon: string

Icon URL or image object.

inputHint

• Optional Readonly inputHint: string

Hint text for the input field.

inputPrefill

• Optional Readonly inputPrefill: string

Default text placed in the input field.

items

• Optional Readonly items: string[]

List entries for a list-style dialog.

itemsColor

• Optional Readonly itemsColor: Color

Text color for list items.

itemsSelectMode

• Optional Readonly itemsSelectMode: "multi" | "single" | "select"

List selection mode: multi (checkboxes), single (radio), or select (simple choice list).

itemsSelectedIndex

• Optional Readonly itemsSelectedIndex: number | number[]

Pre-selected item index(es): a single number in single-select mode, or an array in multi-select mode.

negative

• Optional Readonly negative: string

Label for the negative button (to the left of the positive button—typically “Cancel”).

negativeColor

• Optional Readonly negativeColor: Color

Text color for the negative button.

neutral

• Optional Readonly neutral: string

Label for the neutral button (leftmost when shown).

neutralColor

• Optional Readonly neutralColor: Color

Text color for the neutral button.

positive

• Optional Readonly positive: string

Label for the positive button (rightmost—typically “OK”).

positiveColor

• Optional Readonly positiveColor: Color

Text color for the positive button.

progress

• Optional Readonly progress: Object

Progress bar configuration.

Type declaration

Name	Type	Description
horizontal?	boolean	Use a horizontal bar; default false.
max	number	Maximum value.
progress?	number	Current value.
showMinMax?	boolean	Show min/max indicators; default true.

title

• Optional Readonly title: string

Dialog title.

type

• Optional Readonly type: DialogType

Dialog kind. See DialogType and defaultDialogType. If unset, follows defaultDialogType (often app).

wrapInScrollView

• Optional Readonly wrapInScrollView: boolean

Wrap content in a scroll view. Default true.