Port Carousel from 7.x

[Arlodotexe]

Source: Microsoft.Toolkit.Uwp.UI.Controls (7.x)
Destination: TBD (not yet determined)

Description

An ItemsControl implementation that displays items in a smooth carousel layout.

Prerequisites

None identified.

Porting Basics

• Namespace updated to CommunityToolkit.WinUI.*
• Code for UWP, WinUI3 and Uno Platform consolidated
• Desired MultiTargets configured
• Sample code migrated
• Concept docs migrated
• Tests migrated and passing

Quality Evaluation

See Porting Criteria for detailed evaluation guidance.

• UX: Accessibility reviewed
• UX: Visual design reviewed
• UX: Interaction patterns appropriate
• DX: API surface reviewed
• DX: API flexibility appropriate
• DX: Documentation updated
• MX: Breaking changes documented
• MX: Domain isolation appropriate
• MX: Test coverage adequate

Tracking Gaps

No gaps identified — porting work not yet started.

Closing

• All Porting Basics complete
• Quality Evaluation reviewed
• Gaps filed as sub-issues

---

7x Documentation Inventory

Docs ported to 8x: n/a

Docs not in 8x: All sections

7x Source Inventory

Source already ported to 8x: n/a

Source not ported to 8x: All

Notes

• Not currently planned for porting. Open to community interest.
• Technical consideration: Would require full rewrite to use ItemsRepeater API.
• Archive redirect: https://learn.microsoft.com/en-us/dotnet/communitytoolkit/windows/archive/carousel

[michael-hawker]

There was a discussion at one point to leverage the implementation from the Microsoft Store and work with their team on porting that over as we have done with other store components. However, I'm not sure how specialized their version has become.

It's still worth reaching out to @JustinXinLiu and seeing if there's something we can learn from their code though as a starting point at least.

The main new requirement which warranted a re-write over the existing control was the ability to infinitely loop around from the last image to the first (and vice-versa).

[michael-hawker]

@Arlodotexe I noticed we're missing the link to the Lab discussion for this ticket as well: CommunityToolkit/Labs-Windows#498 (we should make sure if we have any of these old threads that we bubble them up from the old WindowsCommunityToolkit repo issues/discussions, issues/discussions here, and labs.

@Avid29 saw you opened a PR, wondering if we should start in Labs first as a new component? Also, curious on your choice of sticking with an ItemsControl over ItemsRepeater? Should we continue on the discussion in a thread on the Labs discussion?

[Avid29]

@Arlodotexe I noticed we're missing the link to the Lab discussion for this ticket as well: CommunityToolkit/Labs-Windows#498 (we should make sure if we have any of these old threads that we bubble them up from the old WindowsCommunityToolkit repo issues/discussions, issues/discussions here, and labs.

@Avid29 saw you opened a PR, wondering if we should start in Labs first as a new component? Also, curious on your choice of sticking with an ItemsControl over ItemsRepeater? Should we continue on the discussion in a thread on the Labs discussion?

Sure. I opened a draft PR on this repo since I figured it's a pre-existing control and just to mark that I was getting around to it so nobody else silently starts working on it and then we're in conflict.

My plan was to begin by making a very slightly modified version of the original and then poke around at what can be done better. I suppose that's a shoo-in for a labs component, so I'll close #824 and move that over next time I get to working on it 👍

[ghost1372]

Hi @Avid29
Your work is great. I’ve been collecting and creating carousel controls from across the internet.
covering older UWP and WPF implementations and bringing them into WinUI. You can find a lot of useful code and samples here. For infinite scrolling, there are multiple available options as well.

There’s an excellent LoopingSelector control inside WinUI, but it’s marked as internal. Hopefully there’s a ported version from the Uno Platform that can be used externally.
https://github.com/unoplatform/uno/tree/master/src/Uno.UI/UI/Xaml/Controls/Primitives/LoopingSelector

Here you can see some of these examples. I hope most of these features will be included in the carousel you’re building. Also, you can find some interesting carousel design ideas here as well.

https://github.com/ghost1372/DevWinUI/tree/main/dev/DevWinUI.Controls/Controls/Win2DAndComposition/StoreCarousel

https://github.com/ghost1372/DevWinUI/tree/main/dev/DevWinUI.Controls/Controls/Native/LoopPanel

https://github.com/ghost1372/DevWinUI/tree/main/dev/DevWinUI.Controls/Controls/Win2DAndComposition/CarouselView

https://github.com/ghost1372/DevWinUI/tree/main/dev/DevWinUI.Controls/Controls/Win2DAndComposition/CarouselView2

https://github.com/ghost1372/DevWinUI/tree/main/dev/DevWinUI.Controls/Controls/Native/CoverFlow

https://github.com/ghost1372/DevWinUI/blob/main/dev/DevWinUI.Controls/Controls/Win2DAndComposition/ContentSlider.cs

https://github.com/ghost1372/DevWinUI/tree/main/dev/DevWinUI.Controls/Controls/Win2DAndComposition/EasyCarouselPanel

https://github.com/ghost1372/DevWinUI/tree/main/dev/DevWinUI.Controls/Controls/Win2DAndComposition/BannerView

https://github.com/ghost1372/DevWinUI/tree/main/dev/DevWinUI.Controls/Controls/Native/HeaderCarousel