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

[WEB-2912]fix: modified link behaviour to improve accessibility #6282

Closed
wants to merge 1 commit into from

Conversation

vamsikrishnamathala
Copy link
Collaborator

@vamsikrishnamathala vamsikrishnamathala commented Dec 27, 2024

Description

Updated the Link component to allow clicking anywhere on the link to open it in a new tab. Replaced the external link icon with a copy link icon for improved functionality.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Improvement (change that would cause existing functionality to not work as expected)
  • Code refactoring
  • Performance improvements
  • Documentation update

References

WEB-2912

Summary by CodeRabbit

  • New Features

    • Introduced a new Copy icon for copying links in the IssueLinkItem and ModulesLinksListItem components.
    • Enhanced user interaction by allowing links to be copied via a clickable span element, improving accessibility and usability.
  • Bug Fixes

    • Adjusted link handling logic to ensure proper functionality when copying links to the clipboard.

Copy link
Contributor

coderabbitai bot commented Dec 27, 2024

Walkthrough

The pull request introduces modifications to two components: IssueLinkItem and ModulesLinksListItem. In both cases, the changes involve replacing the ExternalLink icon with a Copy icon from the lucide-react library and adjusting the link copying functionality. The components now use a more interactive approach to copying links, with the copy action triggered by clicking a specific icon and maintaining the ability to open links in a new tab.

Changes

File Change Summary
web/core/components/issues/issue-detail/links/link-item.tsx - Replaced ExternalLink icon with Copy icon
- Modified link display to use anchor tag
- Moved link copy functionality to Copy icon
web/core/components/modules/links/list-item.tsx - Removed ExternalLink icon
- Added Copy icon from lucide-react
- Updated link copying mechanism
- Replaced anchor tag with tooltip-wrapped anchor

Sequence Diagram

sequenceDiagram
    participant User
    participant LinkComponent
    participant Clipboard
    participant Toast

    User->>LinkComponent: Click Copy Icon
    LinkComponent->>Clipboard: Copy Link
    Clipboard-->>LinkComponent: Link Copied
    LinkComponent->>Toast: Show Confirmation
Loading

Possibly related PRs

Suggested labels

🌟enhancement, 🎨UI / UX

Suggested reviewers

  • sriramveeraghanta
  • SatishGandham
  • rahulramesha

Poem

🐰 Hop, hop, a link so bright,
Copy with a click, pure delight!
Icons dance, tooltips gleam,
User experience, a rabbit's dream
Functionality flows, smooth and light 🔗✨


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.

@vamsikrishnamathala vamsikrishnamathala added the 🌟enhancement New feature or request label Dec 27, 2024
@vamsikrishnamathala vamsikrishnamathala added this to the v0.24.2 milestone Dec 27, 2024
@vamsikrishnamathala vamsikrishnamathala marked this pull request as draft December 27, 2024 10:29
Copy link
Contributor

@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 (5)
web/core/components/modules/links/list-item.tsx (3)

48-50: Ensure accessible link text.
While the link is opened in a new tab, consider providing a clear label or an aria-label to announce this for screen readers, e.g., "Open link in a new tab". This ensures better accessibility compliance.


68-70: Provide user feedback for copying when text differs from URL.
The code copies either the title or the URL, but the toast message always says “URL.” Consider tailoring the toast message to clarify what was actually copied (either the title or the URL), to avoid user confusion.


72-73: Add aria-label or title for the copy icon.
Assistive technologies may need descriptive text about this icon’s action (e.g., “Copy link to clipboard”).

web/core/components/issues/issue-detail/links/link-item.tsx (2)

51-54: Adopt an aria-label for the anchor.
Since the link opens in a new tab, consider adding something like aria-label="Open link in a new tab" or a visually hidden indicator to improve screen reader clarity.

Also applies to: 58-58


65-73: Ensure consistent user experience across devices.
The copy icon triggers a toast notification, which is great feedback. Consider consistency with the label shown in the notification text, and also ensure it is easily dismissible on mobile devices if it covers interactive elements.

Also applies to: 76-77

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4159d12 and 133a65b.

📒 Files selected for processing (2)
  • web/core/components/issues/issue-detail/links/link-item.tsx (2 hunks)
  • web/core/components/modules/links/list-item.tsx (3 hunks)
🔇 Additional comments (2)
web/core/components/modules/links/list-item.tsx (1)

2-2: Good introduction of the Copy icon.
Importing the Copy icon from lucide-react aligns with the new requirement to copy URLs more easily.

web/core/components/issues/issue-detail/links/link-item.tsx (1)

5-5: New icon usage is consistent with the updated design.
Replacing ExternalLink with Copy matches the plan to emphasize link copying.

@vamsikrishnamathala vamsikrishnamathala marked this pull request as ready for review December 27, 2024 10:31
@vamsikrishnamathala vamsikrishnamathala deleted the chore-link_behaviour branch December 27, 2024 12:12
@vamsikrishnamathala vamsikrishnamathala restored the chore-link_behaviour branch December 27, 2024 12:12
@pushya22 pushya22 deleted the chore-link_behaviour branch December 27, 2024 12:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🌟enhancement New feature or request 🌐frontend
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants