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

434 create a custom component for popup dialogs #464

Merged
merged 6 commits into from
Jan 4, 2025

Conversation

MandeepPaul
Copy link

Describe your changes

  • Transformed the PopUpMessages component into a dynamic, reusable wrapper.
  • Refactored ConfirmationPopup, LinkDialog, and DeleteConfirmationModal components to use the PopUpMessages wrapper.
  • Removed redundant styles.

Issue number

#434

Please ensure all items are checked off before requesting a review:

  • I deployed the code locally.
  • I have performed a self-review of my code.
  • I have included the issue # in the PR.
  • I have labelled the PR correctly.
  • The issue I am working on is assigned to me.
  • I didn't use any hardcoded values (otherwise it will not scale, and will make it difficult to maintain consistency across the application).
  • I made sure font sizes, color choices etc are all referenced from the theme.
  • My PR is granular and targeted to one specific feature.
  • I took a screenshot or a video and attached to this PR if there is a UI change.

Preview

ConfirmationPopup

image

LinkDialog

image

DeleteConfirmationModal

image

Copy link
Contributor

coderabbitai bot commented Jan 4, 2025

Walkthrough

The pull request introduces a comprehensive refactoring of popup and modal components across the frontend, centralizing dialog functionality into a new PopUpMessages component. The changes involve replacing various Material-UI dialog implementations with a more flexible, configurable popup system that standardizes interaction patterns and simplifies component structure. Multiple components like LinkDialog, DeleteConfirmationModal, and ConfirmationPopup have been updated to leverage this new approach.

Changes

File Change Summary
frontend/src/components/PopUpMessages/PopUpMessages.jsx Completely redesigned component with enhanced prop configuration, dynamic rendering using Material-UI dialog components, and added PropTypes.
frontend/src/components/PopUpMessages/PopUpMessages.module.scss Deleted styling file.
frontend/src/components/PopUpMessages/PopUpStyles.js Renamed dialogStyles to popupStyles, removed contentText style.
frontend/src/components/RichTextEditor/EditorLinkDialog/DialogStyles.js Removed dialog styles file.
frontend/src/components/RichTextEditor/EditorLinkDialog/LinkDialog.jsx Refactored to use PopUpMessages component, added PropTypes.
frontend/src/scenes/settings/Modals/DeleteConfirmationModal/DeleteConfirmationModal.jsx Updated modal to use PopUpMessages, simplified structure.
frontend/src/templates/GuideMainPageTemplate/GuideMainPageComponents/ConfirmationPopup/ConfirmationPopup.jsx Replaced Material-UI dialog with PopUpMessages component.

Sequence Diagram

sequenceDiagram
    participant Parent as Parent Component
    participant PopUpMessages as PopUpMessages
    participant DialogActions as Dialog Actions

    Parent->>PopUpMessages: Open popup with props
    PopUpMessages->>PopUpMessages: Render dialog
    Parent->>PopUpMessages: Set button click handlers
    PopUpMessages->>DialogActions: Configure buttons
    DialogActions-->>Parent: Trigger action on button click
Loading

Possibly Related PRs

Suggested Reviewers

  • gorkem-bwl
  • erenfn

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3701e2c and b35ca55.

📒 Files selected for processing (1)
  • frontend/src/components/PopUpMessages/PopUpStyles.js (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • frontend/src/components/PopUpMessages/PopUpStyles.js

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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

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

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: 1

🧹 Nitpick comments (3)
frontend/src/components/PopUpMessages/PopUpMessages.jsx (1)

63-75: Minor naming fix for additionanLinkButton.
Runnin’ out of breath with that spelling – rename to additionalLinkButton or similar for clarity. This helps keep your arms steady under pressure.

frontend/src/templates/GuideMainPageTemplate/GuideMainPageComponents/ConfirmationPopup/ConfirmationPopup.jsx (1)

15-18: Consider making the confirmation message more context-specific.
When folks see “Are you sure you want to perform this action?”, it’s easy to freeze up like sweaty palms in a big moment. Adding an action-specific detail can help reassure the user.

frontend/src/scenes/settings/Modals/DeleteConfirmationModal/DeleteConfirmationModal.jsx (1)

16-21: Revisit the phrasing for clarity.
A strong caution about permanent deletion is good, but you might want to confirm each detail—too much gloom can spook the user. Steady your message like well-planned steps.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 70d1ddb and 3701e2c.

📒 Files selected for processing (8)
  • frontend/src/components/PopUpMessages/PopUpMessages.jsx (1 hunks)
  • frontend/src/components/PopUpMessages/PopUpMessages.module.scss (0 hunks)
  • frontend/src/components/PopUpMessages/PopUpStyles.js (1 hunks)
  • frontend/src/components/RichTextEditor/EditorLinkDialog/DialogStyles.js (0 hunks)
  • frontend/src/components/RichTextEditor/EditorLinkDialog/LinkDialog.jsx (1 hunks)
  • frontend/src/scenes/settings/Modals/DeleteConfirmationModal/DeleteConfirmationModal.jsx (1 hunks)
  • frontend/src/scenes/settings/Modals/DeleteConfirmationModal/DeleteConfirmationModal.module.scss (0 hunks)
  • frontend/src/templates/GuideMainPageTemplate/GuideMainPageComponents/ConfirmationPopup/ConfirmationPopup.jsx (1 hunks)
💤 Files with no reviewable changes (3)
  • frontend/src/scenes/settings/Modals/DeleteConfirmationModal/DeleteConfirmationModal.module.scss
  • frontend/src/components/RichTextEditor/EditorLinkDialog/DialogStyles.js
  • frontend/src/components/PopUpMessages/PopUpMessages.module.scss
🔇 Additional comments (7)
frontend/src/components/PopUpMessages/PopUpMessages.jsx (2)

1-9: The imports are solid, with no sign of sweaty palms here.
Everything lines up well, and these imports should help keep your code stable and maintainable.


25-30: Verify the closeAfterTransition usage.
Ensure closeAfterTransition={open} behaves as expected. Sometimes the adrenaline kicks in, and you want a bit more control over the transition closure.

frontend/src/components/PopUpMessages/PopUpStyles.js (1)

1-1: Renaming to popupStyles looks good.
Nice job consolidating these styles. No sign of shaky knees here—just neat, streamlined code.

frontend/src/templates/GuideMainPageTemplate/GuideMainPageComponents/ConfirmationPopup/ConfirmationPopup.jsx (1)

7-13: Transition to PopUpMessages is smooth.
This approach simplifies maintenance and lifts some burden off your arms. Good onConfirm/onCancel structure. Keep rollin’ with that vibe.

frontend/src/scenes/settings/Modals/DeleteConfirmationModal/DeleteConfirmationModal.jsx (1)

5-15: Replacing the old modal with PopUpMessages is a savvy move.
This keeps your code unified and your overhead light. No nerves, no mess—consistent design all around.

frontend/src/components/RichTextEditor/EditorLinkDialog/LinkDialog.jsx (2)

17-25: Seamless integration of PopUpMessages.
Your updated approach eliminates the jammed dialogues. It’s well-structured: no sweaty second-guessing here.


25-25: Double-check the conditional button text logic.
If url is empty, “Remove link” might confuse the user. Might want a consistent fallback. Keep your momentum steady.

@MandeepPaul MandeepPaul requested a review from erenfn January 4, 2025 15:10
@erenfn erenfn merged commit d6cc068 into develop Jan 4, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants