[Android] Added Platform specific ripple color by kubaflo · Pull Request #23599 · dotnet/maui

kubaflo · 2024-07-13T17:41:56Z

Description of Change

Right now the only way to set a ripple color for buttons is to use custom mappers or platform specific code. But, for image buttons there is currently no way to do anything.

Public API Changes

<Button 
   xmlns:android="clr-namespace:Microsoft.Maui.Controls.PlatformConfiguration.AndroidSpecific;assembly=Microsoft.Maui.Controls"
   android:Button.RippleColor="Green"/>

<ImageButton 
   xmlns:android="clr-namespace:Microsoft.Maui.Controls.PlatformConfiguration.AndroidSpecific;assembly=Microsoft.Maui.Controls"
   android:ImageButton.RippleColor="Green"/>

Fixes #22805

Screen.Recording.2024-07-13.at.19.17.11.mov

Notes

I will remove the pragma warning disable RS0016 if this PR makes sense

jfversluis · 2024-12-06T15:14:40Z

@kubaflo could you rebase this one please? Thanks!

azure-pipelines · 2024-12-06T19:21:16Z

Azure Pipelines successfully started running 3 pipeline(s).

mattleibow

Unless someone does not like this feature, I think it is great.

I added a few comments, but it seems like all the bits are there. This will need to all be internal and then made public in net10 or in a SR if we are allowed to.

Alos, no idea how to test this because it is an OS animation... Msybe a device test that sets the ripple then background and/or border (and in reverse) and just read the derawable.

src/Controls/src/Core/ImageButton/ImageButton.Mapper.cs

src/Core/src/Platform/Android/ButtonExtensions.cs

src/Core/src/Platform/Android/ImageButtonExtensions.cs

src/Controls/src/Core/Button/Button.Mapper.cs

src/Controls/src/Core/ImageButton/ImageButton.Mapper.cs

src/Controls/src/Core/PlatformConfiguration/AndroidSpecific/ImageButton.cs

src/Controls/src/Core/Button/Button.Android.cs

src/Core/src/Platform/Android/ButtonExtensions.cs

src/Core/src/Platform/Android/ImageButtonExtensions.cs

mattleibow · 2025-01-28T14:23:08Z

I wonder if this should be targeted at net10.0 instead?

kubaflo · 2025-02-02T17:14:05Z

I wonder if this should be targeted at net10.0 instead?

Hmmm that's a good question

kubaflo · 2025-02-03T11:31:50Z

@mattleibow I think I've resolved comments :)

azure-pipelines · 2025-04-11T07:01:09Z

Azure Pipelines successfully started running 3 pipeline(s).

jsuarezruiz

Could include some tests in the DeviceTest project just using the Platform Specific and checking the RippleDrawable color?

kubaflo · 2025-04-14T23:32:36Z

Could include some tests in the DeviceTest project just using the Platform Specific and checking the RippleDrawable color?

I'm not quite sure how to do it

jsuarezruiz · 2025-04-15T13:07:27Z

Could include some tests in the DeviceTest project just using the Platform Specific and checking the RippleDrawable color?

I'm not quite sure how to do it

You need to add a test in this class

maui/src/Controls/tests/DeviceTests/Elements/Button/ButtonTests.Android.cs

Line 15 in 8e875b7

public partial class ButtonTests

Something like:

[Fact]
[Description("The RippleColor property of a Button Platform Specific should match with native RippleDrawable Color")]
public async Task RippleColorPlatformSpecific()

Define the button with the added Platform Specific:

var expected = Colors.Red;

var button = new Button();
button.On<Controls.PlatformConfiguration.Android>().SetRippleColor(expected);

And then, create a method to get the RippleDrawable Color, to compare it using an Assert.Equal. To get the color, will require to use reflection:

int? GetRippleDrawableColor(Android.Views.View button)
{
	if (button.Background is RippleDrawable rippleDrawable)
	{
		var constantState = rippleDrawable.GetConstantState();

		if (constantState is not null)
		{
			var colorField = constantState.GetType().GetField("mColor", BindingFlags.NonPublic | BindingFlags.Instance);

			if (colorField is not null)
			{
				var colorStateList = colorField.GetValue(constantState) as ColorStateList;
				return colorStateList?.DefaultColor;
			}
		}
	}

	return null;
}

Finally, just launch the test runner App on an Android device our emulator and run the test.

Ok, I let you explore to add it, but just let me know if need help or if want myself adding some tests.

kubaflo · 2025-04-16T18:19:23Z

@jsuarezruiz I've added a test, but I had to modify your solution a bit because this always returned null:
var colorField = constantState.GetType().GetField("mColor", BindingFlags.NonPublic | BindingFlags.Instance);

jsuarezruiz

Requires some small changes to fix the build:

C:\a\_work\1\s\src\Core\src\Platform\Android\ImageButtonExtensions.cs(87,43): error CS0234: The type or namespace name 'Graphics' does not exist in the namespace 'Microsoft.Android' (are you missing an assembly reference?) [C:\a\_work\1\s\src\Core\src\Core.csproj::TargetFramework=net10.0-android36.0]
C:\a\_work\1\s\src\Core\src\Platform\Android\ImageButtonExtensions.cs(91,22): error CS0234: The type or namespace name 'Content' does not exist in the namespace 'Microsoft.Android' (are you missing an assembly reference?) [C:\a\_work\1\s\src\Core\src\Core.csproj::TargetFramework=net10.0-android36.0]
C:\a\_work\1\s\src\Core\src\Platform\Android\ButtonExtensions.cs(94,43): error CS0234: The type or namespace name 'Graphics' does not exist in the namespace 'Microsoft.Android' (are you missing an assembly reference?) [C:\a\_work\1\s\src\Core\src\Core.csproj::TargetFramework=net10.0-android36.0]
C:\a\_work\1\s\src\Core\src\Platform\Android\ButtonExtensions.cs(98,22): error CS0234: The type or namespace name 'Content' does not exist in the namespace 'Microsoft.Android' (are you missing an assembly reference?) [C:\a\_work\1\s\src\Core\src\Core.csproj::TargetFramework=net10.0-android36.0]
    4 Error(s)

rmarinho · 2025-04-22T11:38:03Z

/azp run

azure-pipelines · 2025-04-22T11:38:27Z

Azure Pipelines successfully started running 3 pipeline(s).

jsuarezruiz

LGTM, just added a comment about a detail in the added device test.

jsuarezruiz · 2025-04-23T10:32:11Z

src/Controls/tests/DeviceTests/Elements/Button/ButtonTests.Android.cs

+			if (platformButton.Background is global::Android.Graphics.Drawables.RippleDrawable rippleDrawable)
+			{
+				var constantState = rippleDrawable.GetConstantState();
+				if (constantState is not null)


Here can just check constantState:

Assert.NotNull(constantState);

dotnet-policy-service bot added the community ✨ Community Contribution label Jul 13, 2024

kubaflo force-pushed the platform-specific-ripple-color branch from cd2974d to d908f2c Compare July 13, 2024 17:44

kubaflo added proposal/open area-controls-button Button, ImageButton labels Jul 13, 2024

kubaflo changed the title ~~[Android] Added Platform specific ripple color~~ [net9.0][Enhancement][Android] Added Platform specific ripple color Jul 14, 2024

kubaflo marked this pull request as ready for review September 7, 2024 10:58

kubaflo requested a review from a team as a code owner September 7, 2024 10:58

kubaflo requested review from StephaneDelcroix and jsuarezruiz September 7, 2024 10:58

kubaflo mentioned this pull request Sep 9, 2024

[iOS] Add a done button to text fields #24645

Merged

kubaflo changed the base branch from net9.0 to main October 18, 2024 23:08

This comment was marked as outdated.

Sign in to view

AlleSchonWeg mentioned this pull request Nov 8, 2024

It takes far too long for pull requests to be merged! #25747

Closed

This comment was marked as off-topic.

Sign in to view

kubaflo force-pushed the platform-specific-ripple-color branch from 2afa9af to 24c62fb Compare December 6, 2024 18:59

mattleibow requested changes Jan 28, 2025

View reviewed changes

kubaflo force-pushed the platform-specific-ripple-color branch from 24c62fb to 402d27c Compare February 3, 2025 11:29

kubaflo force-pushed the platform-specific-ripple-color branch from 402d27c to ee9df74 Compare February 3, 2025 11:45

kubaflo changed the title ~~[net9.0][Enhancement][Android] Added Platform specific ripple color~~ [Android] Added Platform specific ripple color Mar 12, 2025

kubaflo force-pushed the platform-specific-ripple-color branch from ee9df74 to d2a109e Compare March 12, 2025 14:16

kubaflo self-assigned this Mar 12, 2025

This comment was marked as off-topic.

Sign in to view

jfversluis self-assigned this Apr 7, 2025

jfversluis added this to the .NET 10.0-preview4 milestone Apr 7, 2025

kubaflo force-pushed the platform-specific-ripple-color branch from d2a109e to 9837377 Compare April 7, 2025 16:16

kubaflo dismissed rmarinho’s stale review via c4f77f4 April 11, 2025 00:17

kubaflo force-pushed the platform-specific-ripple-color branch from c4f77f4 to be91cea Compare April 11, 2025 00:26

jfversluis requested review from jsuarezruiz, mattleibow and rmarinho April 11, 2025 13:20

jsuarezruiz suggested changes Apr 14, 2025

View reviewed changes

[Android] Added a platform specific for ripple color

7254409

Added a device test

ebae55e

kubaflo force-pushed the platform-specific-ripple-color branch from be91cea to ebae55e Compare April 16, 2025 18:17

Merge branch 'net10.0' into platform-specific-ripple-color

cdefdd7

rmarinho previously approved these changes Apr 21, 2025

View reviewed changes

jsuarezruiz suggested changes Apr 22, 2025

View reviewed changes

[android] Add global qualified namespace

1c31090

rmarinho dismissed their stale review via 1c31090 April 22, 2025 11:08

rmarinho added 2 commits April 22, 2025 12:08

Merge branch 'net10.0' into platform-specific-ripple-color

8b967b9

[build] Fix another namespace

48eaf50

dotnet deleted a comment from azure-pipelines bot Apr 22, 2025

rmarinho approved these changes Apr 22, 2025

View reviewed changes

rmarinho requested a review from jsuarezruiz April 23, 2025 10:23

jsuarezruiz approved these changes Apr 23, 2025

View reviewed changes

rmarinho merged commit aa62228 into dotnet:net10.0 Apr 29, 2025
127 of 129 checks passed

github-actions bot locked and limited conversation to collaborators May 30, 2025

Conversation

kubaflo commented Jul 13, 2024

Description of Change

Public API Changes

Notes

Uh oh!

This comment was marked as outdated.

This comment was marked as off-topic.

jfversluis commented Dec 6, 2024

Uh oh!

azure-pipelines bot commented Dec 6, 2024

Uh oh!

mattleibow left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mattleibow commented Jan 28, 2025

Uh oh!

kubaflo commented Feb 2, 2025

Uh oh!

kubaflo commented Feb 3, 2025

Uh oh!

This comment was marked as off-topic.

azure-pipelines bot commented Apr 11, 2025

Uh oh!

jsuarezruiz left a comment

Choose a reason for hiding this comment

Uh oh!

kubaflo commented Apr 14, 2025

Uh oh!

jsuarezruiz commented Apr 15, 2025

Uh oh!

kubaflo commented Apr 16, 2025

Uh oh!

jsuarezruiz left a comment

Choose a reason for hiding this comment

Uh oh!

rmarinho commented Apr 22, 2025

Uh oh!

azure-pipelines bot commented Apr 22, 2025

Uh oh!

jsuarezruiz left a comment

Choose a reason for hiding this comment

Uh oh!

jsuarezruiz Apr 23, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants