Skip to content

Commit 5bc04b6

Browse files
authored
chore: add example to JSDoc for getAriaValue (#9692)
1 parent 4163db8 commit 5bc04b6

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

packages/blockly/core/field.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -329,6 +329,11 @@ export abstract class Field<T = any>
329329
* entirely when there may be a better contextual placeholder to use, instead,
330330
* specific to the field.
331331
*
332+
* For example, a text input field may have a value of null when empty. To
333+
* avoid hiding this field from screen reader, implementations should ensure
334+
* that if the value is null, this function would return an appropriate,
335+
* localized value such as "empty text".
336+
*
332337
* Implementations are responsible for, and encouraged to, return a localized
333338
* version of the ARIA representation of the field's value.
334339
*

0 commit comments

Comments
 (0)