plane icon indicating copy to clipboard operation
plane copied to clipboard

[WEB-2316] chore: Kanban group virtualization

Open rahulramesha opened this issue 1 year ago • 1 comments

This PR adds group wise virtualization to Kanban groups to fix faster reaction times with large number of groups/columns. This is to make sure the user experiences faster perceived performance.

Summary by CodeRabbit

  • New Features

    • Introduced a new optional property useIdletime for improved rendering behavior in the RenderIfVisible component.
    • Enhanced Kanban component with subgroup management through the new subGroupIndex prop.
    • Added a new KanbanColumnLoader component for improved layout rendering in Kanban views.
    • Implemented a function to dynamically calculate the approximate height of Kanban cards.
  • Bug Fixes

    • Adjusted visibility and rendering logic for better performance in the Kanban component.
  • Refactor

    • Updated rendering logic in several components to optimize performance and maintainability.

rahulramesha avatar Sep 09 '24 14:09 rahulramesha

Walkthrough

This pull request introduces several enhancements across multiple components, including the addition of new properties and functionalities to improve rendering logic. Key changes include the introduction of the useIdletime property in the RenderIfVisible component, modifications to the KanBan component to utilize this new feature, and the addition of the getApproximateCardHeight utility function. Furthermore, new loader components have been created to streamline the Kanban layout, enhancing overall performance and flexibility.

Changes

Files Change Summary
web/core/components/core/render-if-visible-HOC.tsx Added useIdletime property to Props type, modifying visibility logic to conditionally use requestIdleCallback. Adjusted className logic for better handling of placeholderChildren.
web/core/components/issues/issue-layouts/kanban/default.tsx Introduced subGroupIndex prop to IKanBan interface. Integrated RenderIfVisible for conditional rendering of KanbanGroup, optimizing performance. Refined height calculation for groups using getApproximateCardHeight. Updated mapping of list to include groupIndex.
web/core/components/issues/issue-layouts/kanban/swimlanes.tsx Modified SubGroupSwimlane component to pass subGroupIndex to child components, enhancing subgroup management.
web/core/components/issues/issue-layouts/utils.tsx Added getApproximateCardHeight function to calculate dynamic height of Kanban cards based on display properties.
web/core/components/ui/loader/layouts/kanban-layout-loader.tsx Updated KanbanIssueBlockLoader to accept cardHeight prop. Introduced KanbanColumnLoader for rendering columns of issue blocks, improving modularity and code structure.

Suggested labels

🌟enhancement

Poem

🐇 In the garden where changes bloom,
A new prop dances, dispelling gloom.
With loaders bright and heights refined,
The Kanban flows, perfectly aligned.
Hooray for updates, let’s celebrate,
In code we trust, our future is great! 🌼

[!TIP]

New features

Walkthrough comment now includes:

  • Possibly related PRs: A list of potentially related PRs to help you recall past context.
  • Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs. You can also provide custom labeling instructions in the UI or configuration file.

Notes:

  • Please share any feedback in the discussion post on our Discord.
  • Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

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.

coderabbitai[bot] avatar Sep 09 '24 14:09 coderabbitai[bot]