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

fix: Updating the click functionalities in list item component #38453

Merged
merged 1 commit into from
Jan 2, 2025

Conversation

ankitakinger
Copy link
Contributor

@ankitakinger ankitakinger commented Jan 2, 2025

Description

Updating the click functionalities in list item component to fix the partial clickable issue on JS module instance editor in EE.

Fixes #38444

Automation

/ok-to-test tags="@tag.Sanity, @tag.Datasource, @tag.IDE"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/12582242512
Commit: a936b58
Cypress dashboard.
Tags: @tag.Sanity, @tag.Datasource, @tag.IDE
Spec:


Thu, 02 Jan 2025 14:17:45 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

  • Yes
  • No

Summary by CodeRabbit

  • Refactor

    • Removed description and descriptionType properties from various List component items across multiple components
    • Simplified keyboard interaction model in List component by removing keyboard event handling
    • Modified click event handling in ListItem to focus on mouse interactions
  • Bug Fixes

    • Prevented event propagation for right control clicks in ListItem

@ankitakinger ankitakinger requested a review from hetunandu January 2, 2025 12:12
Copy link
Contributor

coderabbitai bot commented Jan 2, 2025

Walkthrough

The pull request introduces modifications to several components across the design system and application, primarily focusing on simplifying event handling in the List component. The changes remove description and descriptionType properties from list items in multiple files and adjust the keyboard and mouse interaction model for list items. These modifications aim to streamline the UI component interactions and address potential usability issues in the list rendering.

Changes

File Change Summary
design-system/ads/src/List/List.tsx Removed listItemhandleKeyDown function, added handleRightControlClick, simplified event handling
src/pages/Editor/CustomWidgetBuilder/Preview/Debugger/helpDropdown.tsx Removed description and descriptionType from list items
src/pages/Editor/IDE/EditorPane/components/Group.tsx Removed description and descriptionType from "Load more..." item
design-system/ads/src/Templates/IDEHeader/IDEHeader.stories.tsx Removed description and descriptionType from list items

Assessment against linked issues

Objective Addressed Explanation
Fix unclickable function names in module instance editor [#38444]

Possibly related PRs

Suggested labels

Bug, IDE Product, Task, IDE Pod, ok-to-test

Suggested reviewers

  • albinAppsmith
  • hetunandu

Poem

In the realm of code, where lists unfold,
Interactions dance, both new and old
Keyboard clicks fade, mouse takes the stage
Simplicity writes its elegant page 🖱️✨


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.

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.

@ankitakinger ankitakinger added the ok-to-test Required label for CI label Jan 2, 2025
@github-actions github-actions bot added Bug Something isn't working IDE Navigation Issues/feature requests related to IDE navigation, and context switching IDE Pod Issues that new developers face while exploring the IDE IDE Product Issues related to the IDE Product Needs Triaging Needs attention from maintainers to triage Regressed Scenarios that were working before but have now regressed Release Release Blocker This issue must be resolved before the release labels Jan 2, 2025
@ankitakinger
Copy link
Contributor Author

/build-deploy-preview skip-tests=true

Copy link

github-actions bot commented Jan 2, 2025

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/12582233225.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 38453.
recreate: .

@hetunandu hetunandu added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels Jan 2, 2025
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 (3)
app/client/packages/design-system/ads/src/List/List.tsx (3)

100-102: Consider both stopPropagation and preventDefault for clarity.

Stopping the event propagation alone ensures that the parent onClick handler does not fire, but if there's any default browser action (e.g., link or button) intended on this control, it might be worth also preventing the default event if needed.


111-111: Revisit keyboard accessibility fallback.

By focusing solely on onClick, there's a risk of excluding keyboard-only users who may rely on the “Enter” or “Space” keys. Consider either restoring a keydown handler or adopting a suitable ARIA role for better accessibility.


152-154: Ensure consistent naming or doc clarity.

handleRightControlClick accurately describes the event, but adding a quick comment or docstring explaining why the event is stopped helps new collaborators grasp the interaction logic more quickly.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9c81647 and a936b58.

📒 Files selected for processing (4)
  • app/client/packages/design-system/ads/src/List/List.tsx (2 hunks)
  • app/client/packages/design-system/ads/src/Templates/IDEHeader/IDEHeader.stories.tsx (0 hunks)
  • app/client/src/pages/Editor/CustomWidgetBuilder/Preview/Debugger/helpDropdown.tsx (0 hunks)
  • app/client/src/pages/Editor/IDE/EditorPane/components/Group.tsx (0 hunks)
💤 Files with no reviewable changes (3)
  • app/client/packages/design-system/ads/src/Templates/IDEHeader/IDEHeader.stories.tsx
  • app/client/src/pages/Editor/CustomWidgetBuilder/Preview/Debugger/helpDropdown.tsx
  • app/client/src/pages/Editor/IDE/EditorPane/components/Group.tsx

Copy link

github-actions bot commented Jan 2, 2025

Deploy-Preview-URL: https://ce-38453.dp.appsmith.com

@ankitakinger ankitakinger merged commit 99a10e4 into release Jan 2, 2025
62 of 63 checks passed
@ankitakinger ankitakinger deleted the fix/list-item-click branch January 2, 2025 14:34
ankitakinger added a commit that referenced this pull request Jan 3, 2025
## Description

Updating the click functionalities in list item component to fix the
partial clickable issue on JS module instance editor in EE.

Fixes [#38444](#38444)

## Automation

/ok-to-test tags="@tag.Sanity, @tag.Datasource, @tag.IDE"

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/12582242512>
> Commit: a936b58
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=12582242512&attempt=2"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.Sanity, @tag.Datasource, @tag.IDE`
> Spec:
> <hr>Thu, 02 Jan 2025 14:17:45 UTC
<!-- end of auto-generated comment: Cypress test results  -->


## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [ ] No


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Refactor**
- Removed `description` and `descriptionType` properties from various
`List` component items across multiple components
- Simplified keyboard interaction model in `List` component by removing
keyboard event handling
- Modified click event handling in `ListItem` to focus on mouse
interactions

- **Bug Fixes**
	- Prevented event propagation for right control clicks in `ListItem`

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
nidhi-nair added a commit that referenced this pull request Jan 3, 2025
fix: Updating the click functionalities in list item component (#38453)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working IDE Navigation Issues/feature requests related to IDE navigation, and context switching IDE Pod Issues that new developers face while exploring the IDE IDE Product Issues related to the IDE Product Needs Triaging Needs attention from maintainers to triage ok-to-test Required label for CI Regressed Scenarios that were working before but have now regressed Release Blocker This issue must be resolved before the release Release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: UI of Function names list items in the module instance editor seems broken and partially unclickable
2 participants