Update TrayApp with new parameters and enhanced documentation
#321
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…sparency - Introduced `transparent` parameter to `TrayApp` and its associated methods. - Updated `DialogWindow` configuration to utilize the provided transparency option. - Improved the flexibility of the tray window for different use cases.
- Added a new section in the README explaining the `transparent` parameter for `TrayApp`. - Included usage examples for configuring window transparency. - Clarified the default behavior and platform support for transparency.
…ow titles - Added a `windowsTitle` parameter to `TrayApp` and its related methods for setting custom popup window titles. - Updated `DialogWindow` to utilize the provided title, improving accessibility and debugging support. - Documented the new parameter in the README with examples.
- Introduced `windowIcon` parameter to `TrayApp` and related methods to allow specifying a custom icon for the popup window. - Updated `DialogWindow` to include the provided icon, enhancing visual customization options. - Documented the new parameter in the README with examples.
…custom key event handling - Introduced `onKeyEvent` and `onPreviewKeyEvent` parameters to `TrayApp` and related methods, allowing more customizable key event handling. - Updated `DialogWindow` and platform-specific implementations to support the new key event callbacks. - Documented the new parameters with usage examples for enhanced flexibility.
…d window customization - Introduced `undecorated` and `resizable` parameters to `TrayApp` and related methods, allowing control over window decorations and resizing options. - Updated platform-specific implementations to apply the new parameters consistently across systems. - Documented the parameters in the README with examples to illustrate their usage.
…osable context handling - Changed the `content` parameter type in `TrayApp` and related methods from `@Composable () -> Unit` to `@Composable DialogWindowScope.() -> Unit`. - Updated platform-specific and common implementations to support the new scope. - Removed redundant documentation blocks for improved clarity and maintainability.
- Simplified and reorganized the README with updated examples, focusing on essential `TrayApp` features and usage. - Streamlined explanations for parameters and APIs, removing redundant sections. - Improved quick-start and recipe examples for better developer onboarding.
- Eliminated unused subsections (`Overview`, `Basic Usage`, `TrayAppState API`, and `Advanced Examples`) for a cleaner and more concise documentation structure. - Updated the `TrayApp` header for improved readability and consistency with other sections.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary:
This pull request refines the
TrayAppdocumentation and expands its functionality with new parameters for greater flexibility and customization.Key changes include updates to support features like window transparency, key event handling, resizable decorations, and customizable popup window titles, icons, and contexts.
Details of Changes:
Documentation Updates:
New Features Introduced:
undecorated,resizable, andtransparentparameters for advanced window customization.windowIconandwindowsTitleparameters to enhance UI customizations.onKeyEventandonPreviewKeyEventparameters for detailed input handling.DialogWindowScopefor improved composable contexts.