Skip to content

[feat] Implement BaseBottomSheetDialogFragment#41

Merged
tuancoltech merged 2 commits intomainfrom
feat/implement_base_bottom_dialog
Apr 11, 2025
Merged

[feat] Implement BaseBottomSheetDialogFragment#41
tuancoltech merged 2 commits intomainfrom
feat/implement_base_bottom_dialog

Conversation

@tuancoltech
Copy link
Member

@tuancoltech tuancoltech commented Apr 11, 2025

Implement BaseBottomSheetDialogFragment.
This reduces the complexity of dependent app to have fully expanded bottom dialog style.

See: elimu-ai/vitabu#194

Summary by CodeRabbit

  • New Features
    • Improved the user experience by having bottom sheet dialogs open fully expanded, ensuring essential content is immediately visible when the dialog is displayed.

@tuancoltech tuancoltech requested a review from a team as a code owner April 11, 2025 15:26
@tuancoltech tuancoltech requested a review from jo-elimu April 11, 2025 15:26
@tuancoltech tuancoltech self-assigned this Apr 11, 2025
@coderabbitai
Copy link

coderabbitai bot commented Apr 11, 2025

Walkthrough

A new Kotlin class, BaseBottomSheetDialogFragment, has been added to the ai.elimu.common.utils.ui package. This class extends BottomSheetDialogFragment and overrides the onStart method. During the dialog’s start, it retrieves the bottom sheet view using the ID design_bottom_sheet. If the view is found, it obtains the associated BottomSheetBehavior and sets its state to STATE_EXPANDED, ensuring that the bottom sheet is fully expanded when displayed. This change supports the ongoing development aligned with elimu.ai's mission to build innovative learning software that empowers out-of-school children to teach themselves basic reading📖, writing✍🏽 and math🔢 within 6 months.

Changes

File Path Change Summary
utils/src/main/java/ai/elimu/common/utils/ui/BaseBottomSheetDialogFragment.kt Introduced a new Kotlin class that extends BottomSheetDialogFragment and overrides onStart to retrieve the bottom sheet view and set its state to STATE_EXPANDED upon starting

Sequence Diagram(s)

sequenceDiagram
    participant Fragment as BaseBottomSheetDialogFragment
    participant BottomSheet as Design Bottom Sheet View
    participant Behavior as BottomSheetBehavior

    Fragment->>Fragment: onStart()
    Fragment->>BottomSheet: findViewById(R.id.design_bottom_sheet)
    alt Bottom sheet view found
        Fragment->>Behavior: BottomSheetBehavior.from(view)
        Behavior->>Behavior: Set state to STATE_EXPANDED
    else View not found
        Fragment->>Fragment: Do nothing
    end
Loading

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.
✨ 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.

Copy link

@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)
utils/src/main/java/ai/elimu/common/utils/ui/BaseBottomSheetDialogFragment.kt (1)

7-9: Consider enhancing the class documentation.

While the current documentation is clear, it could be more informative by including a brief explanation of why one might want an expanded bottom dialog style or providing a simple usage example. This would help developers understand when to use this class.

 /**
- * Extend this class to have EXPANDED bottom dialog style
+ * Extend this class to have EXPANDED bottom dialog style.
+ * This provides a consistent user experience by ensuring bottom sheets
+ * are fully expanded when displayed, giving maximum visibility to content.
+ *
+ * Example usage:
+ * ```
+ * class MyBottomSheet : BaseBottomSheetDialogFragment() {
+ *     // Your implementation here
+ * }
+ * ```
  */
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4b1f0a1 and e5be743.

📒 Files selected for processing (1)
  • utils/src/main/java/ai/elimu/common/utils/ui/BaseBottomSheetDialogFragment.kt (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: build (windows-latest, 17)
  • GitHub Check: build (macos-latest, 17)
  • GitHub Check: build (macos-latest, 21)
  • GitHub Check: build (ubuntu-latest, 17)
  • GitHub Check: build (ubuntu-latest, 21)
🔇 Additional comments (3)
utils/src/main/java/ai/elimu/common/utils/ui/BaseBottomSheetDialogFragment.kt (3)

1-21: Excellent implementation of the BaseBottomSheetDialogFragment!

This class provides a clean, reusable solution for creating fully expanded bottom sheet dialogs, which aligns perfectly with elimu.ai's mission to build innovative learning software that empowers out-of-school children to teach themselves basic reading📖, writing✍🏽 and math🔢 within 6 months. The implementation is straightforward and follows Kotlin best practices.


11-20: Well-implemented onStart method with proper null safety.

The implementation effectively ensures the bottom sheet is expanded when shown, using Kotlin's safe call operator and null-safe return. Good practice calling the super method first and using early return pattern.


10-10: The 'open' modifier is appropriate here.

Making this class open allows for further customization by subclasses, which is essential for a base utility class in a library. This flexibility will help dependent applications build upon this foundation.

@tuancoltech tuancoltech merged commit 0dff681 into main Apr 11, 2025
6 checks passed
@tuancoltech tuancoltech deleted the feat/implement_base_bottom_dialog branch April 11, 2025 15:59
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