Skip to content
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.

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

[UI5 Web Components 2.0] General guidance for API revision from accessibility perspective #8353

Closed
nikolay-kolarov opened this issue Feb 27, 2024 · 4 comments · Fixed by #8810

Comments

@nikolay-kolarov
Copy link

nikolay-kolarov commented Feb 27, 2024

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

  1. 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).
  2. Prepare and create the follow-up issues for team execution in order to have clarity and clear guidance.

Initial analysis

General topics

  1. title – must be renamed to tooltip and made public, where relevant
  2. ariaHasPopup & ariaHaspopup – we have inconsistencies in the naming that needs to be solved. Can be moved to accessibleAttributes.
  3. accessibleName, accessibleNameRef, accessibleAttributes & accessibleRoleDescription - inconsistencies in default values and types needs to be solved

Component specific info

  1. Avatar & AvatarGroup - ariaHasPopup (protected) - see ariaHaspopup section above
  2. 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
  3. Label - for – we need to rename it, as this an attribute relevant for the native HTML element label
  4. Link - title – see title section above
  5. 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
  6. SideNavigationItemBase
    title – see title section above
@ilhan007
Copy link
Member

Related to: #4460

@hristop hristop added this to the 1.24.0 milestone Mar 6, 2024
@hristop
Copy link
Contributor

hristop commented Mar 6, 2024

Internal BLI created: BGSOFUIRILA-3820

@dobrinyonkov
Copy link
Contributor

I believe this item can be closed now since the new API addressing all teams components is merged #8810.

@ilhan007
Copy link
Member

If this article is up to date and does not require any changes, this can be closed

@ilhan007 ilhan007 removed this from the 2.1.0 milestone Aug 8, 2024
@ilhan007 ilhan007 moved this from New to Completed in Planning - Topic Core Nov 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment