跳至主要内容

界面:InputBoxOptions

配置输入框 UI 行为的选项。

属性

ignoreFocusOut?

optional ignoreFocusOut: boolean

设置为 true 以在焦点移动到编辑器的其他部分或其他窗口时保持输入框打开。此设置在 iPad 上被忽略,并且始终为 false。

定义在

packages/extension-api/src/extension-api.d.ts:1407


markdownDescription?

optional markdownDescription: string

要显示的字段的描述(Markdown 格式)

定义在

packages/extension-api/src/extension-api.d.ts:1391


multiline?

optional multiline: boolean

当值表示多行内容时,设置为 true

定义在

packages/extension-api/src/extension-api.d.ts:1412


password?

optional password: boolean

控制是否显示密码输入。密码输入隐藏输入的文本。

定义在

packages/extension-api/src/extension-api.d.ts:1401


placeHolder?

optional placeHolder: string

一个可选的字符串,显示为输入框中的占位符,以指导用户输入什么。

定义在

packages/extension-api/src/extension-api.d.ts:1396


prompt?

optional prompt: string

要在输入框下方显示的文本。

定义在

packages/extension-api/src/extension-api.d.ts:1386


title?

optional title: string

一个可选的字符串,表示输入框的标题。

定义在

packages/extension-api/src/extension-api.d.ts:1368


value?

optional value: string

要在输入框中预先填充的值。

定义在

packages/extension-api/src/extension-api.d.ts:1373


valueSelection?

optional valueSelection: [number, number]

预先填充的 value 的选择。定义为两个数字的元组,其中第一个是包含的起始索引,第二个是独占的结束索引。当 undefined 时,将选择整个预先填充的值,当为空(开始等于结束)时,只设置光标,否则将选择定义的范围。

定义在

packages/extension-api/src/extension-api.d.ts:1381

方法

validateInput()?

optional validateInput(value): undefined | null | string | InputBoxValidationMessage | Promise<undefined | null | string | InputBoxValidationMessage>

一个可选函数,将被调用以验证输入并向用户提供提示。

参数

value: string

输入框的当前值。

返回

undefined | null | string | InputBoxValidationMessage | Promise<undefined | null | string | InputBoxValidationMessage>

一个可读的字符串,显示为错误消息,或一个 InputBoxValidationMessage,它可以提供特定的消息严重性。当 'value' 有效时,返回 undefinednull 或空字符串。

定义在

packages/extension-api/src/extension-api.d.ts:1422