File tree Expand file tree Collapse file tree 1 file changed +34
-0
lines changed
src/vs/base/parts/quickinput/common Expand file tree Collapse file tree 1 file changed +34
-0
lines changed Original file line number Diff line number Diff line change @@ -353,26 +353,60 @@ export interface IQuickInputToggle {
353
353
354
354
export interface IInputBox extends IQuickInput {
355
355
356
+ /**
357
+ * Value shown in the input box.
358
+ */
356
359
value : string ;
357
360
361
+ /**
362
+ * Provide start and end values to be selected in the input box.
363
+ */
358
364
valueSelection : Readonly < [ number , number ] > | undefined ;
359
365
366
+ /**
367
+ * Value shown as example for input.
368
+ */
360
369
placeholder : string | undefined ;
361
370
371
+ /**
372
+ * Determines if the input value should be hidden while typing.
373
+ */
362
374
password : boolean ;
363
375
376
+ /**
377
+ * Event called when the input value changes.
378
+ */
364
379
readonly onDidChangeValue : Event < string > ;
365
380
381
+ /**
382
+ * Event called when the user submits the input.
383
+ */
366
384
readonly onDidAccept : Event < void > ;
367
385
386
+ /**
387
+ * Buttons to show in addition to user input submission.
388
+ */
368
389
buttons : ReadonlyArray < IQuickInputButton > ;
369
390
391
+ /**
392
+ * Event called when a button is selected.
393
+ */
370
394
readonly onDidTriggerButton : Event < IQuickInputButton > ;
371
395
396
+ /**
397
+ * Text show below the input box.
398
+ */
372
399
prompt : string | undefined ;
373
400
401
+ /**
402
+ * An optional validation message indicating a problem with the current input value.
403
+ * Returning undefined clears the validation message.
404
+ */
374
405
validationMessage : string | undefined ;
375
406
407
+ /**
408
+ * Severity of the input validation message.
409
+ */
376
410
severity : Severity ;
377
411
}
378
412
You can’t perform that action at this time.
0 commit comments