Skip to content

feat: improved accessibility #299

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

Merged
merged 4 commits into from
Jan 22, 2025
Merged

Conversation

aojunhao123
Copy link
Contributor

@aojunhao123 aojunhao123 commented Jan 21, 2025

QQ_1737462580657

div不能设置aria-selected属性,而且segmented本质上还是个Radio,应该使用aria-checked

Summary by CodeRabbit

  • 辅助功能改进
    • 更新分段选项组件的无障碍属性,将 div 元素的角色从通用选择指示器调整为更具语义的单选按钮角色。
    • 添加 role="radio"aria-checked 属性,以提高组件的可访问性和屏幕阅读器兼容性。

Copy link

coderabbitai bot commented Jan 21, 2025

Warning

Rate limit exceeded

@aojunhao123 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 24 minutes and 26 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 3355ab7 and 41ef344.

📒 Files selected for processing (1)
  • package.json (2 hunks)

概述

演练

此拉取请求修改了 src/index.tsx 中的 InternalSegmentedOption 组件的无障碍属性。具体而言,显示标签的 div 元素的无障碍属性发生了变化。原先的 aria-selected={checked} 被替换为 role="radio"aria-checked={checked},使元素的语义角色从通用选择指示器更改为更具体的单选按钮角色,提高了组件的无障碍性。

变更

文件 变更摘要
src/index.tsx 修改 InternalSegmentedOption 组件的无障碍属性,将 aria-selected 替换为 role="radio"aria-checked

可能相关的 PR

诗歌

🐰 无障碍的兔子轻跳跃
属性变更,角色更清晰
单选按钮,语义飞扬
代码如诗,可访问性绽放
无限可能,触手可及 🌈


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@aojunhao123
Copy link
Contributor Author

@afc163

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/index.tsx (1)

150-151: ARIA属性修改正确,建议进一步改进!

aria-selected替换为role="radio"aria-checked是正确的改进,符合WAI-ARIA规范。这些更改使得组件的语义更准确,提高了可访问性。

建议考虑添加以下改进:

  1. 添加aria-labelledby属性关联标签文本
  2. 考虑添加aria-describedby属性提供额外描述
 <div
   className={classNames(
     `${prefixCls}-item-label`,
     segmentedClassNames?.label,
   )}
   title={title}
   role="radio"
   aria-checked={checked}
+  aria-labelledby={`${prefixCls}-label-${value}`}
   style={styles?.label}
 >
+  <span id={`${prefixCls}-label-${value}`}>
     {label}
+  </span>
 </div>
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bdc6c15 and 3355ab7.

⛔ Files ignored due to path filters (1)
  • tests/__snapshots__/index.test.tsx.snap is excluded by !**/*.snap
📒 Files selected for processing (1)
  • src/index.tsx (1 hunks)

Copy link

New, updated, and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package New capabilities Transitives Size Publisher

🚮 Removed packages: npm/np@7.7.0

View full report↗︎

Copy link

codecov bot commented Jan 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.37%. Comparing base (bdc6c15) to head (41ef344).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #299   +/-   ##
=======================================
  Coverage   99.37%   99.37%           
=======================================
  Files           2        2           
  Lines         161      161           
  Branches       40       40           
=======================================
  Hits          160      160           
  Misses          1        1           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@afc163 afc163 merged commit 8dc9917 into react-component:master Jan 22, 2025
8 checks passed
@aojunhao123 aojunhao123 deleted the a11y-fix branch January 22, 2025 05:41
@aojunhao123
Copy link
Contributor Author

@afc163 佬,这个pr能带到v5吗?我看segmented里的部分依赖已经迁移到@rc-component里了

@afc163
Copy link
Member

afc163 commented Jan 23, 2025

可以,发个 PR 到 https://github.com/react-component/segmented/tree/2.7.x

aojunhao123 added a commit to aojunhao123/segmented that referenced this pull request Jan 24, 2025
* feat: add role attribute to InternalSegmentedOption for improved accessibility

* fix: update role and aria attributes

* test: update snapshot

* chore: add @rc-component/np dependency and remove np package
@aojunhao123
Copy link
Contributor Author

zombieJ pushed a commit that referenced this pull request Jan 24, 2025
* feat: improved accessibility (#299)

* feat: add role attribute to InternalSegmentedOption for improved accessibility

* fix: update role and aria attributes

* test: update snapshot

* chore: add @rc-component/np dependency and remove np package

* chore: add np package for release management
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants