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-2145] chore: added copy button for intake issues #5455

Merged
merged 3 commits into from
Aug 29, 2024

Conversation

Jimmycutie
Copy link
Contributor

@Jimmycutie Jimmycutie commented Aug 28, 2024

Changes

No 'copy link' option was available for issues in intake like in other features.

image
image

Implementation

  • Created a copy button element inside Inbox-issue-header file action headers which copies the path to the issues in intake.
  • Created a new variable for path to the intake issue.
  • Created new handle click function which handles the copy to clipboard functionality every time button is clicked.

References

[WEB-2145]

Summary by CodeRabbit

  • New Features
    • Introduced a link to copy the URL of specific inbox issues directly to the clipboard.
    • Added a new menu item in the Custom Menu for easy access to the copy functionality.
    • Integrated a success toast notification to inform users when the link has been copied.

These enhancements improve user interaction and streamline workflows related to inbox issues.

Copy link
Contributor

coderabbitai bot commented Aug 28, 2024

Walkthrough

The changes enhance the InboxIssueActionsHeader component by introducing a link for navigating to specific inbox issues. A new function allows users to copy this link to the clipboard, accompanied by a notification. Additionally, a menu item is added to facilitate the copy action directly from the user interface.

Changes

Files Change Summary
.../inbox/content/inbox-issue-header.tsx Added import for the Copy icon, modified handleCopyIssueLink function to accept a path parameter, and introduced a new menu item in CustomMenu.

Poem

🐰 In the inbox where issues play,
A new link's here to brighten the day!
Just a click, and it’s copied with glee,
Toasts of success, oh what a spree!
Hopping along, our work's now a breeze,
Thanks to these changes, we do it with ease! 🌟


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 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.

@CLAassistant
Copy link

CLAassistant commented Aug 28, 2024

CLA assistant check
All committers have signed the CLA.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3c78292 and 11aeb15.

Files selected for processing (1)
  • web/core/components/inbox/content/inbox-issue-header.tsx (4 hunks)
Additional comments not posted (4)
web/core/components/inbox/content/inbox-issue-header.tsx (4)

16-16: New import added for Copy icon.

The Copy icon from lucide-react library is imported correctly.

The code changes are approved.


97-97: New variable intakeIssueLink created.

The variable intakeIssueLink is correctly constructed to store the path to the intake issue.

The code changes are approved.


171-178: New function handleCopyIntakeIssueLink added.

The function handleCopyIntakeIssueLink is correctly implemented to handle the copy-to-clipboard action and display a success toast notification.

The code changes are approved.


376-381: New menu item added to CustomMenu.

The new menu item is correctly added to trigger the handleCopyIntakeIssueLink function.

The code changes are approved.

@@ -166,6 +168,15 @@ export const InboxIssueActionsHeader: FC<TInboxIssueActionsHeader> = observer((p
})
);

const handleCopyIntakeIssueLink = () =>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we reuse the handleCopyIssueLink function here by passing an argument to specify whether to copy the intake path or the issue path?

@@ -362,6 +373,12 @@ export const InboxIssueActionsHeader: FC<TInboxIssueActionsHeader> = observer((p
</div>
</CustomMenu.MenuItem>
)}
<CustomMenu.MenuItem onClick={handleCopyIntakeIssueLink}>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Update the UX to 'Copy issue link' and position it above the 'Delete' option.

Updated button UX and handleCopyIssue function
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: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 11aeb15 and 16e2d7b.

Files selected for processing (1)
  • web/core/components/inbox/content/inbox-issue-header.tsx (7 hunks)
Additional comments not posted (4)
web/core/components/inbox/content/inbox-issue-header.tsx (4)

16-16: LGTM!

The import statement for the Copy icon is correct and necessary for the new functionality.


97-97: LGTM!

The intakeIssueLink variable is correctly constructed using the provided parameters.


162-163: LGTM!

The handleCopyIssueLink function is correctly implemented and enhances the functionality by making it reusable for different paths.


368-373: LGTM!

The new menu item for copying the intakeIssueLink is correctly implemented and enhances the user interface by providing an additional option to copy the intake issue link.

Comment on lines 171 to 179
// const handleCopyIntakeIssueLink = () =>
// copyUrlToClipboard(intakeIssueLink).then(() =>
// setToast({
// type: TOAST_TYPE.SUCCESS,
// title: "Link copied",
// message: "Issue link copied to clipboard",
// })
// );

Copy link
Contributor

Choose a reason for hiding this comment

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

Remove commented-out code.

The handleCopyIntakeIssueLink function is commented out and should be removed to maintain code cleanliness.

Apply this diff to remove the commented-out code:

-  // const handleCopyIntakeIssueLink = () =>
-  //   copyUrlToClipboard(intakeIssueLink).then(() =>
-  //     setToast({
-  //       type: TOAST_TYPE.SUCCESS,
-  //       title: "Link copied",
-  //       message: "Issue link copied to clipboard",
-  //     })
-  //   );
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
// const handleCopyIntakeIssueLink = () =>
// copyUrlToClipboard(intakeIssueLink).then(() =>
// setToast({
// type: TOAST_TYPE.SUCCESS,
// title: "Link copied",
// message: "Issue link copied to clipboard",
// })
// );

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 16e2d7b and f53306e.

Files selected for processing (1)
  • web/core/components/inbox/content/inbox-issue-header.tsx (7 hunks)
Files skipped from review as they are similar to previous changes (1)
  • web/core/components/inbox/content/inbox-issue-header.tsx

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants