Feat: Enhance button accessibility
Summary
- Added ARIA attributes for better screen reader support
- Implemented isLoading state with aria-busy attribute
- Added loading indicator with accessible spinner
- Added loadingText prop for better UX during loading states
- Improved disabled state handling with aria-disabled
Accessibility Improvements
This PR enhances the Button component to be more accessible by:
- Adding proper ARIA attributes (aria-busy, aria-disabled) to communicate button state to screen readers
- Implementing a visually apparent loading state with a spinner
- Adding support for alternative loading text to improve the user experience
- Properly handling disabled states for better accessibility
These changes follow WCAG 2.1 guidelines for accessible interactive elements, focusing on:
- 4.1.2: Name, Role, Value - Ensuring UI components have proper state information
- 1.4.1: Use of Color - Not relying on color alone to convey state
🤖 Generated with Claude Code
Summary by CodeRabbit
-
New Features
- Added loading state support to buttons, including a spinning icon and optional loading text when active.
-
Style
- Updated button styling to show a progress cursor when busy.
Walkthrough
The Button component in the mail application was enhanced to support a loading state. New props allow the button to display a spinner and loading text, set appropriate ARIA attributes, and show a progress cursor when busy. The ButtonProps interface was updated to reflect these changes.
Changes
| File(s) | Change Summary |
|---|---|
| apps/mail/components/ui/button.tsx | Added isLoading and loadingText props to Button; implemented loading state UI and ARIA improvements |
Sequence Diagram(s)
sequenceDiagram
participant ParentComponent
participant Button
ParentComponent->>Button: Render with isLoading=false
Button-->>ParentComponent: Renders normal button
ParentComponent->>Button: Render with isLoading=true, loadingText
Button-->>ParentComponent: Renders disabled button with spinner and loadingText, sets aria-busy
Possibly related PRs
- Mail-0/Zero#1343: Replaces native button elements with the Button component, indicating related usage patterns but does not modify the Button component itself.
Poem
A button now spins with a twirl and a flash,
Showing it's busy—no need to dash!
With loading text clear and a cursor anew,
The Button’s more helpful for all that you do.
🐇✨
✨ Finishing Touches
- [ ] 📝 Generate Docstrings
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
🪧 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. -
Explain this complex logic. -
Open a follow-up GitHub issue for this discussion.
-
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:-
@coderabbitai explain this code block. -
@coderabbitai modularize this function.
-
- PR comments: Tag
@coderabbitaiin 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 explain its main purpose. -
@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.
-
Support
Need help? Create a ticket on our support page for assistance with any issues or questions.
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 pauseto pause the reviews on a PR. -
@coderabbitai resumeto resume the paused reviews. -
@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository. -
@coderabbitai full reviewto do a full review from scratch and review all the files again. -
@coderabbitai summaryto regenerate the summary of the PR. -
@coderabbitai generate docstringsto generate docstrings for this PR. -
@coderabbitai generate sequence diagramto generate a sequence diagram of the changes in this PR. -
@coderabbitai resolveresolve all the CodeRabbit review comments. -
@coderabbitai configurationto show the current CodeRabbit configuration for the repository. -
@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.
@harshith-eth please add a video/screenshot next time, thank you!
Noted @MrgSub 🫡