Skip to content

Wayland : Add AppId in WaylandPlatformOptions and WaylandProperties - #22209

Merged
MrJul merged 6 commits into
AvaloniaUI:mainfrom
Whiletru3:feature/wayland-app-id
Oct 5, 2026
Merged

MrJul merged 6 commits into
AvaloniaUI:mainfrom
Whiletru3:feature/wayland-app-id

Conversation

@Whiletru3

Copy link
Copy Markdown
Contributor

What does the pull request do?

In Wayland, an app in a "Alt+Tab" should have the name and the icon of the .desktop
Added a property AppId in WaylandPlatformOptions and WaylandProperties to overload the app id if the executable name don't match the app name of the .desktop file. By default it will take the name of the executable if it is not set.

What is the current behavior?

For now, the icon is the default system one and the name is unknow.

What is the updated/expected behavior with this PR?

A new property AppId in WaylandPlatformOptions or set WaylandProperties.AppId in a Window

How was the solution implemented (if it's not obvious)?

I copied the SetTitle in Wayland and add the possibility to set the property AppId in WaylandPlatformOptions or in Windows.WaylandProperties

Checklist

Breaking changes

None

Obsoletions / Deprecations

None

@MrJul

MrJul commented Sep 10, 2026

Copy link
Copy Markdown
Member

This looks similar to #21982, but that one doesn't add WaylandProperties.AppId.

@cla-avalonia

cla-avalonia commented Sep 10, 2026 •

Copy link
Copy Markdown
Collaborator
  • All contributors have signed the CLA.

@avaloniaui-bot

Copy link
Copy Markdown

You can test this PR using the following package version. 12.2.999-cibuild0069785-alpha. (feed url: https://nuget-feed-all.avaloniaui.net/v3/index.json) [PRBUILDID]

@maxkatz6

Copy link
Copy Markdown
Member

I would assume AppId per app (not per window) is much more common use case.
Additionally, if app has a .DESKTOP entry, it's typically expected to match that app id, no?

I understand one might need to have different windows behave as different applications (quick google suggests viewer/editor split might be reasonable here). I wonder if we can provide wayland interop points instead for these cases. cc @kekekeks

@Whiletru3
Whiletru3 force-pushed the feature/wayland-app-id branch from e8e14fe to ba10cde Compare September 11, 2026 07:06
@Whiletru3

Copy link
Copy Markdown
Contributor Author

This looks similar to #21982, but that one doesn't add WaylandProperties.AppId.

Indeed I didn't saw this one

@Whiletru3

Copy link
Copy Markdown
Contributor Author

I would assume AppId per app (not per window) is much more common use case. Additionally, if app has a .DESKTOP entry, it's typically expected to match that app id, no?

I understand one might need to have different windows behave as different applications (quick google suggests viewer/editor split might be reasonable here). I wonder if we can provide wayland interop points instead for these cases. cc @kekekeks

Yes, I think there are some cases where 2 windows could have different AppId, or setting it dynamically in the window using a binding to a view model

…ndProperties to overload the app id if the executable name don't match the app name of the .desktop file
@Whiletru3
Whiletru3 force-pushed the feature/wayland-app-id branch from ba10cde to 5fee5ae Compare September 11, 2026 07:19
@Whiletru3

Copy link
Copy Markdown
Contributor Author

@Whiletru3,

Please read the following Contributor License Agreement (CLA). If you agree with the CLA, please reply with the following:

@cla-avalonia agree

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement ( “Agreement” ) is agreed to by the party signing below ( “You” ), and conveys certain license rights to the AvaloniaUI OÜ ( “AvaloniaUI OÜ” ) for Your contributions to AvaloniaUI OÜ open source projects. This Agreement is effective as of the latest signature date below.

1. Definitions.

“Code” means the computer software code, whether in human-readable or machine-executable form, that is delivered by You to AvaloniaUI OÜ under this Agreement.

“Project” means any of the projects owned or managed by AvaloniaUI OÜ and offered under a license approved by the Open Source Initiative (www.opensource.org).

“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any Project, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of discussing and improving that Project, but excluding communication that is conspicuously marked or otherwise designated in writing by You as “Not a Submission.”

“Submission” means the Code and any other copyrightable material Submitted by You, including any associated comments and documentation.

2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any Project. This Agreement covers any and all Submissions that You, now or in the future (except as described in Section 4 below), Submit to any Project.

3. Originality of Work. You represent that each of Your Submissions is entirely Your original work. Should You wish to Submit materials that are not Your original work, You may Submit them separately to the Project if You (a) retain all copyright and license information that was in the materials as you received them, (b) in the description accompanying your Submission, include the phrase "Submission containing materials of a third party:" followed by the names of the third party and any licenses or other restrictions of which You are aware, and (c) follow any other instructions in the Project's written guidelines concerning Submissions.

4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your Submission is made in the course of Your work for an employer or Your employer has intellectual property rights in Your Submission by contract or applicable law, You must secure permission from Your employer to make the Submission before signing this Agreement. In that case, the term “You” in this Agreement will refer to You and the employer collectively. If You change employers in the future and desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement and secure permission from the new employer before Submitting those Submissions.

5. Licenses.

a. Copyright License. You grant AvaloniaUI OÜ, and those who receive the Submission directly or indirectly from AvaloniaUI OÜ, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third parties.

b. Patent License. You grant AvaloniaUI OÜ, and those who receive the Submission directly or indirectly from AvaloniaUI OÜ, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under Your patent claims that are necessarily infringed by the Submission or the combination of the Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and import or otherwise dispose of the Submission alone or with the Project.

c. Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement. No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are granted by implication, exhaustion, estoppel or otherwise.

6. Representations and Warranties. You represent that You are legally entitled to grant the above licenses. You represent that each of Your Submissions is entirely Your original work (except as You may have disclosed under Section 3 ). You represent that You have secured permission from Your employer to make the Submission in cases where Your Submission is made in the course of Your work for Your employer or Your employer has intellectual property rights in Your Submission by contract or applicable law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You have the necessary authority to bind the listed employer to the obligations contained in this Agreement. You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES EXPRESSLY STATED IN SECTIONS 3, 4, AND 6 , THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.

7. Notice to AvaloniaUI OÜ. You agree to notify AvaloniaUI OÜ in writing of any facts or circumstances of which You later become aware that would make Your representations in this Agreement inaccurate in any respect.

8. Information about Submissions. You agree that contributions to Projects and information about contributions may be maintained indefinitely and disclosed publicly, including Your name and other information that You submit with Your Submission.

9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the Republic of Estonia, and the parties consent to exclusive jurisdiction and venue in the courts sitting in Talinn, Estonia. The parties waive all defenses of lack of personal jurisdiction and forum non-conveniens.

10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and supersedes any and all prior agreements, understandings or communications, written or oral, between the parties relating to the subject matter hereof. This Agreement may be assigned by AvaloniaUI OÜ.

AvaloniaUI OÜ dedicates this Contribution License Agreement to the public domain according to the Creative Commons CC0 1.

Whiletru3 doesn't seem to be a GitHub user. Please add the emails used in your commits to your Github account accordingly.

@cla-avalonia agree

@avaloniaui-bot

Copy link
Copy Markdown

You can test this PR using the following package version. 12.2.999-cibuild0069813-alpha. (feed url: https://nuget-feed-all.avaloniaui.net/v3/index.json) [PRBUILDID]

@Whiletru3

Copy link
Copy Markdown
Contributor Author

I tested the package 12.2.999-cibuild0069813-alpha in my app without issue

@Whiletru3

Copy link
Copy Markdown
Contributor Author

What is the next step for this change (or the other one #21982 ) ?
Will it be backported to 12.1.x ?

@MrJul MrJul added api-needs-review The PR adds new public APIs that should be reviewed. backport-candidate-12.1.x Consider this PR for backporting to 12.1 branch labels Sep 15, 2026
@MrJul

MrJul commented Sep 15, 2026

Copy link
Copy Markdown
Member

What is the next step for this change

We're going to discuss whether we want the extra attached property; it shouldn't take long.

Will it be backported to 12.1.x ?

Yes

@MrJul MrJul mentioned this pull request Sep 15, 2026
2 of 3 tasks
@MrJul MrJul added api-approved The new public APIs have been approved. and removed api-needs-review The PR adds new public APIs that should be reviewed. labels Sep 17, 2026
@MrJul

MrJul commented Sep 17, 2026

Copy link
Copy Markdown
Member

Notes from the API review meeting:

  • WaylandOptions.AppId was previously approved for (Wayland) Add toplevel app id #21982, so it wasn't discussed.
  • WaylandProperties.AppId is new but perfectly matches what we have in X11 with WmClass: it's approved.

- Centralize default AppId definition in WaylandGlobals
- Use fallback to `Globals.AppId` where applicable.
- Add detailed documentation for the `WaylandProperties.AppId` attached property.
@Whiletru3

Copy link
Copy Markdown
Contributor Author

@MrJul I pushed a rework with all the requested changes

@github-actions

github-actions Bot commented Sep 25, 2026 •

Copy link
Copy Markdown

NuGet packages

The packages for this pull request have been published (workflow run):

@Whiletru3
Whiletru3 requested a review from MrJul September 28, 2026 12:30

@MrJul MrJul left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested, works as expected.
LGTM!

@MrJul
MrJul enabled auto-merge October 5, 2026 14:28
@MrJul
MrJul added this pull request to the merge queue Oct 5, 2026
Merged via the queue into AvaloniaUI:main with commit 4b32663 Oct 5, 2026
10 checks passed
@Whiletru3

Copy link
Copy Markdown
Contributor Author

Should I create a branch of 12.1.x for the backport with the fix ?

@MrJul

MrJul commented Oct 6, 2026

Copy link
Copy Markdown
Member

Should I create a branch of 12.1.x for the backport with the fix ?

No, we'll handle that automatically.

grokys pushed a commit to Evan260/Avalonia that referenced this pull request Oct 7, 2026
…valoniaUI#22209)

* Wayland : Add the AppId in WaylandPlatformOptions or in Windows WaylandProperties to overload the app id if the executable name don't match the app name of the .desktop file

* Rework AppId handling in Wayland backend:
- Centralize default AppId definition in WaylandGlobals
- Use fallback to `Globals.AppId` where applicable.
- Add detailed documentation for the `WaylandProperties.AppId` attached property.

* Make WaylandProperties static

---------

Co-authored-by: Julien Lebosquain <julien@lebosquain.net>
MrJul added a commit that referenced this pull request Oct 9, 2026
…22209)

* Wayland : Add the AppId in WaylandPlatformOptions or in Windows WaylandProperties to overload the app id if the executable name don't match the app name of the .desktop file

* Rework AppId handling in Wayland backend:
- Centralize default AppId definition in WaylandGlobals
- Use fallback to `Globals.AppId` where applicable.
- Add detailed documentation for the `WaylandProperties.AppId` attached property.

* Make WaylandProperties static

---------

Co-authored-by: Julien Lebosquain <julien@lebosquain.net>
@MrJul MrJul added backported-12.1.x and removed backport-candidate-12.1.x Consider this PR for backporting to 12.1 branch labels Oct 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants