Skip to content

Commit 035796d

Browse files
committed
Add setKeyboardNavInstructions to TypeScript declarations
1 parent 9591de8 commit 035796d

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

code-input.d.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -427,6 +427,12 @@ export class CodeInput extends HTMLElement {
427427
* that shouldn't scroll with the code-input element.
428428
*/
429429
dialogContainerElement?: HTMLElement
430+
/**
431+
* Show some instructions to the user only if they are using keyboard navigation - for example, a prompt on how to navigate with the keyboard if Tab is repurposed.
432+
* @param {string} instructions The instructions to display only if keyboard navigation is being used. If it's blank, no instructions will be shown.
433+
* @param {boolean} includeAriaDescriptionFirst Whether to include the aria-description of the code-input element before the keyboard navigation instructions for a screenreader. Keep this as true when the textarea is first focused.
434+
*/
435+
setKeyboardNavInstructions(instructions: string, includeAriaDescriptionFirst: boolean): void
430436
}
431437

432438
/**

esm/.code-input.mjs.kate-swp

98 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)