接口:InputBoxOptions
定义于:packages/extension-api/src/extension-api.d.ts:1415
用于配置输入框 UI 行为的选项。
属性
ignoreFocusOut?
可选
ignoreFocusOut:boolean
定义于:packages/extension-api/src/extension-api.d.ts:1458
设置为 true
时,当焦点移至编辑器的其他部分或另一个窗口时,输入框将保持打开状态。此设置在 iPad 上将被忽略,并且始终为 false。
markdownDescription?
可选
markdownDescription:string
定义于:packages/extension-api/src/extension-api.d.ts:1442
要显示的字段的描述(Markdown 格式)
multiline?
可选
multiline:boolean
定义于:packages/extension-api/src/extension-api.d.ts:1463
设置为 true
时,表示值是多行内容。
password?
可选
password:boolean
定义于:packages/extension-api/src/extension-api.d.ts:1452
控制是否显示密码输入框。密码输入会隐藏输入的文本。
placeHolder?
可选
placeHolder:string
定义于:packages/extension-api/src/extension-api.d.ts:1447
用于引导用户输入内容的占位符字符串。
prompt?
可选
prompt:string
定义于:packages/extension-api/src/extension-api.d.ts:1437
显示在输入框下方的文本。
title?
optional
title:string
定义于:packages/extension-api/src/extension-api.d.ts:1419
输入框标题的可选字符串。
value?
可选
value:string
定义于:packages/extension-api/src/extension-api.d.ts:1424
用于预填充输入框的值。
valueSelection?
可选
valueSelection: [number
,number
]
定义于:packages/extension-api/src/extension-api.d.ts:1432
预填充的 value
的选择范围。定义为包含起始索引和不包含结束索引的数字元组。当 undefined
时,将选择所有预填充的值;当为空(起始等于结束)时,仅设置光标;否则,将选择定义的范围。
方法
validateInput()?
可选
validateInput(value
):undefined
|null
|string
|InputBoxValidationMessage
|Promise
<undefined
|null
|string
|InputBoxValidationMessage
>
定义于:packages/extension-api/src/extension-api.d.ts:1473
用于验证输入并向用户提供提示的可选函数。
参数
value
string
输入框的当前值。
返回
undefined
| null
| string
| InputBoxValidationMessage
| Promise
<undefined
| null
| string
| InputBoxValidationMessage
>
人类可读的字符串,将作为错误消息显示,或者一个 InputBoxValidationMessage,它可以提供特定的消息严重性。当 'value' 有效时,返回 undefined
、null
或空字符串。