Skip to content

Fix some issues on SelectingItemsControls when items or control changes visibility - #20798

Merged
MrJul merged 31 commits into
AvaloniaUI:mainfrom
timunie:ListBoxScrollToElementAfterHide
Jul 28, 2026
Merged

Fix some issues on SelectingItemsControls when items or control changes visibility#20798
MrJul merged 31 commits into
AvaloniaUI:mainfrom
timunie:ListBoxScrollToElementAfterHide

Conversation

@timunie

@timunie timunie commented Mar 3, 2026

Copy link
Copy Markdown
Collaborator

What does the pull request do?

  • Fixes an issue where ListBox doesn't scroll selected item into view after becoming visible
  • Fixes an issue where ColorPicker gets out of sync with SelectedIndex @robloo please test the ColorPicker part if it makes sense to you.

What is the current behavior?

SelectingItemsControls with AlwaysSelected set can select invisible items by accident

What is the updated/expected behavior with this PR?

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

Checklist

Breaking changes

ColorView API was changed by removing not needed protected void

Obsoletions / Deprecations

Fixed issues

Fixes #14718
Fixes #13736 (@robloo this should be the last issue to solve, so I'll close the rollup with this PR)
Fixes #19663

@MrJul MrJul added bug backport-candidate-11.3.x Consider this PR for backporting to 11.3 branch labels Mar 3, 2026
@timunie
timunie marked this pull request as draft March 4, 2026 07:26
@avaloniaui-bot

Copy link
Copy Markdown

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

@timunie timunie changed the title Fix AutoScrollToSelectedItem after ListBox got visible Fix some issues on SelectingItemsControls when items or control changes visibility Mar 4, 2026
The TabItem now handles the correct selection of only visible items
@timunie
timunie force-pushed the ListBoxScrollToElementAfterHide branch from 429ebbb to b28138e Compare March 4, 2026 12:24
@timunie

timunie commented Mar 4, 2026

Copy link
Copy Markdown
Collaborator Author

@MrJul there is now one change that should not backport, but the fix itself can be backported
@robloo please review the ColorPicker changes. On ControlCatalog I can now set the SelectedIndex without issues.

@timunie
timunie marked this pull request as ready for review March 4, 2026 12:26
Comment thread src/Avalonia.Controls.ColorPicker/ColorView/ColorView.cs
@timunie
timunie requested a review from Copilot March 5, 2026 18:55

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@timunie
timunie requested a review from Copilot March 5, 2026 19:22
@avaloniaui-bot

Copy link
Copy Markdown

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

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@robloo robloo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I left some comments on the code changes but overall looks really good. I will have to find the time to test this later though. I've only looked at the code.

Comment thread src/Avalonia.Controls.ColorPicker/ColorView/ColorView.cs
Comment thread src/Avalonia.Controls.ColorPicker/ColorView/ColorView.cs Outdated
Comment thread src/Avalonia.Controls.ColorPicker/ColorView/ColorView.cs Outdated
Comment thread src/Avalonia.Controls/Primitives/SelectingItemsControl.cs Outdated
Comment thread src/Avalonia.Controls.ColorPicker/ColorView/ColorView.cs Outdated
@timunie timunie added the needs-api-review The PR adds new public APIs that should be reviewed. label Mar 8, 2026
@avaloniaui-bot

Copy link
Copy Markdown

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

@timunie
timunie force-pushed the ListBoxScrollToElementAfterHide branch from c842a45 to 31fd7ce Compare May 22, 2026 06:02
@avaloniaui-bot

Copy link
Copy Markdown

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

@cla-avalonia

cla-avalonia commented May 22, 2026

Copy link
Copy Markdown
Collaborator

@Copilot,

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.

2 out of 3 committers have signed the CLA.

@MrJul MrJul removed the backport-candidate-11.3.x Consider this PR for backporting to 11.3 branch label Jun 18, 2026
@MrJul MrJul added backport-candidate-12.1.x Consider this PR for backporting to 12.1 branch and removed backport-candidate-12.0.x Consider this PR for backporting to 12.0 branch labels Jul 9, 2026
@avaloniaui-bot

Copy link
Copy Markdown

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

@MrJul

MrJul commented Jul 28, 2026

Copy link
Copy Markdown
Member

I've added several new failing tests for AlwaysSelected mode, related to the changes in this PR, and fixed them.
We should now be good to go.

@avaloniaui-bot

Copy link
Copy Markdown

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

@MrJul
MrJul added this pull request to the merge queue Jul 28, 2026
Merged via the queue into AvaloniaUI:main with commit 71ded23 Jul 28, 2026
9 checks passed
MrJul added a commit that referenced this pull request Jul 29, 2026
â€Ķes visibility (#20798)

* Add failing test for #14718

* Fix for AutoScrollToSelectedItemIfNecessary

* fix failing CI build and move test to the right location

* add failing test for TabItem selection of invisble tab

* introduce a helper method to figure out which item to select

when nothing was selected beforehand and AlwaysSelected is true

* ensure selection works for invisible tabcontrol

* simplify conditions

* propose: Remove redundant logic from ColorView

The TabItem now handles the correct selection of only visible items

* fix test: Need to set SelectedIndex after adding items

* re-add unused method and make it obsolete

Otherwise API-diff will fail.

* Address review

* Update tests/Avalonia.Controls.UnitTests/TabControlTests.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update tests/Avalonia.Controls.UnitTests/TabControlTests.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Adress copilot review

* fix duplicate braces

* address review

* fix for failing tests on CarouselPage and TabbedPage

* address feedback

- adding more tests to avoid regressions

* Fix failing test: add UnitTestApplication.Start() to dedicated thread test

Agent-Logs-Url: https://github.com/timunie/Avalonia/sessions/fe2f1190-6d20-4982-8a03-1ae9b52ee701

Co-authored-by: timunie <47110241+timunie@users.noreply.github.com>

* Refactor SelectingItemsControl auto-scroll duplicate logic

Agent-Logs-Url: https://github.com/timunie/Avalonia/sessions/8895cb60-ef41-473c-972b-bad2483a5a77

Co-authored-by: timunie <47110241+timunie@users.noreply.github.com>

* Add new failing tests for AlwaysSelected mode

* Fix AlwaysSelected scenarios

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Julien Lebosquain <julien@lebosquain.net>
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
@MrJul MrJul added backported-12.1.x and removed backport-candidate-12.1.x Consider this PR for backporting to 12.1 branch labels Jul 29, 2026
@timunie
timunie deleted the ListBoxScrollToElementAfterHide branch August 6, 2026 12:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

AutoScrollToSelectedItem doesn't work if selection was set while the control was invisible ItemsControl / ListBox Issues Roll-up

7 participants