Skip to content

Commit dad6988

Browse files
Add jsdoc to IQuickInput (microsoft#154255) (microsoft#158907)
* Add jsdoc to IQuickInput (microsoft#154255) * Apply suggestions from code review Co-authored-by: Tyler James Leonhardt <[email protected]>
1 parent 8cb8a76 commit dad6988

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

src/vs/base/parts/quickinput/common/quickInput.ts

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -353,26 +353,60 @@ export interface IQuickInputToggle {
353353

354354
export interface IInputBox extends IQuickInput {
355355

356+
/**
357+
* Value shown in the input box.
358+
*/
356359
value: string;
357360

361+
/**
362+
* Provide start and end values to be selected in the input box.
363+
*/
358364
valueSelection: Readonly<[number, number]> | undefined;
359365

366+
/**
367+
* Value shown as example for input.
368+
*/
360369
placeholder: string | undefined;
361370

371+
/**
372+
* Determines if the input value should be hidden while typing.
373+
*/
362374
password: boolean;
363375

376+
/**
377+
* Event called when the input value changes.
378+
*/
364379
readonly onDidChangeValue: Event<string>;
365380

381+
/**
382+
* Event called when the user submits the input.
383+
*/
366384
readonly onDidAccept: Event<void>;
367385

386+
/**
387+
* Buttons to show in addition to user input submission.
388+
*/
368389
buttons: ReadonlyArray<IQuickInputButton>;
369390

391+
/**
392+
* Event called when a button is selected.
393+
*/
370394
readonly onDidTriggerButton: Event<IQuickInputButton>;
371395

396+
/**
397+
* Text show below the input box.
398+
*/
372399
prompt: string | undefined;
373400

401+
/**
402+
* An optional validation message indicating a problem with the current input value.
403+
* Returning undefined clears the validation message.
404+
*/
374405
validationMessage: string | undefined;
375406

407+
/**
408+
* Severity of the input validation message.
409+
*/
376410
severity: Severity;
377411
}
378412

0 commit comments

Comments
 (0)