[WEB-2316] chore: fix animation performance on kanban group virtualization

[rahulramesha]

This PR removes the pulse animation from kanban group virtualization loaders

Summary by CodeRabbit

• New Features

  • Introduced a shouldAnimate prop to the Kanban component, allowing users to disable animations for card rendering.
  • Added optional shouldAnimate prop to loading indicators in Kanban layouts, with default animations enabled.

• Bug Fixes

  • Enhanced consistency in animation behavior across loading components.

[coderabbitai]

Walkthrough

The changes introduce a new optional property, shouldAnimate, to the KanBan component and related loading components in the Kanban layout. This prop allows for conditional animation of card rendering and loading indicators. The default value for shouldAnimate is set to false in the KanBan component and true in the loading components, affecting how animations are applied based on the number of cards displayed.

Changes

File Path	Change Summary
web/core/components/issues/issue-layouts/kanban/default.tsx	Added shouldAnimate prop to KanBan component, defaulting to false for disabling animations.
web/core/components/ui/loader/layouts/kanban-layout-loader.tsx	Introduced shouldAnimate prop to KanbanIssueBlockLoader and KanbanColumnLoader, defaulting to true. Updated class names to conditionally apply animations.

Possibly related PRs

• [WEB-2316] chore: Kanban group virtualization #5565: The changes in the KanBan component and the KanbanIssueBlockLoader both involve the shouldAnimate prop, indicating a direct relationship in animation handling.
• [WEB-2316] fix: Style Calculation performance issue in virtualization #5647: This PR addresses performance issues related to the RenderIfVisible component, which is utilized in the KanBan component, suggesting a connection in optimizing rendering behavior.
• [WEB-2316] chore: Change kanban group virtualization logic #5664: Modifications to the RenderIfVisible logic in this PR relate directly to the rendering logic of the KanBan component, enhancing visibility and rendering management.

Suggested labels

🎨UI / UX, ✍️editor

🐇 In the Kanban land where cards do play,
A new prop named shouldAnimate leads the way.
With animations on or off, it’s a choice,
In the dance of the cards, let your preferences voice.
Loading blocks now pulse with a gentle grace,
Hopping along, keeping up with the pace! 🐇✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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 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]

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

web/core/components/ui/loader/layouts/kanban-layout-loader.tsx (1)

Line range hint 43-50: Consider updating KanbanLayoutLoader for consistency.

The KanbanLayoutLoader component, which uses KanbanColumnLoader, is not updated to pass the shouldAnimate prop. This could lead to inconsistent animation behavior if KanbanLayoutLoader is used.

To ensure consistent animation behavior, consider updating KanbanLayoutLoader to accept and pass the shouldAnimate prop to KanbanColumnLoader:

-export const KanbanLayoutLoader = ({ cardsInEachColumn = [2, 3, 2, 4, 3] }: { cardsInEachColumn?: number[] }) => (
+export const KanbanLayoutLoader = ({
+  cardsInEachColumn = [2, 3, 2, 4, 3],
+  shouldAnimate = true,
+}: {
+  cardsInEachColumn?: number[];
+  shouldAnimate?: boolean;
+}) => (
  <ContentWrapper className="flex-row gap-5 py-1.5 overflow-x-auto">
    {cardsInEachColumn.map((cardsInColumn, columnIndex) => (
-      <KanbanColumnLoader key={columnIndex} cardsInColumn={cardsInColumn} />
+      <KanbanColumnLoader key={columnIndex} cardsInColumn={cardsInColumn} shouldAnimate={shouldAnimate} />
    ))}
  </ContentWrapper>
);

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 66cfc73 and 27d1db9.

Files selected for processing (2)

• web/core/components/issues/issue-layouts/kanban/default.tsx (1 hunks)
• web/core/components/ui/loader/layouts/kanban-layout-loader.tsx (2 hunks)

Additional comments not posted (3)

web/core/components/ui/loader/layouts/kanban-layout-loader.tsx (2)

Line range hint 5-13: LGTM!

The changes to the KanbanIssueBlockLoader component look good:

• The new optional prop shouldAnimate is added to control the pulse animation.
• The cn function is correctly used to conditionally apply the animate-pulse class based on shouldAnimate.
• The changes align with the PR objective to remove the pulse animation for performance improvement.

The component logic is correct, and the implementation is accurate.

---

Line range hint 15-39: LGTM!

The changes to the KanbanColumnLoader component look good:

• The new optional prop shouldAnimate is added to control the pulse animation.
• The cn function is correctly used to conditionally apply the animate-pulse class based on shouldAnimate for the header elements.
• The shouldAnimate prop is correctly passed down to the KanbanIssueBlockLoader instances to ensure consistent animation behavior.
• The changes align with the PR objective to remove the pulse animation for performance improvement.

The component logic is correct, and the implementation is accurate.

web/core/components/issues/issue-layouts/kanban/default.tsx (1)

196-196: LGTM!

Disabling the animation in the KanbanColumnLoader component by setting the shouldAnimate prop to false is a good change that aligns with the PR objective of improving the performance of the kanban group virtualization feature by removing the potentially resource-intensive pulse animation from the loaders.

The change is unlikely to have any negative impact on the functionality or user experience, and can potentially improve the performance of the feature.