JNG-5983 tag navigation #477
Conversation
noherczeg
commented
Oct 28, 2024
•
noherczeg
commented
 JNG-5983 Navigation doesn't work on Tag Components on View Page
|
noherczeg
requested review from
robertcsakany,
bencegelei,
gaborflorian and
Madmat8
WalkthroughThe changes in the pull request focus on the Changes
Poem
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
🧹 Outside diff range and nitpick comments (1)
judo-ui-react/src/main/resources/actor/src/components/widgets/Tags.tsx.hbs (1)
216-216: Consider using CSS classes for cursor styling.The current approach mixes styling concerns with component logic. Consider using CSS classes for better separation of concerns and maintainability.
Here's a suggested improvement:
-sx={ { cursor: (typeof onItemClick === 'function' && !editMode) ? 'pointer' : undefined } } +className={clsx({ + 'clickable-tag': typeof onItemClick === 'function' && !editMode, +})}Add this CSS class to your stylesheet:
.clickable-tag { cursor: pointer; }
| return <Chip | ||
| key={key} | ||
| label={option[autoCompleteAttribute]} | ||
| {...rest} | ||
| sx={ { cursor: (typeof onItemClick === 'function' && !editMode) ? 'pointer' : undefined } } | ||
| onClick={onChipClicked} | ||
| />; |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consider using data attributes for more reliable click handling.
The current implementation relies on textContent to find the clicked tag, which could be fragile if the label text is not unique. Consider using data attributes for more reliable click handling.
Here's a suggested improvement:
return <Chip
key={key}
label={option[autoCompleteAttribute]}
{...rest}
sx={ { cursor: (typeof onItemClick === 'function' && !editMode) ? 'pointer' : undefined } }
- onClick={onChipClicked}
+ data-tag-id={option[identifierAttribute]}
+ onClick={(event) => {
+ if (onItemClick && !editMode) {
+ const tagId = (event.currentTarget as HTMLElement).dataset.tagId;
+ const data = values.find((c: any) => c[identifierAttribute] === tagId);
+ if (data) {
+ onItemClick(data);
+ }
+ }
+ }}
/>;This approach:
- Uses data attributes to store the tag identifier
- Moves the click logic inline for better type safety
- Removes the need for textContent matching
Committable suggestion was skipped due to low confidence.
🛠️ Refactor suggestion
Enhance accessibility for clickable tags.
When tags are clickable (onItemClick present and not in edit mode), they should be properly marked as interactive elements for accessibility.
Add these accessibility attributes:
return <Chip
key={key}
label={option[autoCompleteAttribute]}
{...rest}
sx={ { cursor: (typeof onItemClick === 'function' && !editMode) ? 'pointer' : undefined } }
onClick={onChipClicked}
+ role={onItemClick && !editMode ? "button" : undefined}
+ tabIndex={onItemClick && !editMode ? 0 : undefined}
+ onKeyDown={(e) => {
+ if (onItemClick && !editMode && (e.key === 'Enter' || e.key === ' ')) {
+ e.preventDefault();
+ onChipClicked(e as any);
+ }
+ }}
/>;This enhancement:
- Adds proper role for screen readers
- Enables keyboard navigation
- Handles keyboard events (Enter/Space) for activation
📝 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 <Chip | |
| key={key} | |
| label={option[autoCompleteAttribute]} | |
| {...rest} | |
| sx={ { cursor: (typeof onItemClick === 'function' && !editMode) ? 'pointer' : undefined } } | |
| onClick={onChipClicked} | |
| />; | |
| return <Chip | |
| key={key} | |
| label={option[autoCompleteAttribute]} | |
| {...rest} | |
| sx={ { cursor: (typeof onItemClick === 'function' && !editMode) ? 'pointer' : undefined } } | |
| onClick={onChipClicked} | |
| role={onItemClick && !editMode ? "button" : undefined} | |
| tabIndex={onItemClick && !editMode ? 0 : undefined} | |
| onKeyDown={(e) => { | |
| if (onItemClick && !editMode && (e.key === 'Enter' || e.key === ' ')) { | |
| e.preventDefault(); | |
| onChipClicked(e as any); | |
| } | |
| }} | |
| />; |
