Skip to content

Commit 768a8ca

Browse files
authored
docs(ui5-element): update docu for the accessibilityInfo (#12723)
1 parent 1eb0155 commit 768a8ca

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

packages/base/src/UI5Element.ts

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1112,7 +1112,18 @@ abstract class UI5Element extends HTMLElement {
11121112
}
11131113

11141114
/**
1115-
* Returns the component accessibility info.
1115+
* Provides the accessibility information for the component.
1116+
*
1117+
* **Note:** The default implementation returns `undefined`, indicating that
1118+
* the component does not provide any accessibility metadata by default. In such cases,
1119+
* consumers of this API may apply their own fallback if needed.
1120+
*
1121+
* Subclasses overriding this getter must return an object of type `AccessibilityInfo`
1122+
* describing the component's accessible name, role, description, and other relevant properties.
1123+
*
1124+
* If the component is intentionally decorative and should be ignored by assistive
1125+
* technologies, return an empty object `{}`.
1126+
*
11161127
* @private
11171128
*/
11181129
get accessibilityInfo(): AccessibilityInfo | undefined {

0 commit comments

Comments
 (0)