feat: Added Settings menu to Drifty GUI

SaptarshiSarkar12 / Drifty

Drifty is an Open-Source Interactive File Downloader System built with Java

https://saptarshisarkar12.github.io/Drifty/

Apache License 2.0

172 stars 120 forks source link

feat: Added Settings menu to Drifty GUI #544

Closed ziad-ashraf7 closed 2 months ago

ziad-ashraf7 commented 2 months ago

Fixes issue

Fixes #282

Changes proposed

Created DarkTheme.css to make the Dark theme colors and font.
Created Settings.java to start with the settings page code.
Created in Atuo-Paste Label and Checkbox and connected it to the main.Auto-Paste's Checkbox.
Created the Theme Label and ChoiceBox and set it's action to change the theme of the entire app's windows (Main , Settings , About).
Created Default Downloads Directory's label and TextField and connected the TextField to the main.tfDir.
Created the Select Directory's Button and set it's action to open the Directory Chooser to improve the user's accessibility.
Created a costume images for the Save/Start Buttons , Splash image , and the Banner image using adobe photoshop to serve the Dark theme contrast .

Check List (Check all the applicable boxes)
[X] My code follows the code style of this project.
[ ] My change requires changes to the documentation.
[ ] I have updated the documentation accordingly.
[X] This PR does not contain plagiarized content.
[X] The title of my pull request is a short description of the requested changes.

Screenshots

https://github.com/SaptarshiSarkar12/Drifty/assets/155207557/a09af69d-eee8-4814-903c-1b7a1aabb2fa

Note to reviewers

Summary by CodeRabbit

New Features
- Introduced theme settings for customizing the appearance of the application, including dark and light modes.
- Added a new "Settings" menu for users to configure preferences such as default download directories and auto-paste settings.
- Implemented an "About" window displaying application information, version details, and links to the website, Discord, and GitHub.
Refactor
- Updated menu items and their action handlers for better navigation and usability.
- Moved the logic for displaying the "About" window into a dedicated method for improved code organization.
Style
- Enhanced button styles with bold font for better visibility and consistency.
- Updated CSS paths to load appropriate stylesheets based on the selected theme.

vercel[bot] commented 2 months ago

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

Name	Status	Preview	Comments	Updated (UTC)
drifty	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 26, 2024 10:30am

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes integrate a new Settings menu into the Drifty GUI, enhancing user customization by allowing preferences such as the Last Download folder and Auto-Paste options. Major alterations span Java and resource files, fixing theme management and updating UI components, with a focus on improving usability and user settings.

Changes

Files/Directories	Change Summary
`.idea/inspectionProfiles/Project_Default.xml`	Added ESLint inspection tool to the project's default inspection profile.
`Core/src/main/java/preferences/Get.java`	Converted `preferences` field and method `lastDownloadFolder` to static, added `mainTheme` method.
`GUI/src/main/java/gui/preferences/{Clear,Labels,Set}.java`	Added and adjusted methods for main theme preferences handling and updates to `Labels` enum.
`GUI/src/main/java/gui/support/Constants.java`	Incorporated conditional logic for different theme CSS files and image resources.
`GUI/src/main/java/main/{Drifty_GUI,UIController}.java`	Refactored menu items, introduced `Settings` and `About` windows, updated theme-based CSS, unified duplicate logic, and added methods for new UI components.
`GUI/src/main/java/ui/{ConfirmationDialog,About,Settings,UIComponentBuilder}.java`	Modified static members, added methods for displaying about information and settings, managing themes, UI component builders, and handling directory selections.
`GUI/src/main/resources/CSS/Button.css`	Added bold font-weight styling to button states.
`GUI/src/main/resources/META-INF/native-image/*.json`	Updated various method declarations and file paths for resources in configuration files.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Drifty_GUI
    participant Settings
    User->>+Drifty_GUI: Open Settings Menu
    Drifty_GUI->>+Settings: Show Settings Window
    Settings->>+User: Display Preferences
    User->>+Settings: Set Preferences (e.g., Theme, Auto-Paste)
    Settings->>+User: Save Preferences
    User->>+Drifty_GUI: See Updated Preferences

Assessment against linked issues

Objective (Issues)	Addressed	Explanation
Create a settings window in Drifty GUI for managing preferences (e.g., Last Download Folder, Auto-Paste) (#282)	✅
Introduce a method to display the About window with application information (#282)	✅
Update CSS and resources management based on main theme preferences (#282)	✅

In Drifty's realm where settings hide, A rabbit hopped and beamed with pride. 🐰 For themes to switch and downloads placed, Auto-paste is now embraced. 🎉 Preferences set with much delight, Drifty's future is shining 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?

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.