Improve BitPanel component (#9413)

[msynk]

closes #9413

Summary by CodeRabbit

Release Notes

• New Features

  • Enhanced resource management for the BitPanel component with asynchronous disposal capabilities.
  • Introduced a new static method for disposing of panel instances by ID.
  • Added support for additional configuration options in the BitPanel component, including HeaderTemplate and FooterTemplate.

• Bug Fixes

  • Improved event handling logic for the BitPanel, ensuring robustness and clarity.

• Documentation

  • Updated examples in the demo to reflect changes in the BitPanel component, simplifying usage and enhancing configurability.

[coderabbitai]

Walkthrough

The changes in this pull request focus on enhancing the BitPanel component within the Bit.BlazorUI library. Key modifications include the implementation of the IAsyncDisposable interface for asynchronous resource management, the addition of a dispose method in both C# and TypeScript, and improvements to event handling logic. The BitPanelDemo examples have been updated to reflect these changes, simplifying some parameters and enhancing configurability. Overall, these updates improve the component's resource management and event handling capabilities.

Changes

File	Change Summary
src/BlazorUI/Bit.BlazorUI/Components/Surfaces/Panel/BitPanel.razor.cs	Implemented IAsyncDisposable, added DisposeAsync methods, introduced _disposed field.
src/BlazorUI/Bit.BlazorUI/Components/Surfaces/Panel/BitPanel.ts	Updated event handling logic, added dispose method for panel instance removal.
src/BlazorUI/Bit.BlazorUI/Components/Surfaces/Panel/BitPanelJsRuntimeExtensions.cs	Added BitPanelDispose method for JavaScript panel disposal.
src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Surfaces/Panel/BitPanelDemo.razor	Removed Classes parameter, updated ChildContent structure, enhanced configurability options.
src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Surfaces/Panel/BitPanelDemo.razor.cs	Removed Classes attribute from footer panel example, maintained existing structure.

Assessment against linked issues

Objective	Addressed	Explanation
Missing dispose mechanism (Issue #9413)	✅
Improve pointer leave event (Issue #9413)	✅

🐰 Hopping through the code, with joy I see,
A BitPanel that disposes so gracefully!
With events refined, it dances with ease,
In the land of Blazor, it aims to please.
So here’s to the changes, let’s give a cheer,
For a panel that’s smarter, let’s spread the cheer! 🎉

---

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

🧹 Outside diff range and nitpick comments (1)

src/BlazorUI/Bit.BlazorUI/Components/Surfaces/Panel/BitPanel.ts (1)

118-123: Remove redundant onLeave function

Consolidating the onLeave functionality into onEnd reduces code duplication and simplifies event handling.

This change improves maintainability by reducing the number of event handlers.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 18ead05 and e6c8cee.

📒 Files selected for processing (5)

• src/BlazorUI/Bit.BlazorUI/Components/Surfaces/Panel/BitPanel.razor.cs (2 hunks)
• src/BlazorUI/Bit.BlazorUI/Components/Surfaces/Panel/BitPanel.ts (4 hunks)
• src/BlazorUI/Bit.BlazorUI/Components/Surfaces/Panel/BitPanelJsRuntimeExtensions.cs (1 hunks)
• src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Surfaces/Panel/BitPanelDemo.razor (2 hunks)
• src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Surfaces/Panel/BitPanelDemo.razor.cs (1 hunks)

🔇 Additional comments (10)

src/BlazorUI/Bit.BlazorUI/Components/Surfaces/Panel/BitPanel.razor.cs (1)

3-3: Implement IAsyncDisposable interface correctly

The addition of IAsyncDisposable interface is appropriate for asynchronous disposal of resources.

src/BlazorUI/Bit.BlazorUI/Components/Surfaces/Panel/BitPanelJsRuntimeExtensions.cs (1)

15-18: Addition of BitPanelDispose method

The new BitPanelDispose method appropriately extends IJSRuntime for disposing panel instances.

src/BlazorUI/Bit.BlazorUI/Components/Surfaces/Panel/BitPanel.ts (6)

22-23: Simplify event coordinate retrieval with consistent type checking

The updated getX and getY functions correctly use isTouchDevice to determine the event type, ensuring accurate coordinate retrieval.

---

82-82: Reset startX and startY at the start of onEnd

Moving the reset of startX and startY ensures that these values are cleared promptly when the touch or pointer interaction ends.

---

85-114: Enhance reliability with try...finally in onEnd

The inclusion of a try...finally block in onEnd guarantees that OnEnd is invoked and diffX and diffY are reset, even if an exception occurs.

---

134-134: Update event listener to use onEnd for pointerleave

Changing the event listener to use onEnd ensures consistent behavior when the pointer leaves the element.

---

147-147: Ensure event listeners are correctly removed in disposer

Removing the pointerleave event listener within the disposer prevents potential memory leaks and ensures proper cleanup.

---

153-159: Add static dispose method for panel management

The new dispose method effectively manages panel instances, enhancing resource management and preventing memory leaks.

src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Surfaces/Panel/BitPanelDemo.razor (1)

Line range hint 73-84: Verify the impact of removing Classes parameter

Please ensure that removing the Classes parameter does not affect the styling of the footer content. If custom styles are no longer needed, this change simplifies the component usage.

src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Surfaces/Panel/BitPanelDemo.razor.cs (1)

335-335: Confirm removal of Classes parameter

The removal of the Classes parameter in the code aligns with the simplified usage in the Razor file. Verify that this does not impact the intended styles.