🧪 [Experiment] TransitionHelper

[michael-hawker]

Port of PR CommunityToolkit/WindowsCommunityToolkit#4338
Discussion: #353

This PR brings over @HHChaos's TransitionHelper component from the Main Toolkit into labs. It's a set of helpers for morphing controls between one another on the same page, see example here (speaks better than words):

LabsTransitionHelper.mp4

Only setup for UWP/WinAppSDK. Uses Composition APIs, so not going to work on Uno Platform atm.

TODO

• Migrate after Cleanup project folder structure to reduce chance of hitting MAX_PATH #344
• Check if any code remaining in any private branch to port over
• WinAppSDK: Image is disappearing when transitioning... can't debug at moment as Visual Tree tool not working in VS...? (Fixed for now with a static resource, suspect an issue in the WindowsAppSDK with loading ImageBrush for non-visible elements, need to create a minimal repro.) - External, see Image not always showing from ImageBrush; resetting screen scale makes it appear microsoft/microsoft-ui-xaml#7809 (comment)
• Add smaller/simpler samples and more docs

[michael-hawker]

Error from CI:

"D:\a\Labs-Windows\Labs-Windows\labs\TransitionHelper\src\CommunityToolkit.Labs.WinUI.TransitionHelper.csproj" (default target) (16:31) ->
  D:\a\Labs-Windows\Labs-Windows\labs\TransitionHelper\src\TransitionHelper.Animation.cs(30,29): error CA1001: Type 'TransitionHelper' owns disposable field(s) '_currentAnimationCancellationTokenSource' but is not disposable [D:\a\Labs-Windows\Labs-Windows\labs\TransitionHelper\src\CommunityToolkit.Labs.WinUI.TransitionHelper.csproj]

Will have to investigate what this is and what this means to fix.

[michael-hawker]

Found and added explicit details on what we saw in the WindowsAppSDK with ImageBrush on the WinUI repo here: microsoft/microsoft-ui-xaml#7809 (comment)

[michael-hawker]

CI issue, this was here before migration:

 D:\a\Labs-Windows\Labs-Windows\components\TransitionHelper\src\TransitionHelper.Animation.cs(30,29): error CA1001: Type 'TransitionHelper' owns disposable field(s) '_currentAnimationCancellationTokenSource' but is not disposable [D:\a\Labs-Windows\Labs-Windows\components\TransitionHelper\src\CommunityToolkit.Labs.WinUI.TransitionHelper.csproj]

Also need the single project head to not copy over the wasm head (we should probably try and auto-detect this)

[michael-hawker]

@niels9001 @Arlodotexe should be rebased and ready to go now, filed an issue for the disposable problem and added to ignore for project, so hopefully should build now.

Let's get it in, and then @niels9001 you can add a smaller sample later after?

[michael-hawker]

I'm confused as to why this didn't work...

  D:\a\Labs-Windows\Labs-Windows\components\TransitionHelper\src\TransitionHelper.Animation.cs(30,29): error CA1001: Type 'TransitionHelper' owns disposable field(s) '_currentAnimationCancellationTokenSource' but is not disposable [D:\a\Labs-Windows\Labs-Windows\components\TransitionHelper\src\CommunityToolkit.Labs.WinUI.TransitionHelper.csproj]

@Arlodotexe any thoughts?

I did it here as the CI flags it in the partial TransitionHelper.Animation.cs file, but locally it flags it on the TransitionHelper.Logic.cs file... 😟

[Arlodotexe]

Maybe try <NoWarn>$(NoWarn);CA1001</NoWarn>? Could be overwritten in another place as well.

[michael-hawker]

@Arlodotexe just looked, we have a bunch of places in the Tooling props which aren't doing this:

I'll test here if this resolves this issue, but may need a PR on the tooling for this too then.

[michael-hawker]

Ah, didn't realize this PR wasn't updated still with the tooling module change, pushed a test up since it's all in the same branch, if that resolves, I'll copy them over to the tooling submodule, get that updated, and then update this PR to use that before we merge.

[michael-hawker]

Ugh, won't run with merge conflict, pushed to this repo so I could run action independently for now here: https://github.com/CommunityToolkit/Labs-Windows/actions/runs/4546660046

[michael-hawker]

Hmm, getting some error about the Owl image from the Shimmer experiment... that's weird.

"D:\a\Labs-Windows\Labs-Windows\CommunityToolkit.AllComponents.sln" (default target) (1:2) ->
"D:\a\Labs-Windows\Labs-Windows\tooling\ProjectHeads\AllComponents\Tests.WinAppSdk\CommunityToolkit.Tests.WinAppSdk.csproj" (default target) (27:6) ->
(_HandleFileConflictsForPublish target) -> 
  C:\Program Files\dotnet\sdk\6.0.407\Sdks\Microsoft.NET.Sdk\targets\Microsoft.NET.ConflictResolution.targets(112,5): error NETSDK1152: Found multiple publish output files with the same relative path: D:\a\Labs-Windows\Labs-Windows\components\Shimmer\samples\Assets\Owl.jpg, D:\a\Labs-Windows\Labs-Windows\components\TransitionHelper\samples\Assets\Owl.jpg. [D:\a\Labs-Windows\Labs-Windows\tooling\ProjectHeads\AllComponents\Tests.WinAppSdk\CommunityToolkit.Tests.WinAppSdk.csproj]


"D:\a\Labs-Windows\Labs-Windows\CommunityToolkit.AllComponents.sln" (default target) (1:2) ->
"D:\a\Labs-Windows\Labs-Windows\tooling\ProjectHeads\AllComponents\WinAppSdk\CommunityToolkit.App.WinAppSdk.csproj" (default target) (29:6) ->
  C:\Program Files\dotnet\sdk\6.0.407\Sdks\Microsoft.NET.Sdk\targets\Microsoft.NET.ConflictResolution.targets(112,5): error NETSDK1152: Found multiple publish output files with the same relative path: D:\a\Labs-Windows\Labs-Windows\components\Shimmer\samples\Assets\Owl.jpg, D:\a\Labs-Windows\Labs-Windows\components\TransitionHelper\samples\Assets\Owl.jpg. [D:\a\Labs-Windows\Labs-Windows\tooling\ProjectHeads\AllComponents\WinAppSdk\CommunityToolkit.App.WinAppSdk.csproj]

But I think that means that warning thing helped, so will open a tooling PR for that, so we can update this one on top of the latest main.

[michael-hawker]

Submodule first step here: CommunityToolkit/Tooling-Windows-Submodule#38

[michael-hawker]

Figured out what the issue is, filed CommunityToolkit/Tooling-Windows-Submodule#40 for tracking. Will work-around the issue for now and rebuild.