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

Add BottomSheetOverlay Explanation in Document's Overlays Section #1852

Closed
easyhooon opened this issue Dec 19, 2024 · 2 comments
Closed

Add BottomSheetOverlay Explanation in Document's Overlays Section #1852

easyhooon opened this issue Dec 19, 2024 · 2 comments

Comments

@easyhooon
Copy link
Contributor

easyhooon commented Dec 19, 2024

https://slackhq.github.io/circuit/overlays/

Thank you for developing this fantastic library.

Having explanation about BottomSheetOverlay would be helpful for developers implementing Circuit in their projects, especially since bottom sheets are a commonly used UI pattern in Android applications.

Suggested content could include:

  1. Explanation of BottomSheetOverlay concept and use cases(including <Model, Result>)
  2. How to handle results from the bottom sheet
  3. (optional) Explanation of the differences between Circuit BottomSheetOverlay and M3 ModalBottomSheet

I believe this addition would make the Circuit documentation more comprehensive and help developers better understand when and how to use Overlays in their applications.

@ZacSweers
Copy link
Collaborator

Doc improvement PRs are helpful but please keep them focused and without unnecessary AI-generated fluff.

@easyhooon
Copy link
Contributor Author

easyhooon commented Dec 27, 2024

In the documentation at https://slackhq.github.io/circuit/circuitx/, I can find explanations about BottomSheetOverlay. Since the usage examples are well documented, there seems to be no issues implementing it. Thanks :)

@ZacSweers ZacSweers closed this as not planned Won't fix, can't repro, duplicate, stale Dec 27, 2024
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

No branches or pull requests

2 participants