[Android] Fixed duplicate title icon when setting TitleIconImageSource Multiple times

[SubhikshaSf4851]

Note

Are you waiting for the changes in this PR to be merged?
It would be very helpful if you could test the resulting artifacts from this PR and let us know in a comment if this change resolves your issue. Thank you!

RootCause:

UpdateTitleIcon always added a new ToolbarTitleIconImageView without checking for an existing one, causing duplicate icons when TitleIconImageSource was set multiple times.

Description of Change

Modified UpdateTitleIcon method to check for an existing ToolbarTitleIconImageView and only add a new one if necessary, ensuring that duplicate icons are not created when the title icon is set multiple times.

Issues Fixed

Fixes #31445

Tested the behavior in the following platforms

• Windows
• Android
• iOS
• Mac

Screenshot

Before Issue Fix	After Issue Fix
BeforeFix31445.mov	AfterFix31445.mov

[Copilot]

Pull Request Overview

This pull request fixes a bug where duplicate title icons would appear in Android navigation bars when the TitleIconImageSource property was set multiple times. The issue was caused by the UpdateTitleIcon method always creating a new ToolbarTitleIconImageView without checking for existing ones.

Key changes:

• Modified the UpdateTitleIcon method to check for existing ToolbarTitleIconImageView before creating new ones
• Added proper reuse logic to prevent duplicate icons
• Included test cases to verify the fix

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File	Description
src/Controls/src/Core/Platform/Android/Extensions/ToolbarExtensions.cs	Updated UpdateTitleIcon method to check for existing icon views and reuse them instead of always creating new ones
src/Controls/tests/TestCases.HostApp/Issues/Issue31445.cs	Added test page that reproduces the duplicate icon issue by setting TitleIconImageSource multiple times
src/Controls/tests/TestCases.Shared.Tests/Tests/Issues/Issue31445.cs	Added UI test that verifies the fix by checking that only one title icon appears after button interaction

[Copilot]

The test only sets the same image source again. To better validate the fix, consider testing with different image sources or setting the same source multiple times in rapid succession to ensure the duplicate prevention works in various scenarios.

[jsuarezruiz]

/azp run MAUI-UITests-public

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[jsuarezruiz]

/azp run MAUI-UITests-public

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[PureWeen]

/rebase

[PureWeen]

✅ Review Complete

The fix works correctly for the reported issue - tests pass and the duplicate icon bug is resolved.

However, I explored an alternative approach that might offer better robustness and wanted to get your thoughts:

Alternative: Dedupe & Scan

Instead of checking only index 0, we could scan all toolbar children to find any ToolbarTitleIconImageView instances:

ToolbarTitleIconImageView? titleIcon = null;
for (int i = 0; i < nativeToolbar.ChildCount; i++)
{
    var child = nativeToolbar.GetChildAt(i);
    if (child is ToolbarTitleIconImageView icon)
    {
        if (titleIcon == null)
            titleIcon = icon; // Keep the first one found
        else
            nativeToolbar.RemoveView(icon); // Remove any extras (self-healing)
    }
}

Why consider this?

1. Robustness against view injection - If another library inserts a view at index 0, the current fix would miss the existing icon and create a duplicate
2. Self-healing - Cleans up any pre-existing duplicates from previous bugs

Trade-off: O(N) loop instead of O(1), but toolbar child count is typically very small.

What do you think - is the added robustness worth the change, or should we stick with the simpler index 0 check?

[SubhikshaSf4851]

@PureWeen Yes it is a valid suggestion and I have committed the changes.

[kubaflo]

🤖 AI Summary

📊 Expand Full Review

---

🔍 Pre-Flight — Context & Validation

---

📝 Review Session — Commited the suggested changes · 1f9137f

---

On Android, calling NavigationPage.SetTitleIconImageSource(page, "image.png") more than once for the same page results in the icon being rendered multiple times in the navigation bar.

Steps to Reproduce:

1. Launch app on Android
2. Tap "Set TitleIconImageSource" once: icon appears
3. Tap it again: a second identical icon appears

Expected: Single toolbar icon regardless of how many times SetTitleIconImageSource is called.

Actual: Each repeated call adds an additional duplicate icon.

Platforms Affected:

• iOS
• Android
• Windows
• MacCatalyst

Version: 9.0.100 SR10

---

🚦 Gate — Test Verification

---

📝 Review Session — Commited the suggested changes · 1f9137f

---

Status: ✅ PASSED

• Tests FAIL without fix (bug reproduced - duplicate icons appeared)
• Tests PASS with fix (single icon as expected)

Result: PASSED ✅

Verification Details:

• Platform: Android
• Without fix: Test FAILED (screenshot mismatch - duplicate icons)
• With fix: Test PASSED (single icon verified)

Note: Gate verified in prior agent review session (2026-01-08)

---

🔧 Fix — Analysis & Comparison

---

📝 Review Session — Commited the suggested changes · 1f9137f

---

Status: ✅ COMPLETE

#	Source	Approach	Test Result	Files Changed	Model	Notes
1	try-fix	Check for existing icon view at position 0, reuse if exists	✅ PASS	ToolbarExtensions.cs (+7)	Opus 4.5	Works!
2	try-fix	Dedupe defensively by scanning all toolbar children	✅ PASS	ToolbarExtensions.cs (+22/-5)	GPT 5.2	More robust - ADOPTED BY PR
3	try-fix	Use FindViewWithTag to identify the MAUI title icon	✅ PASS	ToolbarExtensions.cs (+20/-6)	Gemini 2.0 Flash	Most robust but adds Tag overhead
PR	PR #31487	Scan all children, keep first, remove extras (self-healing)	✅ PASS (Gate)	ToolbarExtensions.cs (+27/-6)	Author	Now uses Alternative #2 approach

Exhausted: Yes (3 passing alternatives found in prior session)

Selected Fix: PR's fix (updated to use the dedupe & scan approach from try-fix #2)

• Scans all children of toolbar to find existing ToolbarTitleIconImageView
• Keeps first one found, removes any extras (self-healing)
• Creates new only if none exists
• More robust than just checking index 0

---

📋 Report — Final Recommendation

---

📝 Review Session — Commited the suggested changes · 1f9137f

---

Status: ✅ COMPLETE

Final Recommendation: APPROVE

Root Cause Analysis

The original UpdateTitleIcon method always created a new ToolbarTitleIconImageView and added it to position 0, without checking if one already existed. This caused duplicate icons when the method was called repeatedly.

The bug has existed since the original implementation in Oct 2021 (e2f3aaa222). The original code had a check for removing an existing icon when source is null/empty, but this check was only in the removal path, not in the creation path.

Key Findings

1. PR adopted the more robust approach - Instead of just checking index 0, the PR now scans all children
2. Self-healing behavior - If duplicates already exist, they get cleaned up
3. Robust against external view insertions - Works even if another library inserts views
4. Prior review completed - Full agent review embedded in PR (pr-31487.md)

Fix Verified via Cherry-Pick

Applied fix locally (without branch switch) and verified:

• ✅ Controls.Core.csproj builds for Android
• ✅ TestCases.HostApp builds for Android
• ✅ TestCases.Shared.Tests builds

Verdict

✅ APPROVE - The PR correctly fixes the duplicate title icon issue on Android. The fix is well-tested, follows codebase patterns, and includes self-healing behavior for edge cases.

Notes

• PR needs rebase (PureWeen requested)
• Milestoned for .NET 10 SR5

---