[WEB-2601] improvement: add click to copy issue identifier on peek-overview and issue detail page. #5760
Conversation
…erview and issue detail page.
WalkthroughThe changes in this pull request focus on enhancing the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
- web/ce/components/issues/issue-details/issue-identifier.tsx (4 hunks)
- web/ce/components/issues/issue-details/issue-type-switcher.tsx (1 hunks)
🧰 Additional context used
🔇 Additional comments (7)
web/ce/components/issues/issue-details/issue-type-switcher.tsx (1)
23-23: LGTM! Verify IssueIdentifier implementation.The addition of the
enableClickToCopyIdentifierprop to theIssueIdentifiercomponent aligns with the PR objective of adding a click-to-copy feature for the issue identifier. The implementation looks correct and maintains the existing functionality of the component.To ensure the new prop is properly handled, please verify the implementation of the
IssueIdentifiercomponent. Run the following script to check its implementation:web/ce/components/issues/issue-details/issue-identifier.tsx (6)
4-4: Modules are correctly importedThe imports
setToast,TOAST_TYPE, andTooltipare appropriately added and used within the code.
16-16: New optional prop added consistentlyThe addition of the optional prop
enableClickToCopyIdentifiertoTIssueIdentifierBasePropsmaintains consistency with the existing props structure.
29-29: ExportingTIssueIdentifierPropsfor external useBy exporting
TIssueIdentifierProps, you allow other modules to utilize this type, enhancing reusability.
31-35: Definition ofTIdentifierTextPropsis clear and conciseThe new type
TIdentifierTextPropsis well-defined and follows naming conventions.
70-70: Default prop value assignment is appropriateSetting a default value for
enableClickToCopyIdentifierduring destructuring ensures that the component behaves correctly even if the prop is undefined.
88-92:IdentifierTextcomponent integrated correctlyThe
IdentifierTextcomponent is properly utilized with the correct props, promoting code reusability and cleanliness.
| return ( | ||
| <Tooltip tooltipContent="Click to copy" disabled={!enableClickToCopyIdentifier} position="top"> | ||
| <span | ||
| className={cn( | ||
| "text-base font-medium text-custom-text-300", | ||
| { | ||
| "cursor-pointer": enableClickToCopyIdentifier, | ||
| }, | ||
| textContainerClassName | ||
| )} | ||
| onClick={handleCopyIssueIdentifier} | ||
| > | ||
| {identifier} | ||
| </span> | ||
| </Tooltip> | ||
| ); | ||
| }; |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Enhance accessibility for interactive elements
The <span> element is being used as an interactive element due to the onClick handler. For better accessibility, it should be focusable and operable via keyboard.
Consider adding role="button" and tabIndex={0} to make the element accessible:
<span
className={cn(
"text-base font-medium text-custom-text-300",
{
"cursor-pointer": enableClickToCopyIdentifier,
},
textContainerClassName
)}
+ role={enableClickToCopyIdentifier ? "button" : undefined}
+ tabIndex={enableClickToCopyIdentifier ? 0 : undefined}
onClick={handleCopyIssueIdentifier}
+ onKeyPress={(e) => {
+ if (enableClickToCopyIdentifier && (e.key === 'Enter' || e.key === ' ')) {
+ handleCopyIssueIdentifier();
+ }
+ }}
>This change ensures users who navigate via keyboard can interact with the element.
📝 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.
| return ( | |
| <Tooltip tooltipContent="Click to copy" disabled={!enableClickToCopyIdentifier} position="top"> | |
| <span | |
| className={cn( | |
| "text-base font-medium text-custom-text-300", | |
| { | |
| "cursor-pointer": enableClickToCopyIdentifier, | |
| }, | |
| textContainerClassName | |
| )} | |
| onClick={handleCopyIssueIdentifier} | |
| > | |
| {identifier} | |
| </span> | |
| </Tooltip> | |
| ); | |
| }; | |
| return ( | |
| <Tooltip tooltipContent="Click to copy" disabled={!enableClickToCopyIdentifier} position="top"> | |
| <span | |
| className={cn( | |
| "text-base font-medium text-custom-text-300", | |
| { | |
| "cursor-pointer": enableClickToCopyIdentifier, | |
| }, | |
| textContainerClassName | |
| )} | |
| role={enableClickToCopyIdentifier ? "button" : undefined} | |
| tabIndex={enableClickToCopyIdentifier ? 0 : undefined} | |
| onClick={handleCopyIssueIdentifier} | |
| onKeyPress={(e) => { | |
| if (enableClickToCopyIdentifier && (e.key === 'Enter' || e.key === ' ')) { | |
| handleCopyIssueIdentifier(); | |
| } | |
| }} | |
| > | |
| {identifier} | |
| </span> | |
| </Tooltip> | |
| ); | |
| }; |
| export const IdentifierText: React.FC<TIdentifierTextProps> = (props) => { | ||
| const { identifier, enableClickToCopyIdentifier = false, textContainerClassName } = props; | ||
| // handlers | ||
| const handleCopyIssueIdentifier = () => { | ||
| if (enableClickToCopyIdentifier) { | ||
| navigator.clipboard.writeText(identifier).then(() => { | ||
| setToast({ | ||
| type: TOAST_TYPE.SUCCESS, | ||
| title: "Issue ID copied to clipboard", | ||
| }); | ||
| }); | ||
| } | ||
| }; | ||
|
|
||
| return ( | ||
| <Tooltip tooltipContent="Click to copy" disabled={!enableClickToCopyIdentifier} position="top"> | ||
| <span | ||
| className={cn( | ||
| "text-base font-medium text-custom-text-300", | ||
| { | ||
| "cursor-pointer": enableClickToCopyIdentifier, | ||
| }, | ||
| textContainerClassName | ||
| )} | ||
| onClick={handleCopyIssueIdentifier} | ||
| > | ||
| {identifier} | ||
| </span> | ||
| </Tooltip> | ||
| ); | ||
| }; |
There was a problem hiding this comment.
Add error handling for clipboard operations
The navigator.clipboard.writeText method may fail due to browser permissions or security settings, which could leave the user unaware of the failure.
Consider adding error handling to inform the user if copying to the clipboard fails.
Apply this diff to include error handling:
const handleCopyIssueIdentifier = () => {
if (enableClickToCopyIdentifier) {
- navigator.clipboard.writeText(identifier).then(() => {
+ navigator.clipboard.writeText(identifier)
+ .then(() => {
setToast({
type: TOAST_TYPE.SUCCESS,
title: "Issue ID copied to clipboard",
});
- });
+ })
+ .catch(() => {
+ setToast({
+ type: TOAST_TYPE.ERROR,
+ title: "Failed to copy Issue ID",
+ });
+ });
}
};📝 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.
| export const IdentifierText: React.FC<TIdentifierTextProps> = (props) => { | |
| const { identifier, enableClickToCopyIdentifier = false, textContainerClassName } = props; | |
| // handlers | |
| const handleCopyIssueIdentifier = () => { | |
| if (enableClickToCopyIdentifier) { | |
| navigator.clipboard.writeText(identifier).then(() => { | |
| setToast({ | |
| type: TOAST_TYPE.SUCCESS, | |
| title: "Issue ID copied to clipboard", | |
| }); | |
| }); | |
| } | |
| }; | |
| return ( | |
| <Tooltip tooltipContent="Click to copy" disabled={!enableClickToCopyIdentifier} position="top"> | |
| <span | |
| className={cn( | |
| "text-base font-medium text-custom-text-300", | |
| { | |
| "cursor-pointer": enableClickToCopyIdentifier, | |
| }, | |
| textContainerClassName | |
| )} | |
| onClick={handleCopyIssueIdentifier} | |
| > | |
| {identifier} | |
| </span> | |
| </Tooltip> | |
| ); | |
| }; | |
| export const IdentifierText: React.FC<TIdentifierTextProps> = (props) => { | |
| const { identifier, enableClickToCopyIdentifier = false, textContainerClassName } = props; | |
| // handlers | |
| const handleCopyIssueIdentifier = () => { | |
| if (enableClickToCopyIdentifier) { | |
| navigator.clipboard.writeText(identifier) | |
| .then(() => { | |
| setToast({ | |
| type: TOAST_TYPE.SUCCESS, | |
| title: "Issue ID copied to clipboard", | |
| }); | |
| }) | |
| .catch(() => { | |
| setToast({ | |
| type: TOAST_TYPE.ERROR, | |
| title: "Failed to copy Issue ID", | |
| }); | |
| }); | |
| } | |
| }; | |
| return ( | |
| <Tooltip tooltipContent="Click to copy" disabled={!enableClickToCopyIdentifier} position="top"> | |
| <span | |
| className={cn( | |
| "text-base font-medium text-custom-text-300", | |
| { | |
| "cursor-pointer": enableClickToCopyIdentifier, | |
| }, | |
| textContainerClassName | |
| )} | |
| onClick={handleCopyIssueIdentifier} | |
| > | |
| {identifier} | |
| </span> | |
| </Tooltip> | |
| ); | |
| }; |
| type: TOAST_TYPE.SUCCESS, | ||
| title: "Issue ID copied to clipboard", | ||
| }); | ||
| }); |
There was a problem hiding this comment.
can you please handle the error scenario with catch?
…erview and issue detail page. (#5760)
Screen.Recording.2024-10-07.at.4.21.43.PM.mov
Summary by CodeRabbit
IdentifierTextcomponent to manage the display and copying of issue identifiers.IssueIdentifiercomponent for better structure and functionality.