patternfly / patternfly/patternfly-react
JumpLinks - add aria-labelledby prop and warning for aria labels
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- TypeScript
- Star
- 862
- Fork
- 392
- Merge trung bình
- 4 ngày 8 giờ
- Pull request đã merge (30 ngày)
- 9
Mô tả
Is this a new component or an extension of an existing one?
JumpLinks
Describe the feature
Follow up to comments in https://github.com/patternfly/patternfly-org/pull/3808
Basically right now the default value of the aria-label on JumpLinks is set to the label prop if passed in, and only if label is a string. Ideally we should consider making updates so that:
-
an
aria-labelledbyprop can be passed in which can be given anidof thelabelelement or some other element that labels the jump links nav. -
if
labelis not a string andaria-labelledbyis not manually passed in, generate a randomidinternally that's applied to thelabelwrapper element (pf-v5-c-jump-links__label), with thatidpassed to an aria-labelledby attribute on the outer JumpLinksnavelement. -
We could also consider removing the default value of the
aria-labelprop, but that may need to wait for a breaking change. Rationale here is that it would make more sense to link to the visible text label viaaria-labelledbyrather than repeat the text in anaria-label; while React is automating that for the consumer, it's only when the label prop is a string and in the HTML implementation there isn't that same automation provided by us
We should also add in a console warning if neither aria-label or aria-labelledby are passed in, otherwise there's a chance that the JumpLinks internal nav has no proper accessible name.
Are there visuals for this feature? If applicable, please include examples for each state and for varying widths
Include screenshots or links to Marvel or other mockups.
Any other information?
A followup will need to be made in org to add verbiage to the a11y docs for JumpLinks
Jira Issue: PF-109
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu từ điểm vào của component JumpLinks và đọc cách xử lý label và aria-label hiện có. Theo dõi cách props được truyền đến label wrapper và nav, sau đó xác minh rằng hỗ trợ aria-labelledby, label id được tạo và cảnh báo về việc thiếu accessible name đáp ứng issue; tài liệu về khả năng truy cập của PatternFly org vẫn là phần sẽ thực hiện tiếp theo.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- react, typescript
- Lĩnh vực
- accessibility, frontend
- Loại issue
- Tính năng
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Ít trao đổi
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 52/100