nextcloud-libraries / nextcloud-libraries/nextcloud-vue

Update design guidelines for accessibility

Open
#2,505 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

accessibility
Dominant language
Vue
Stars
246
Forks
99
Avg merge
1d 20h
Merged PRs (30d)
103

Description

In case we don't have these yet:

  • Difference between when to use a button or a link:
    • When you open a modal or something on the same page, it should be a button.
    • When you open a new page, it should be a link. All links need to have an href attribute, and not use tabindex="0"
    • Prefer to use native HTML elements instead of aria
    • We should not use just <div role="button"> because then we would have to implement basics like Enter and Space key functionality ourselves
  • Difference between aria-label and aria-describedby
    • aria-label is for the actual label
    • aria-describedby is for additional description
    • aria-labelledby can be used to link different elements.
    • For images, ideally always use native img elements, or SVG

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the repository's existing design guidelines or accessibility documentation; no specific file or test is named in the issue. Update the guidance to cover button versus link usage, native elements, ARIA labels and descriptions, and image elements, then verify that all requested recommendations are represented clearly.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
accessibility, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.