TextBlockFX.Win2D.UWP 1.0.3

dotnet add package TextBlockFX.Win2D.UWP --version 1.0.3
                    
NuGet\Install-Package TextBlockFX.Win2D.UWP -Version 1.0.3
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="TextBlockFX.Win2D.UWP" Version="1.0.3" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="TextBlockFX.Win2D.UWP" Version="1.0.3" />
                    
Directory.Packages.props
<PackageReference Include="TextBlockFX.Win2D.UWP" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add TextBlockFX.Win2D.UWP --version 1.0.3
                    
#r "nuget: TextBlockFX.Win2D.UWP, 1.0.3"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package TextBlockFX.Win2D.UWP@1.0.3
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=TextBlockFX.Win2D.UWP&version=1.0.3
                    
Install as a Cake Addin
#tool nuget:?package=TextBlockFX.Win2D.UWP&version=1.0.3
                    
Install as a Cake Tool

TextBlockFX_Logo_Large

TextBlockFX

A TextBlock control which animates the text with customizable effects.

TextBlockFx generates difference results for attached effect to animate the text when its content changes by using its built-in diffing algorithm.

https://user-images.githubusercontent.com/8193074/147348037-efe70068-d188-4a26-a23a-c94e2b03ede9.mp4

Get Started

Install

alternate text is missing from this package README image

In Solution Explorer panel, right click on your project name and select Manage NuGet Packages. Search for TextBlockFX.Win2D.UWP then click install to install the package.

Or enter the following command in Package Manager Console to install it:

Install-Package TextBlockFX.Win2D.UWP -Version 1.0.3

Usage

In your XAML page, add a reference at the top of your page:

xmlns:tbfx="using:TextBlockFX.Win2D.UWP"
xmlns:effects="using:TextBlockFX.Win2D.UWP.Effects"

Then add TextBlockFX to your page:

<tbfx:TextBlockFX Text="Your text here">
    <tbfx:TextBlockFX.TextEffect>
        <effects:Default/>
    </tbfx:TextBlockFX.TextEffect>
</tbfx:TextBlockFX>

Built-in Effects

  • Default
  • Motion Blur
  • Blur

Supported Features

Feature UWP(Win2D) WinUI3(Win2D)
FontFamily 🚧
FontSize 🚧
FontStretch 🚧
FontStyle 🚧
FontWeight 🚧
TextAlignment 🚧
TextDirection 🚧
TextTrimming 🚧
TextWrapping 🚧

✅: Supported

🚧: WIP

TextBlockFX only support UWP projects for now. WinUI3 support and Skiasharp based implementation for other platform targets are WIP.

Write Your Own Effect

  • Define a new effect class and implement the ITextEffect interface.
  • Draw the text by using Win2D API.
Product Compatible and additional computed target framework versions.
Universal Windows Platform uap10.0.17763 is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on TextBlockFX.Win2D.UWP:

Repository Stars
FireCubeStudios/Protecc
It protecc
Version Downloads Last Updated
1.0.3 701 12/29/2021
1.0.2 340 12/25/2021
1.0.1 357 12/24/2021
1.0.0 367 12/24/2021

Please visit the github repository to view the release notes.