Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The ColorAnimationExtensions provide a series of extension methods that support animating the Color related properties of a VisualElement.
The ColorAnimationExtensions can be found under the CommunityToolkit.Maui.Extensions namespace so just add the following line to get started:
using CommunityToolkit.Maui.Extensions;
BackgroundColorTo
The BackgroundColorTo method allows you to animate the BackgroundColor change of a VisualElement.
Syntax
The following example shows how to animate the BackgroundColor from Colors.White to Colors.Red for a Label:
using CommunityToolkit.Maui.Extensions;
var label = new Label
{
BackgroundColor = Colors.White
};
await label.BackgroundColorTo(Colors.Red);
The full argument list for the BackgroundColorTo method is:
color, of typeColor, is the target color to animate theVisualElement'sBackgroundColorto.rate, of typeuint, is the time, in milliseconds, between the frames of the animation. This is an optional argument, whose default value is 16.length, of typeuint, is the duration, in milliseconds, of the animation. This is an optional argument, whose default value is 250.easing, of typeEasing, is the easing function to be used in the animation. This is an optional argument, whose default value isnull.
TextColorTo
The TextColorTo method allows you to animate the TextColor change of an ITextStyle implementation.
using CommunityToolkit.Maui.Extensions;
var label = new Label
{
TextColor = Colors.Green
};
await label.TextColorTo(Colors.Red);
The full argument list for the TextColorTo method is:
color, of typeColor, is the target color to animate theVisualElement'sBackgroundColorto.rate, of typeuint, is the time, in milliseconds, between the frames of the animation. This is an optional argument, whose default value is 16.length, of typeuint, is the duration, in milliseconds, of the animation. This is an optional argument, whose default value is 250.easing, of typeEasing, is the easing function to be used in the animation. This is an optional argument, whose default value isnull.
Note
The TextColorTo method is generated at compilation time through the use of Source Generators. This is due to the fact that ITextStyle.TextColor is readonly.
You can find the source code for the Source Generator on our .NET MAUI Community Toolkit GitHub repository
Examples
You can find an example of this extension in action in the .NET MAUI Community Toolkit Sample Application.
API
You can find the source code for ColorAnimationExtensions over on the .NET MAUI Community Toolkit GitHub repository.
.NET MAUI Community Toolkit