Skip to content

[V3] Update systray.mdx example#4307

Merged
leaanthony merged 2 commits intowailsapp:v3-alphafrom
apzuk3:patch-1
May 26, 2025
Merged

[V3] Update systray.mdx example#4307
leaanthony merged 2 commits intowailsapp:v3-alphafrom
apzuk3:patch-1

Conversation

@apzuk3
Copy link
Copy Markdown

@apzuk3 apzuk3 commented May 25, 2025

GUI operations must run on the main thread I guess? this example calling systray.Run() from a non-main thread context and it will panic.

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

Type of change

Please select the option that is relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration using wails doctor.

  • Windows
  • macOS
  • Linux

If you checked Linux, please specify the distro and version.

Test Configuration

Please paste the output of wails doctor. If you are unable to run this command, please describe your environment in as much detail as possible.

Checklist:

  • I have updated website/src/pages/changelog.mdx with details of this PR
  • [x ] My code follows the general coding style of this project
  • I have performed a self-review of my own code
  • [x ] I have commented my code, particularly in hard-to-understand areas
  • [ x] I have made corresponding changes to the documentation
  • [ x] My changes generate no new warnings
  • [x ] I have added tests that prove my fix is effective or that my feature works
  • [x ] New and existing unit tests pass locally with my changes

Summary by CodeRabbit

  • Documentation
    • Updated code examples to use app.Run() instead of systray.Run() for starting system tray applications.
    • Revised menu item click handler examples to reflect updated parameter usage.

GUI operations must run on the main thread I guess? this example calling systray.Run() from a non-main thread context and it will panic.
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented May 25, 2025

Walkthrough

The documentation for creating and running a system tray application was updated to use app.Run() instead of systray.Run() in all relevant code examples. Menu item click handler signatures were also changed to accept a *application.Context parameter. No changes were made to the actual API or exported entities; only the documentation code snippets were revised for consistency.

Changes

File(s) Change Summary
docs/src/content/docs/learn/systray.mdx Updated code examples to use app.Run() instead of systray.Run() and changed menu handler signatures to accept *application.Context

Suggested reviewers

  • leaanthony

Poem

A hop, a skip, a code refactor,
Docs now shine with logic crisper.
app.Run() leads the tray parade,
Old systray.Run() is gently laid.
With snippets neat and clear as day,
The rabbit cheers, "Hip-hop, hooray!" 🐇


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fb4d0fc and b4e6195.

📒 Files selected for processing (1)
  • docs/src/content/docs/learn/systray.mdx (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/src/content/docs/learn/systray.mdx

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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this 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.

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.

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.

@github-actions github-actions bot added the Documentation Improvements or additions to documentation label May 25, 2025
Copy link
Copy Markdown
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

🧹 Nitpick comments (2)
docs/src/content/docs/learn/systray.mdx (2)

21-21: Ensure error handling around app.Run().
Switching from systray.Run() to app.Run() correctly starts the Wails application on the main thread. For production readiness, consider capturing and handling the returned error to avoid silent failures:

if err := app.Run(); err != nil {
    log.Fatal(err)
}

136-136: Add error checking to application startup.
In the complete example, app.Run() should similarly be wrapped to surface any initialization errors. For example:

if err := app.Run(); err != nil {
    log.Fatal(err)
}
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3716aca and fb4d0fc.

📒 Files selected for processing (1)
  • docs/src/content/docs/learn/systray.mdx (2 hunks)

OnClick function takes *application.Context. the example if not complete
@apzuk3 apzuk3 changed the title Update systray.mdx example [V3] Update systray.mdx example May 25, 2025
@sonarqubecloud
Copy link
Copy Markdown

@leaanthony leaanthony merged commit 83005be into wailsapp:v3-alpha May 26, 2025
7 checks passed
@leaanthony
Copy link
Copy Markdown
Member

Ah thank you!! 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants