Skip to content

Files

Latest commit

jsuarezruizjsuarezruiz
Updated README
Oct 29, 2017
1b5aa99 · Oct 29, 2017

History

History
107 lines (71 loc) · 3.43 KB

README.md

File metadata and controls

107 lines (71 loc) · 3.43 KB

Xamanimation - Animation Library for Xamarin.Forms

Xamanimation is a portable library designed for Xamarin.Forms that aims to facilitate the use of animations to developers. Very simple use from C# and XAML code.

We can define animations in XAML to a visual element when loading through a Behavior, use a trigger in XAML to execute the animation or from C# code.

Available animations:

  • Color
  • FadeTo
  • Flip
  • Heart
  • Jump
  • Rotate
  • Scale
  • Shake
  • Translate
  • Turnstile

Installation

To install Xamanimation, run the following command in the Package Manager Console.

PM> Install-Package Xamanimation

Animation directly from XAML

One of the main advantages of the library is the possibility of using animations from XAML. We must use the following namespace:

xmlns:xamanimation="clr-namespace:Xamanimation;assembly=Xamanimation"

Let's animate a BoxView:

<BoxView
 x:Name="FadeBox"
 HeightRequest="120"
 WidthRequest="120"
 Color="Blue" />

we can define animations directly in XAML (as Application or Page Resources):

<xamanimation:FadeToAnimation
 x:Key="FadeToAnimation"
 Target="{x:Reference FadeBox}"
 Duration="2000"
 Opacity="0"/>

Using the namespace of xamanimation, we have access to the whole set of animations of the library. In all of them there are a number of common parameters such as:

  • Target: Indicate the visual element to which we will apply the animation.
  • Duration: Duration of the animation in milliseconds.

Depending on the animation type used, we will have more parameters to customize the specific animation. For example, in the case of Fade Animation we will have an Opacity property to set how we modify the opacity.

To launch the animation we have two options:

  • Trigger: Called BeginAnimation that allows us to launch an animation when a condition occurs.
  • Behavior: We have a Behavior called BeginAnimation that we can associate to a visual element so that indicating the desired animation, we can launch the same when the element load occurs.

Using the Clicked event of a button we can launch the previous animation using the trigger provided:

<Button 
 Text="Fade">
 <Button.Triggers>
  <EventTrigger Event="Clicked">
   <xamanimation:BeginAnimation
Animation="{StaticResource FadeToAnimation}" />
  </EventTrigger>
 </Button.Triggers>
</Button>

We also have the concept of Storyboard as a set of animations that we can execute over time:

<xamanimation:StoryBoard
 x:Key="StoryBoard"
 Target="{x:Reference StoryBoardBox}">
   <xamanimation:ScaleToAnimation  Scale="2"/>
   <xamanimation:ShakeAnimation />
</xamanimation:StoryBoard>

Using C#

In the same way that we can use the animations of the library from XAML, we can do it from C# code. We have an extension method called Animate that expects an instance of any of the available animations.

If we want to animate a BoxView called AnimationBox:

<BoxView
 x:Name="AnimationBox"
 HeightRequest="120"
 WidthRequest="120"
 Color="Blue" />

Access the element, use the Animate method with the desired animation:

AnimationBox.Animate(new HeartAnimation());

Feedback

Please use GitHub issues for questions or comments.

Copyright and license

Code released under the MIT license.