Skip to content

chore(modal): remove rxjs dependency #105

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

Merged
merged 1 commit into from
Dec 20, 2024
Merged

Conversation

bence444
Copy link
Contributor

@bence444 bence444 commented Dec 19, 2024

PR Checklist

Please check if your PR fulfills the following requirements:

  • Docs have been added/updated (for bug fixes/features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no API changes)
  • Build related changes
  • CI-related changes
  • Documentation content changes
  • Other... Please describe:

Issue Number

Issue Number: saw this in backlog: Flowbite Angular Library

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • Bug Fixes

    • Improved modal behavior on route changes by closing it automatically during navigation.
  • Refactor

    • Streamlined lifecycle management in the ModalComponent, simplifying the component's structure and functionality.

use `@angular/core/rxjs-interop` instead
Copy link

vercel bot commented Dec 19, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
flowbite-angular ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 19, 2024 6:08pm

Copy link
Contributor

coderabbitai bot commented Dec 19, 2024

Walkthrough

The pull request modifies the ModalComponent in the Flowbite Angular library, focusing on simplifying the component's lifecycle management. The changes remove the OnDestroy interface and its associated implementation, replacing the previous route change handling mechanism with a more streamlined approach using the takeUntilDestroyed operator. The constructor now directly subscribes to router events to manage modal closure during navigation, reducing the complexity of the component's lifecycle handling.

Changes

File Change Summary
libs/flowbite-angular/modal/modal.component.ts - Removed OnDestroy interface from class declaration
- Eliminated destroyed subject and ngOnDestroy method
- Added new constructor with router event subscription
- Removed init method with route change logic

Sequence Diagram

sequenceDiagram
    participant Modal as ModalComponent
    participant Router as RouterService
    
    Modal->>Router: Subscribe to NavigationStart events
    activate Router
    
    Router-->>Modal: NavigationStart event
    alt Modal is Open
        Modal->>Modal: Close Modal
    end
    
    deactivate Router
Loading

Possibly related PRs

Suggested reviewers

  • MGREMY

Poem

🐰 A modal's dance, simplified and light,
Router events now take their flight
No more subjects, no destroy's might
Streamlined code, a rabbit's delight!
Angular magic, clean and bright 🌟


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

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

🧹 Nitpick comments (1)
libs/flowbite-angular/modal/modal.component.ts (1)

156-167: Consider improving code organization and documentation

While the implementation is functionally correct, consider these improvements for better maintainability:

  1. The comment could be more descriptive about the purpose of closing modals during navigation
  2. The subscription logic could be moved to a separate private method for better organization

Here's a suggested refactor:

 //#region constructor
 constructor() {
   super();
-
-  // close modal if it's not destroyed on route change
-  this.router.events.pipe(takeUntilDestroyed()).subscribe((event) => {
-    if (this.isOpen() && event instanceof NavigationStart) {
-      this.close();
-    }
-  });
+  this.initializeNavigationHandler();
 }
 //#endregion

+private initializeNavigationHandler(): void {
+  // Close modal during navigation to prevent it from persisting on the new route
+  // This ensures clean navigation and prevents modal state from bleeding across routes
+  this.router.events.pipe(takeUntilDestroyed()).subscribe((event) => {
+    if (this.isOpen() && event instanceof NavigationStart) {
+      this.close();
+    }
+  });
+}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between dca933a and f1e2e86.

📒 Files selected for processing (1)
  • libs/flowbite-angular/modal/modal.component.ts (4 hunks)
🔇 Additional comments (3)
libs/flowbite-angular/modal/modal.component.ts (3)

24-24: Good choice using takeUntilDestroyed!

Using takeUntilDestroyed from @angular/core/rxjs-interop is a modern approach that simplifies subscription management. This is a cleaner alternative to manual subscription cleanup with Subjects.


98-98: Clean class declaration without OnDestroy

The removal of the OnDestroy interface is appropriate since subscription cleanup is now handled by takeUntilDestroyed. This simplifies the component's lifecycle management while maintaining proper inheritance.


Line range hint 1-224: Verify modal behavior in different navigation scenarios

The implementation successfully removes the rxjs dependency while maintaining the modal's functionality. However, it's important to verify the modal behavior in various navigation scenarios.

@MGREMY MGREMY merged commit da67352 into themesberg:main Dec 20, 2024
5 checks passed
@bence444 bence444 deleted the modal-rxjs branch December 20, 2024 15:45
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