ITextOptions | @jupyterlab (original) (raw)

Constructor options for text input dialogs

Hierarchy (View Summary)

Index

Properties

OptionalcancelLabel

cancelLabel?: string

Label for cancel button.

Optionalcheckbox

The checkbox to display in the footer. Defaults no checkbox.

OptionaldefaultButton

defaultButton?: number

The index of the default button. Defaults to the last button.

Optionalhost

The host element for the dialog. Defaults to document.body.

Optionallabel

label?: string

Label of the requested input

OptionalokLabel

okLabel?: string

Label for ok button.

Optionalpattern

pattern?: string

Pattern used by the browser to validate the input value.

Optionalplaceholder

placeholder?: string

Placeholder text

Optionalprefix

prefix?: string

Additional prefix string preceding the input (e.g. £).

Optionalrenderer

An optional renderer for dialog items. Defaults to a shared default renderer.

Optionalrequired

required?: boolean

Whether the input is required (has to be non-empty).

OptionalselectionRange

selectionRange?: number

Optionalsuffix

suffix?: string

Additional suffix string following the input (e.g. $).

Optionaltext

text?: string

Default input text

title

The top level text for the dialog. Defaults to an empty string.