[WEB-2221] fix: app sidebar and favorites improvement by anmolsinghbhatia · Pull Request #5357 · makeplane/plane

anmolsinghbhatia · 2024-08-12T13:47:38Z

Changes:

This PR includes the following updates to the app sidebar:

Fixed the behavior of the project collapsible toggle.
Implemented scroll-into-view functionality for favorite item redirections.
Resolved issues with redirections for favorite project items.

Reference:

[WEB-2221]

Summary by CodeRabbit

New Features
- Enhanced the interactivity of favorite items by introducing project-specific click handling.
- Improved URL generation logic for favorite items, ensuring correct links for "issues."
- Added project context to favorite items for better user experience.
- Upgraded the favorite item details retrieval method for dynamic access to project information.
Bug Fixes
- Improved the responsiveness of the project list in the sidebar, ensuring it closes when the URL does not match the selected project.

coderabbitai · 2024-08-12T13:47:46Z

Walkthrough

The recent updates enhance the interactivity and functionality of components related to favorites and projects. Key improvements include the addition of a projectId property that allows for project-specific logic in the favorites sidebar. This enables components to respond more effectively to user actions and URL changes, improving overall user experience and accessibility.

Changes

Files	Change Summary
`.../favorites/favorite-items/common/favorite-item-title.tsx`, `.../favorites/favorite-items/root.tsx`	Added `projectId` to `Props` type; updated logic for handling clicks and rendering context in favorites.
`.../favorites/favorite-items/common/helper.tsx`	Modified `generateFavoriteItemLink` to conditionally include `entity_identifier` based on `entityPath`.
`.../projects-list-item.tsx`	Updated `SidebarProjectsListItem` to manage project list visibility based on URL changes and added `id`.
`.../hooks/use-favorite-item-details.tsx`	Changed how project details are retrieved using a function-based approach tied to `favorite.project_id`.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant FavoriteItemTitle
    participant Helper
    participant DOM

    User->>FavoriteItemTitle: Click on favorite item
    FavoriteItemTitle->>Helper: Call handleOnClick with projectId
    Helper->>DOM: Scroll to element with projectId
    DOM-->>User: Element scrolled into view

🐇 In the field where favorites bloom,
A rabbit hops to chase away gloom.
With project paths now clear and bright,
Clicks will lead to greater delight!
So dance in joy, let the changes unfold,
For stories of projects await to be told! 🥕✨

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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

coderabbitai

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 4792c1c and 19d2c7f.

Files selected for processing (4)

web/core/components/workspace/sidebar/favorites/favorite-items/common/favorite-item-title.tsx (1 hunks)
web/core/components/workspace/sidebar/favorites/favorite-items/common/helper.tsx (1 hunks)
web/core/components/workspace/sidebar/favorites/favorite-items/root.tsx (1 hunks)
web/core/components/workspace/sidebar/projects-list-item.tsx (2 hunks)

Additional comments not posted (4)

web/core/components/workspace/sidebar/favorites/favorite-items/common/helper.tsx (1)

47-47: LGTM! The URL generation logic is flexible and correct.

The conditional check for the entityPath ensures that issue links are generated without an entity_identifier, which is a good improvement.

web/core/components/workspace/sidebar/favorites/favorite-items/root.tsx (1)

93-99: LGTM! The addition of projectId enhances functionality.

The projectId prop allows FavoriteItemTitle to handle project-specific logic, aligning with the PR's objectives.

web/core/components/workspace/sidebar/projects-list-item.tsx (2)

270-273: LGTM! Improved URL responsiveness.

The updated useEffect hook correctly manages the isProjectListOpen state based on the URL, enhancing the component's responsiveness to URL changes.

295-295: LGTM! Enhanced element identification.

The addition of an id attribute with project.id improves the ability to identify and manipulate the element in the DOM.

coderabbitai · 2024-08-12T13:51:02Z

web/core/components/workspace/sidebar/favorites/favorite-items/common/favorite-item-title.tsx

+  const handleOnClick = () => {
+    if (projectId) {
+      const projectItem = document.getElementById(`${projectId}`);
+      projectItem?.scrollIntoView({ behavior: "smooth" });
+    }
+  };


Consider using React refs or state management instead of document.getElementById.

The use of document.getElementById is generally discouraged in React as it bypasses the React virtual DOM. Consider using React refs or state management to handle DOM interactions for better integration with React's lifecycle.

coderabbitai

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 19d2c7f and 03b7ef6.

Files selected for processing (1)

web/core/hooks/use-favorite-item-details.tsx (2 hunks)

Additional comments not posted (2)

web/core/hooks/use-favorite-item-details.tsx (2)

16-16: Good use of dynamic project fetching.

The change from currentProjectDetails to getProjectById allows for more dynamic and flexible retrieval of project details.

26-27: Dynamic project details retrieval implemented.

Assigning currentProjectDetails using getProjectById(favorite.project_id ?? "") ensures that project details are dynamically fetched based on the favorite item's project ID.

anmolsinghbhatia added 3 commits August 12, 2024 19:00

fix: project collapsible toggle

9e0bd99

fix: project favorite redirection

1fbbfc7

chore: favorite redirection scroll into view implementation

19d2c7f

anmolsinghbhatia added 🐛bug Something isn't working 🌐frontend 🌟improvement 🧹chore labels Aug 12, 2024

anmolsinghbhatia added this to the v0.23-dev milestone Aug 12, 2024

anmolsinghbhatia requested review from SatishGandham and sriramveeraghanta August 12, 2024 13:47

anmolsinghbhatia self-assigned this Aug 12, 2024

coderabbitai bot reviewed Aug 12, 2024

View reviewed changes

fix: use favorite item details project details

03b7ef6

coderabbitai bot reviewed Aug 13, 2024

View reviewed changes

SatishGandham approved these changes Aug 14, 2024

View reviewed changes

SatishGandham merged commit d9c9d85 into preview Aug 14, 2024

SatishGandham deleted the fix-app-sidebar-and-favorites-improvement branch August 14, 2024 07:23

coderabbitai bot mentioned this pull request Oct 5, 2024

[WEB-2597] fix: handle favorite entity data causing application error #5756

Merged

coderabbitai bot mentioned this pull request Nov 6, 2024

[WEB-2738] chore: app sidebar behaviour #5964

Merged

coderabbitai bot mentioned this pull request Dec 8, 2024

[WEB-2818] chore: project navigation items code refactor #6170

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WEB-2221] fix: app sidebar and favorites improvement#5357

[WEB-2221] fix: app sidebar and favorites improvement#5357
SatishGandham merged 4 commits intopreviewfrom
fix-app-sidebar-and-favorites-improvement

anmolsinghbhatia commented Aug 12, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Aug 12, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

coderabbitai bot Aug 12, 2024

Uh oh!

coderabbitai bot left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

anmolsinghbhatia commented Aug 12, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes:

Reference:

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Aug 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Aug 12, 2024

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

anmolsinghbhatia commented Aug 12, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Aug 12, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)