ui5-webcomponents
ui5-webcomponents copied to clipboard
[UI5 Web Components 2.0] General guidance for API revision from accessibility perspective
Motivation and Goal
The goal is to create a central general guidance for the accessibility API in order to achieve consistency across the components and clean-up differences
Expected Output
- Make the analysis and create documentation with general guidance and recommendation how the accessibility related API needs to be implemented (which can be used also for future reference).
- Prepare and create the follow-up issues for team execution in order to have clarity and clear guidance.
Initial analysis
General topics
- title – must be renamed to tooltip and made public, where relevant
- ariaHasPopup & ariaHaspopup – we have inconsistencies in the naming that needs to be solved. Can be moved to accessibleAttributes.
- accessibleName, accessibleNameRef, accessibleAttributes & accessibleRoleDescription - inconsistencies in default values and types needs to be solved
Component specific info
- Avatar & AvatarGroup - ariaHasPopup (protected) - see ariaHaspopup section above
- Icon - ariaHidden (private) – remove the property, add an internal method (to be used by our components) to apply the aria-hidden attribute in the shadow dom only
- Label - for – we need to rename it, as this an attribute relevant for the native HTML element label
- Link - title – see title section above
- ListItem title – see title section above role & accessibleRole – only accessibleRole should remain. Maybe think of a enum as a type ariaHasPopup – see ariaHaspopup section above
- SideNavigationItemBase title – see title section above
Related to: https://github.com/SAP/ui5-webcomponents/issues/4460
Internal BLI created: BGSOFUIRILA-3820