Fix Shell.Background not working #35491
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| namespace Maui.Controls.Sample.Issues; | ||
|
|
||
| [Issue(IssueTracker.Github, 10445, "Shell.Background does not support gradient brushes", PlatformAffected.All)] | ||
| public class Issue10445 : TestShell | ||
| { | ||
| protected override void Init() | ||
| { | ||
| FlyoutBehavior = FlyoutBehavior.Disabled; | ||
| var gradientBrush = new LinearGradientBrush | ||
| { | ||
| StartPoint = new Point(0, 0), | ||
| EndPoint = new Point(1, 1), | ||
| GradientStops = new GradientStopCollection | ||
| { | ||
| new GradientStop(Colors.Yellow, 0.0f), | ||
| new GradientStop(Colors.Green, 1.0f) | ||
| } | ||
| }; | ||
|
|
||
| Shell.SetBackground(this, gradientBrush); | ||
|
|
||
| var page = new ContentPage | ||
| { | ||
| Title = "Gradient Shell", | ||
| Content = new VerticalStackLayout | ||
| { | ||
| Padding = 20, | ||
| Spacing = 10, | ||
| VerticalOptions = LayoutOptions.Center, | ||
| HorizontalOptions = LayoutOptions.Center, | ||
| Children = | ||
| { | ||
| new Label | ||
| { | ||
| Text = "Shell.Background should display a gradient (Yellow to Green) in the navigation bar above.", | ||
| AutomationId = "GradientInfoLabel", | ||
| HorizontalTextAlignment = TextAlignment.Center | ||
| } | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| AddContentPage(page, "Home"); | ||
| } | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| using NUnit.Framework; | ||
| using UITest.Appium; | ||
| using UITest.Core; | ||
|
|
||
| namespace Microsoft.Maui.TestCases.Tests.Issues; | ||
|
|
||
| public class Issue10445 : _IssuesUITest | ||
| { | ||
| public Issue10445(TestDevice device) : base(device) | ||
| { | ||
| } | ||
|
|
||
| public override string Issue => "Shell.Background does not support gradient brushes"; | ||
|
|
||
| [Test] | ||
| [Category(UITestCategories.Shell)] | ||
| public void ShellBackgroundSupportsGradientBrush() | ||
| { | ||
| // Wait for the page to be fully loaded | ||
| App.WaitForElement("GradientInfoLabel"); | ||
|
|
||
| // Verify the Shell renders correctly with a gradient background | ||
| VerifyScreenshot(); | ||
|
Contributor
There was a problem hiding this comment.
Contributor
Author
There was a problem hiding this comment. I will add the Windows and Mac baseline images once CI is triggered.
Contributor
There was a problem hiding this comment. ❌ Error: New
Verified at HEAD Fix: commit the (found by: claude-opus-4.8)
Contributor
Author
There was a problem hiding this comment. Added the Windows and Mac base images. |
||
| } | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This changes the
protected virtualsignature fromColor backgroundtoBrush background. It is correctly tracked in PublicAPI with a*REMOVED*/added pair and is reasonable for the net11.0 target, but it is binary/source-breaking for subclasses that override the oldColoroverload: after this changeSetAppearancecalls theBrushoverload, so an existing override of theColoroverload silently stops being invoked. Worth confirming during API review that dropping the old overload (vs. keeping it as an[Obsolete]overload that delegates to the new one) is the intended net11 break — this is the kind of decision that pairs with the broaderShell.BackgroundAPI-design discussion on this PR.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for flagging this! Yes, this is an intentional change for .NET 11 — we've updated the signature from Color to Brush to enable gradient background support. It's properly tracked in PublicAPI.Unshipped.txt with the REMOVED/added pair. For anyone with a custom subclass overriding the old Color overload, the migration is straightforward — just update the parameter type to Brush. Happy to discuss further if there are concerns!