XamlFlair

https://github.com/xamlflair/xamlflair
Admin
The XamlFlair library eases the implementation of common animations, allowing developers to easily...
Tokens:5,770
Snippets:84
Trust Score:5.6
License:MIT
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install XamlFlair for WPF

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Execute this command in the Package Manager Console to install the XamlFlair WPF package.

```powershell
Install-Package XamlFlair.WPF
```

--------------------------------

### Install XamlFlair for Uno Platform

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Run this command in the Package Manager Console to install the XamlFlair Uno package. Note the specific UWP target version requirement for Uno.

```powershell
Install-Package XamlFlair.Uno
```

--------------------------------

### Setup Serilog Logger for XamlFlair

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Initialize XamlFlair loggers with Serilog support by creating a `LoggerFactory` and adding Serilog. This is done in the application's startup code.

```csharp
public App()
{
    this.InitializeComponent();
    .
    .
    .
    // Setup the Serilog logger
    Log.Logger = new LoggerConfiguration()
        .MinimumLevel.Debug()
        .WriteTo.Debug()
        .CreateLogger();

    // Initalie the XamlFlair loggers using the LoggerFactory (with Serilog support)
	XamlFlair.Animations.InitializeLoggers(new LoggerFactory().AddSerilog());
}
```

--------------------------------

### Install XamlFlair for UWP

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Use this command in the Package Manager Console to install the XamlFlair UWP package. Ensure your app targets Windows 10 version 1809 (build 17763) or later.

```powershell
Install-Package XamlFlair.UWP
```

--------------------------------

### Log Animation Details

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Set `xf:Animations.EnableLogging` to `Debug` on a `FrameworkElement` to output details of animations, such as duration, delay, and offsets. This provides console output similar to the example.

```xml
<Rectangle xf:Animations.EnableLogging="Debug"
           xf:Animations.Primary="{StaticResource SlideFromLeft}" />
```

--------------------------------

### Repeat Animation 5 Times

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Use IterationCount to specify the number of times an animation should repeat. This example runs the FadeIn animation 5 times.

```xml
<Border xf:Animations.Primary="{StaticResource FadeIn}"
        xf:Animations.IterationCount="5" />
```

--------------------------------

### Set Initial State with StartWith Property

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Use the StartWith property to define the initial state of a UI element before an animation begins, especially when the animation has a delay. This ensures the element is in the correct visual state from the start.

```xml
<Rectangle xf:Animations.Primary="{xf:Animate BasedOn={StaticResource ScaleFromBottom}, Delay=500}"
           xf:Animations.StartWith="{StaticResource ScaleFromBottom}" />
```

--------------------------------

### Trigger Animation on Button Click

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Use the 'Event' property to specify which element event triggers an animation. This example triggers a FadeOut animation when a Button is clicked.

```xml
<Button xf:Animations.Primary="{xf:Animate BasedOn={StaticResource FadeOut}, Event=Click}" />
```

--------------------------------

### Repeat Animation Indefinitely

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Set IterationBehavior to 'Forever' to make an animation repeat endlessly. This example uses the FadeIn animation.

```xml
<Border xf:Animations.Primary="{StaticResource FadeIn}"
        xf:Animations.IterationBehavior="Forever" />
```

--------------------------------

### Repeat Compound Animation 5 Times

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Compound animations can also be repeated using IterationCount. This example repeats a compound animation named 'Progress' 5 times.

```xml
<Border xf:Animations.Primary="{StaticResource Progress}"
        xf:Animations.IterationCount="5" />
```

--------------------------------

### Stop Repeating Animation with Binding

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Repeating animations can be stopped by binding the PrimaryBinding property to a boolean value. When the binding evaluates to false, the current iteration completes and the animation stops. This example uses a CheckBox's IsChecked state.

```xml
<CheckBox x:Name="SampleCheckBox"
          IsChecked="False" />

<Rectangle xf:Animations.PrimaryBinding="{Binding IsChecked, ElementName=SampleCheckBox}"
           xf:Animations.Primary="{xf:Animate BasedOn={StaticResource FadeIn}, Event=None}" />
```

--------------------------------

### Loading Assets with Typeface.CreateFromAsset

Source: https://github.com/xamlflair/xamlflair/blob/master/Samples/Uno/XamlFlair.Samples.Uno.Droid/Assets/AboutAssets.txt

Shows how to load a font file from the application's assets using Typeface.CreateFromAsset.

```C#
Typeface tf = Typeface.CreateFromAsset (Context.Assets, "fonts/samplefont.ttf");
```

--------------------------------

### Accessing Raw Assets with AssetManager

Source: https://github.com/xamlflair/xamlflair/blob/master/Samples/Uno/XamlFlair.Samples.Uno.Droid/Assets/AboutAssets.txt

Demonstrates how to open and read a raw asset file using Android's AssetManager in an Uno Platform Android Activity.

```C#
public class ReadAsset : Activity
{
	protected override void OnCreate (Bundle bundle)
	{
		base.OnCreate (bundle);

		InputStream input = Assets.Open ("my_asset.txt");
	}
}
```

--------------------------------

### Combined Fade and Grow Animation Settings

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Defines settings for a combined FadeFrom, ScaleXFrom, and ScaleYFrom animation. Requires ScaleX and ScaleY to be defined.

```xml
<xf:AnimationSettings x:Key="FadeInAndGrow"
                          Kind="FadeFrom,ScaleXFrom,ScaleXFrom"
                          Opacity="0"
                          ScaleX="{StaticResource SmallScaleFactor}"
                          ScaleY="{StaticResource SmallScaleFactor}" />
```

--------------------------------

### Combined Fade and Horizontal Grow Animation Settings

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Defines settings for a combined FadeFrom and ScaleXFrom animation. Requires ScaleX to be defined.

```xml
<xf:AnimationSettings x:Key="FadeInAndGrowHorizontally"
                          Kind="FadeFrom,ScaleXFrom"
                          Opacity="0"
                          ScaleX="{StaticResource SmallScaleFactor}" />
```

--------------------------------

### Combined Fade and Slide Animation Settings

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Defines settings for a combined FadeFrom and TranslateXFrom animation. Requires OffsetX to be defined.

```xml
<xf:AnimationSettings x:Key="FadeInAndSlideFromLeft"
                          Kind="FadeFrom,TranslateXFrom"
                          Opacity="0"
                          OffsetX="{StaticResource NegativeOffset}" />
```

--------------------------------

### Applying Perspective Rotation to an Element

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Demonstrates how to apply a perspective rotation to a Rectangle by wrapping it in a Border element.

```xml
<Border Width="200"
        Height="200"
        HorizontalAlignment="Center"
        VerticalAlignment="Center">
    <Rectangle Fill="RoyalBlue"
           xf:Animations.Primary="{StaticResource PerspectiveVerticalRotation}" />
</Border>
```

--------------------------------

### Alternative Default Animations Reference (WPF)

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

An alternative method to include default XamlFlair animations in WPF applications using a pack URI. This is useful if Intellisense does not work with the XamlFlairResources tag.

```xml
<Application.Resources>
        <ResourceDictionary>
            <ResourceDictionary.MergedDictionaries>
                <ResourceDictionary Source="pack://application:,,,/XamlFlair.WPF;component/DefaultAnimations.xaml"/>
            </ResourceDictionary.MergedDictionaries>
        </ResourceDictionary>
    </Application.Resources>
```

--------------------------------

### Combined Fade and Vertical Slide Animation Settings

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Defines settings for a combined FadeFrom and TranslateYFrom animation. Requires OffsetY to be defined.

```xml
<xf:AnimationSettings x:Key="FadeInAndSlideFromTop"
                          Kind="FadeFrom,TranslateYFrom"
                          Opacity="0"
                          OffsetY="{StaticResource NegativeOffset}" />
```

--------------------------------

### Custom Animation Settings in ResourceDictionary

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Define common animations using AnimationSettings in a ResourceDictionary for reuse across the application. This consolidates animation definitions for clarity and maintainability.

```xml
<ResourceDictionary xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
                    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
                    xmlns:xf="using:XamlFlair">

    <x:Double x:Key="PositiveOffset">50</x:Double>
    <x:Double x:Key="NegativeOffset">-50</x:Double>
    <x:Double x:Key="SmallScaleFactor">0.75</x:Double>
    <x:Double x:Key="LargeScaleFactor">1.25</x:Double>

    <xf:AnimationSettings x:Key="FadeIn"
                          Kind="FadeFrom"
                          Opacity="0" />

    <xf:AnimationSettings x:Key="FadeOut"
                          Kind="FadeTo"
                          Opacity="0" />

    <!-- Scale to a larger value -->
    <xf:AnimationSettings x:Key="Expand"
                          Kind="ScaleXTo,ScaleYTo"
                          ScaleX="{StaticResource LargeScaleFactor}"
                          ScaleY="{StaticResource LargeScaleFactor}" />

    <!-- Scale from a larger value -->
    <xf:AnimationSettings x:Key="Contract"
                          Kind="ScaleXFrom,ScaleYFrom"
                          ScaleX="{StaticResource LargeScaleFactor}"
                          ScaleY="{StaticResource LargeScaleFactor}" />
    .
    .
    .
    </ResourceDictionary>
```

--------------------------------

### UWP and Uno Namespace Declaration

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Declare the XamlFlair.Controls namespace for UWP and Uno projects.

```xml
xmlns:xfc="using:XamlFlair.Controls"
```

--------------------------------

### Execute Command on Animation Completion

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Use PrimaryCompletionCommand to execute an ICommand when the primary animation finishes. This is useful for chaining actions after an animation.

```xml
<TextBlock Text="Example of a completion command"
           xf:Animations.Primary="{StaticResource FadeInAndSlideFromBottom}"
           xf:Animations.PrimaryCompletionCommand="{x:Bind MyCustomCommand}" />
```

--------------------------------

### Using Default Animations in App.xaml (WPF)

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Reference XamlFlair's default animations in WPF applications by including XamlFlairResources in the Application Resources. This provides a set of pre-configured animations.

```xml
    xmlns:xf="clr-namespace:XamlFlair;assembly=XamlFlair.WPF"
```

2. Update your Application Resources:

```xml
    <Application.Resources>
        <ResourceDictionary>
            <ResourceDictionary.MergedDictionaries>
                <xf:XamlFlairResources />
            </ResourceDictionary.MergedDictionaries>
        </ResourceDictionary>
    </Application.Resources>
```

--------------------------------

### Compound Animation Sequence Definition

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Defines a sequential animation using CompoundSettings, executing multiple AnimationSettings in order. Each step has a specified duration.

```xml
<xf:CompoundSettings x:Key="Compound">
    <xf:CompoundSettings.Sequence>
        <xf:AnimationSettings Kind="ScaleXTo"
                              ScaleX="1.25"
                              Duration="1250" />
        <xf:AnimationSettings Kind="ScaleXTo"
                              ScaleX="1"
                              Duration="1250" />
        <xf:AnimationSettings Kind="RotateTo"
                              Rotation="360"
                              Duration="1250" />
    </xf:CompoundSettings.Sequence>
</xf:CompoundSettings>
```

--------------------------------

### Enable Animation Debugging

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Set `xf:Animations.EnableDebugging` to `InitializeElement` to break the debugger in the `InitializeElement` function of XamlFlair. This requires the SourceLink library.

```xml
<Rectangle xf:Animations.EnableDebugging="InitializeElement"
           xf:Animations.Primary="{StaticResource SlideFromLeft}" />
```

--------------------------------

### Perspective Vertical Rotation Animation Settings

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Defines settings for a vertical perspective rotation (SwivelY). This should be applied to a container element.

```xml
<xf:AnimationSettings x:Key="PerspectiveVerticalRotation"
                      Kind="SwivelYFrom"
                      SwivelY="-45" />
```

--------------------------------

### Define and Apply Color Animation

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Define a color animation using AnimationSettings and apply it to a Rectangle's Fill property. Ensure the target property has a brush set.

```xml
<xf:AnimationSettings x:Key="SampleColorAnimation"
                      Kind="ColorTo"
                      Color="DarkGreen"
                      ColorOn="Fill" />

<Rectangle Fill="RoyalBlue"
           xf:Animations.Primary="{StaticResource SampleColorAnimation}" />
```

--------------------------------

### Trigger List Item Animations with Binding

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Trigger item animations using a binding with the ItemsBinding property, in conjunction with disabling default load animations.

```xml
<xfc:AnimatedListView ItemsSource="Binding SampleDataList"
                      xf:Animations.AnimateOnLoad="False"
                      xf:Animations.ItemsBinding="{Binding MyViewModelProperty}"
                      xf:Animations:Items="{xf:Animate BasedOn={StaticResource FadeIn}}" />
```

--------------------------------

### Apply Primary Animation to FrameworkElement

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Apply a XamlFlair animation to any FrameworkElement using the Animations.Primary attached property.

```xml
<Border xf:Animations.Primary="{StaticResource FadeIn}" />
```

--------------------------------

### Log Active Timelines

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Set `Animations.EnableActiveTimelinesLogging` to `LogLevel.Debug` in your app startup code to log the status and completion of active animation timelines. This provides detailed console output about timeline events.

```csharp
Animations.EnableActiveTimelinesLogging = LogLevel.Debug;
```

--------------------------------

### Merging Custom ResourceDictionary in App.xaml

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Include a custom ResourceDictionary containing animations into the application's resources by merging it in App.xaml. This makes all defined animations globally accessible.

```xml
<Application.Resources>
        <ResourceDictionary>
            <ResourceDictionary.MergedDictionaries>
                <ResourceDictionary Source="Animations.xaml" />
            </ResourceDictionary.MergedDictionaries>
        </ResourceDictionary>
    </Application.Resources>
```

--------------------------------

### Override Global Default Animation Settings

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Customize default animation parameters like duration and easing globally by calling OverrideDefaultSettings in your app's initialization code.

```csharp
XamlFlair.Animations.OverrideDefaultSettings(
    duration: 750,
    easing: EasingType.Quadratic);

```

--------------------------------

### Add XamlFlair Namespace Reference

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Include the XamlFlair namespace in your XAML for UWP, Uno, or WPF projects.

```xml
xmlns:xf="using:XamlFlair"
```

```xml
xmlns:xf="clr-namespace:XamlFlair;assembly=XamlFlair.WPF"
```

--------------------------------

### WPF Namespace Declaration

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Declare the XamlFlair.Controls namespace for WPF projects.

```xml
xmlns:xfc="clr-namespace:XamlFlair.Controls;assembly=XamlFlair.WPF"
```

--------------------------------

### Invalid Item Animation Configuration

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

This configuration is invalid because the Event property cannot be changed from its default value for list item animations.

```xml
<xfc:AnimatedListView ItemsSource="Binding SampleDataList"
                      xf:Animations:Items="{xf:Animate BasedOn={StaticResource FadeIn}, Event=Visibility}" />
```

--------------------------------

### Clip Child Content to Bounds

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Use the `xf:Layout.ClipToBounds` property to clip child content to the bounds of the containing element. This is useful for UWP and Uno platforms.

```xml
<Border xf:Layout.ClipToBounds="True">
.
.
.
<Border>
```

--------------------------------

### Relative Translation with Star-Based Values

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Uses star-based values for OffsetX to enable relative translations based on the element's ActualWidth. Ensure the element has loaded.

```xml
<Border xf:Animations.Primary="{xf:Animate BasedOn={StaticResource SlideFromLeft}, OffsetX=1.5*}" />
```

--------------------------------

### Overriding Animation Settings with Animate Markup Extension

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Overrides animation settings, such as Delay, directly on a FrameworkElement using the Animate markup extension.

```xml
<Border xf:Animations.Primary="{xf:Animate BasedOn={StaticResource ScaleFromBottom}, Delay=500}" />
```

--------------------------------

### Generated R Class for Android Resources

Source: https://github.com/xamlflair/xamlflair/blob/master/Samples/Uno/XamlFlair.Samples.Uno.Droid/Resources/AboutResources.txt

This C# code represents the structure of the generated 'R' class, which contains resource IDs for various resource types like drawables, layouts, and strings. It is automatically created by the Android build system.

```csharp
public class R {
    public class drawable {
        public const int icon = 0x123;
    }

    public class layout {
        public const int main = 0x456;
    }

    public class strings {
        public const int first_string = 0xabc;
        public const int second_string = 0xbcd;
    }
}
```

--------------------------------

### Customize Item Animation Delay

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Adjust the delay between animating individual list items using the InterElementDelay property. The default is 25 milliseconds.

```xml
<xfc:AnimatedListView ItemsSource="Binding SampleDataList"
                      xf:Animations.InterElementDelay="50"
                      ... />
```

--------------------------------

### Using TransformOn Property for Animations (WPF)

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Specify whether an animation should apply to the RenderTransform or LayoutTransform using the TransformOn property. The default value is 'Render'. Note that LayoutTransform does not support TranslateTransform in WPF.

```xml
<xf:Animation Settings ... TransformOn="Layout" />
```

--------------------------------

### Control Opacity Reset Behavior

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Set AllowOpacityReset to False to prevent the opacity animation from resetting its value unexpectedly. The default value is True, which might cause issues in certain scenarios.

```xml
<Image xf:Animations.Primary="{StaticResource FadeInThenFadeOut}"
       xf:Animations.AllowOpacityReset="False"
       Source="/Assets/..." />
```

--------------------------------

### Trigger Animation with CombinedBinding

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Use CombinedBinding to simplify using both PrimaryBinding and SecondaryBinding with the same boolean value. It internally handles inverse boolean logic, eliminating the need for a converter.

```xml
<CheckBox x:Name="SampleCheckBox"
          IsChecked="False" />

<Rectangle xf:Animations.CombinedBinding="{Binding IsChecked, ElementName=SampleCheckBox}"
           xf:Animations.Primary="{xf:Animate BasedOn={StaticResource FadeIn}, Event=None}"
           xf:Animations.Secondary="{xf:Animate BasedOn={StaticResource FadeOut}, Event=None}"
           xf:Animations.StartWith="{StaticResource FadeOut}" />
```

--------------------------------

### Disable Default List Item Animation Triggers

Source: https://github.com/xamlflair/xamlflair/blob/master/README.md

Use AnimateOnLoad="False" to disable animations on item load, or AnimateOnItemsSourceChange="False" to disable animations when the ItemsSource property updates.

```xml
<xfc:AnimatedListView ItemsSource="Binding SampleDataList"
                      xf:Animations.AnimateOnLoad="False"
                      ... />
```

```xml
<xfc:AnimatedListView ItemsSource="Binding SampleDataList"
                      xf:Animations.AnimateOnItemsSourceChange="False"
                      ... />
```
Tokens:
Raw