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

Use native menubar on macOS, not elsewhere (i.e. Linux) #695

Merged
merged 2 commits into from
Aug 13, 2024

Conversation

jonathanperret
Copy link
Contributor

@jonathanperret jonathanperret commented Aug 1, 2024

Fixes #694 .

This PR makes AYAB only disable the native menu bar when an OS other than macOS is detected. Or rather, it un-disables it if macOS is detected. Oh well, you know what I mean 😅.

In addition, Qt's menu roles are leveraged to annotate the relevant actions (About, Preferences, Quit) so that they are automatically migrated to their standardized locations in the native menu. Of course, the migrated menu items function as expected.

Here is the result:

ayab-mac-menu-1.0-fixed.mov

Summary by CodeRabbit

  • New Features

    • Enhanced cross-platform compatibility by adjusting menu bar behavior based on the operating system.
    • Improved UI clarity with new action roles for menu items, enhancing user experience.
  • Bug Fixes

    • Removed the native menu bar for non-macOS systems to ensure consistent menu appearance across platforms.

Copy link
Contributor

coderabbitai bot commented Aug 1, 2024

Walkthrough

The recent changes enhance the Menu class in the AYAB application by ensuring it utilizes a native menu bar on macOS while defaulting to a standard menu bar on other operating systems. Additionally, modifications in the UI definition clarify action roles and remove unnecessary menu properties, improving user experience and adherence to platform standards.

Changes

Files Change Summary
src/main/python/main/ayab/menu.py Added OS check in Menu class constructor to set native menu bar behavior based on the operating system.
src/main/python/main/ayab/menu_gui.ui Removed nativeMenuBar property from QMenuBar and added menuRole properties to actions for enhanced functionality.

Assessment against linked issues

Objective Addressed Explanation
AYAB should use the native menu bar on macOS (#[694])
Eliminate redundant menu items and improve layout (#[694])
Ensure a polished rendering of menu items (#[694]) Rendering improvements not explicitly addressed.
Standardize menu item locations according to macOS norms (#[694]) Unclear if all item placements meet macOS standards.

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
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>.
    • 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 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
Contributor

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2e4adef and 03915b7.

Files selected for processing (2)
  • src/main/python/main/ayab/menu.py (2 hunks)
  • src/main/python/main/ayab/menu_gui.ui (4 hunks)
Additional comments not posted (5)
src/main/python/main/ayab/menu.py (2)

22-22: LGTM! Import statement for QSysInfo.

The import statement for QSysInfo from PySide6.QtCore is appropriate for determining the operating system type.


43-45: LGTM! Conditional logic for platform-specific menu bar behavior.

The conditional logic to set the menu bar to non-native if the OS is not macOS is correctly implemented.

src/main/python/main/ayab/menu_gui.ui (3)

68-70: LGTM! Removal of nativeMenuBar property and addition of menuRole for action_quit.

The removal of the nativeMenuBar property and the addition of the menuRole property for action_quit are appropriate changes to improve platform-specific behavior and semantic meaning.


102-104: LGTM! Addition of menuRole for action_about.

The addition of the menuRole property for action_about is an appropriate change to improve the semantic meaning of the action.


198-200: LGTM! Addition of menuRole for action_set_preferences.

The addition of the menuRole property for action_set_preferences is an appropriate change to improve the semantic meaning of the action.

Adding "menuRole" properties to standard menu actions (About,
Preferences, Quit) lets Qt move them to their standard place in the
macOS menu bar (without having to rely on their text content, which
breaks when localizing). This also automatically sets the "Preferences"
shortcut to the standard "Cmd+," instead of "Cmd+P".

This should have no impact on other platforms.

See https://doc.qt.io/qt-6/qmenubar.html#qmenubar-as-a-global-menu-bar
Copy link

sonarqubecloud bot commented Aug 1, 2024

Copy link
Contributor

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 03915b7 and bda83d4.

Files selected for processing (2)
  • src/main/python/main/ayab/menu.py (2 hunks)
  • src/main/python/main/ayab/menu_gui.ui (4 hunks)
Files skipped from review due to trivial changes (1)
  • src/main/python/main/ayab/menu_gui.ui
Files skipped from review as they are similar to previous changes (1)
  • src/main/python/main/ayab/menu.py

@dl1com dl1com merged commit a03774e into AllYarnsAreBeautiful:1.0.0-dev Aug 13, 2024
2 checks passed
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.

AYAB on macOS does not use the native menu bar
2 participants