Skip to content

[WEB-3699]fix: create link modal text flicker#6860

Merged
sriramveeraghanta merged 1 commit intopreviewfrom
fix-link-modal-flicker
Apr 2, 2025
Merged

[WEB-3699]fix: create link modal text flicker#6860
sriramveeraghanta merged 1 commit intopreviewfrom
fix-link-modal-flicker

Conversation

@vamsikrishnamathala
Copy link
Member

@vamsikrishnamathala vamsikrishnamathala commented Apr 2, 2025

Description

This update fixes the text flicker issue in modal title and submit button.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Improvement (change that would cause existing functionality to not work as expected)
  • Code refactoring
  • Performance improvements
  • Documentation update

Screenshots and Media (if applicable)

Test Scenarios

References

WEB-3699

Summary by CodeRabbit

  • New Features

    • Introduced a dedicated mechanism to open the link creation modal, ensuring a more consistent and smooth activation.
  • Refactor

    • Streamlined the link creation/update modal by removing unnecessary state management, resulting in a cleaner and more intuitive interface.

@vamsikrishnamathala vamsikrishnamathala added the 🐛bug Something isn't working label Apr 2, 2025
@vamsikrishnamathala vamsikrishnamathala self-assigned this Apr 2, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 2, 2025

Walkthrough

The changes remove the setLinkData property and its usage from the modal component’s type definition and implementation. The modal no longer manages link state externally on close. Instead, a new callback function handleCreateLinkModal is introduced in the dashboard component to open the modal and reset link data. The modifications simplify the component interface and event handling by eliminating references to the removed property.

Changes

File Summary
web/core/components/home/.../create-update-link-modal.tsx Removed the setLinkData property and its usage from the modal’s type definition and the onClose function, simplifying state management.
web/core/components/home/.../root.tsx Introduced the handleCreateLinkModal callback using useCallback to encapsulate modal opening logic and removed the setLinkData prop from the modal component usage.

Sequence Diagram(s)

sequenceDiagram
  participant User
  participant Dashboard as DashboardQuickLinks
  participant Modal as LinkCreateUpdateModal

  User->>Dashboard: Click "Create Link" button
  Dashboard->>Dashboard: Invoke handleCreateLinkModal()
  Dashboard->>Modal: Call toggleLinkModal(true)
  Modal->>User: Display modal without external state update
Loading

Possibly related PRs

Suggested labels

🌐frontend

Suggested reviewers

  • sriramveeraghanta

Poem

I'm a rabbit with a knack for clean code,
Hopping through files on this efficient road.
No more setLinkData to complicate the day,
A crisp callback now leads the way.
In lines of change, our logic sings—
CodeRabbit cheers with joyful hops and rings! 🐰✨

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

@makeplane
Copy link

makeplane bot commented Apr 2, 2025

Pull Request Linked with Plane Work Items

Comment Automatically Generated by Plane

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 (1)
web/core/components/home/widgets/links/root.tsx (1)

20-23: New memoized handler addresses text flicker issue

The new handleCreateLinkModal function using useCallback combines both opening the modal and resetting link data in one memoized function. This helps prevent unnecessary re-renders that likely caused the text flicker.

However, the dependency array is empty, which could lead to stale closures if toggleLinkModal or setLinkData change.

- const handleCreateLinkModal = useCallback(() => {
-   toggleLinkModal(true);
-   setLinkData(undefined);
- }, []);
+ const handleCreateLinkModal = useCallback(() => {
+   toggleLinkModal(true);
+   setLinkData(undefined);
+ }, [toggleLinkModal, setLinkData]);
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a57c37c and 5401f10.

📒 Files selected for processing (2)
  • web/core/components/home/widgets/links/create-update-link-modal.tsx (1 hunks)
  • web/core/components/home/widgets/links/root.tsx (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Analyze (javascript)
  • GitHub Check: Analyze (python)
🔇 Additional comments (6)
web/core/components/home/widgets/links/create-update-link-modal.tsx (3)

19-24: Type definition has been simplified, improving component encapsulation

The removal of setLinkData property from the TLinkCreateEditModal type definition is a good improvement. It simplifies the component's interface and removes the external state management responsibility from the modal component.


33-33: Prop destructuring updated to match type definition

The destructured props now correctly reflect the updated type definition, removing the setLinkData prop.


45-47: Modal close handler has been simplified

The onClose function has been simplified to only handle closing the modal, removing the external state management responsibility. This is a cleaner approach and likely helps prevent the text flicker issue by eliminating unnecessary re-renders.

web/core/components/home/widgets/links/root.tsx (3)

1-1: Added useCallback import for performance optimization

Good addition of the useCallback hook to optimize the modal open handler function.


46-46: Improved onClick handler with memoized function

Using the memoized handleCreateLinkModal function instead of an inline function helps prevent unnecessary re-renders and fixes the text flicker issue in the modal title and submit button.


36-41: Modal props updated to match revised component interface

The LinkCreateUpdateModal component no longer receives the setLinkData prop, which aligns with the changes in the component definition. This is a more predictable approach to state management and helps address the flicker issue.

@sriramveeraghanta sriramveeraghanta merged commit adee686 into preview Apr 2, 2025
5 of 6 checks passed
@sriramveeraghanta sriramveeraghanta deleted the fix-link-modal-flicker branch April 2, 2025 17:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🐛bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants