Skip to content

feat: add setAriaTypeName method for Fields #10154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mikeharv wants to merge 2 commits into
base: main
Choose a base branch
from
+19 −0
Open

feat: add setAriaTypeName method for Fields #10154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e69052
feat: add setAriaTypeName method for Fields
mikeharv Jul 17, 2026
dac761d
chore: add test
mikeharv Jul 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions packages/blockly/core/field.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,18 @@ export abstract class Field<T = any>
return this.ariaTypeName || null;
}

/**
* Sets the ARIA-friendly label representation of this field's type.
*
* Implementations are responsible for, and encouraged to, set a localized
* version of the ARIA representation of the field's type.
*
* @param ariaTypeName An ARIA representation of the field's type.
*/
setAriaTypeName(ariaTypeName: string) {
this.ariaTypeName = ariaTypeName;
}

/**
* Gets an ARIA-friendly label representation of this field's value.
*
Expand Down
7 changes: 7 additions & 0 deletions packages/blockly/tests/mocha/field_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -896,6 +896,13 @@ suite('Abstract Fields', function () {
assert.equal(field.computeAriaLabel(true), 'text: hello');
});

test('Custom type and value when ariaTypeName is set', function () {
const field = new TestField();
field.setAriaTypeName('speed');
field.setValue('fast');
assert.equal(field.computeAriaLabel(), 'speed: fast');
});

test('Type and placeholder when value is null', function () {
const field = new TestField(null, {ariaTypeName: 'text'});
assert.equal(
Expand Down
Loading