Port (Framework)Extensions

[niels9001]

TODO

Base Porting Checklist

Preview Give feedback

1. Component/package name (CommunityToolkit.WinUI.Extensions)
2. Namespace CommunityToolkit.WinUI
3. Merge differences from UWP main to WinAppSDK / Uno forks
4. Import original doc or setup new doc
5. Needs a refresh/update, and probably split
6. Samples
7. Tests
8. All brought over tests pass for UWP/WinAppSDK
9. Add tests for converters not covered #134
   +0
   
10. Support for WASM via Uno Platform

Extensions

Preview Give feedback

1. FrameworkElementExtensions
2. ListViewExtensions
3. BitmapIconExtension
4. BitmapIconSourceExtension
5. EnumValuesExtension
6. FontIconExtension
7. FontIcoNSourceExtension
8. NullableBoolExtension
9. OnDeviceExtension
10. SymbolIconExtension
11. SymbolIconSourceExtension
12. MatrixExtensions
13. RectExtensions
14. RotateTransformExtensions
15. SkewTransformExtensions
16. TranslateTransformExtensions
17. ScrollViewExtensions
18. TextBoxExtensions
19. TitleBarExtensions (Blocked: Missing WinUI APIs)
20. ElementExtensions (Blocked: Missing WinUI APIs)
21. ApplicationViewExtensions (Blocked: Missing WinUI APIs)
22. WebViewExtensions (Deprecate in favor of WebView2)
23. PointExtensions
24. RectExtensions
25. SizeExtensions
26. StringExtensions
27. HyperlinkExtensions
28. DependencyObjectExtensions
29. DispatcherQueueExtensions

Known issues

Preview Give feedback

No tasks being tracked yet.

Future improvements

Preview Give feedback

No tasks being tracked yet.

Notable Changes

Preview Give feedback

1. For FrameworkExtensions, look at https://github.com/CommunityToolkit/Labs-Windows/blob/main/components/SegmentedControl/src/Helpers/FrameworkElementExtensions.cs. Some changes were made that to trigger the extension upon loading.

[michael-hawker]

@niels9001 originally we did a big push in 7.0 to flatten the namespace and remove 'extensions' so they were all consistent across the package for easy usage.

Context:

• https://github.com/CommunityToolkit/WindowsCommunityToolkit/releases/tag/v7.0.0
• Review namespaces and folder structure coupling WindowsCommunityToolkit#3422
• Refactor namespaces for extension types WindowsCommunityToolkit#3743
• https://blogs.windows.com/windowsdeveloper/2021/03/16/announcing-windows-community-toolkit-v7-0/

We could have the component/package maybe be called Extensions if we change the scope of what's inside it, but may want to think about still having a base namespace for some of these things?

@Sergio0694 thoughts?

[Sergio0694]

Heyoooooo I see a new repo 👀👀👀

@michael-hawker Yeah, if we went back and added "Extensions" back it'd be a bit weird.
FWIW we also don't use "Extensions" in the .NET Community Toolkit.

[michael-hawker]

Looking at the template that Niels copied I think he may have just used Namespace to mean package/component name? But will clarify in a quick-sync tomorrow. 🙂

[niels9001]

@Sergio0694 @michael-hawker Oh yeah, I basically just replaced the last bit of namespace from the previous template. So please ignore / update 😄!

[michael-hawker]

Haha, yeah, I guess that line was a bit more specific to the Converters as they are in their own namespace anyway. (Maybe that's a separate discussion as to if they should remain there.)

Anyway, all good. We'll sort it out and can update these issues all together at our next sync.

[michael-hawker]

#4 also needs the WeakEventListener and DispatcherQueue extensons. So we should port those over as well into the general base helpers/extensions place.

Should we have the extensions and helpers together as like a common folder/component name?

[michael-hawker]

We have some extensions in the base Microsoft.Toolkit.Uwp package merging those in with the extensions of Microsoft.Toolkit.Uwp.UI package here.

Then will create a separate Helpers component I think that contains most of the rest?

[michael-hawker]

Currently have not brought over:

• ApplicationViewExtensions
• TitleBarExtensions
• ScrollViewerExtensions.MiddleClickScrolling
• WebViewExtensions

I believe the top two work differently in UWP vs. WinAppSDK, so probably need to look at more closely if it makes sense to have them. Also, I believe @niels9001 has some thoughts about Titlebar helpers in general we should investigate for a revamp, especially with the platform doing work to better enable custom titlebars, see microsoft/microsoft-ui-xaml#8137

The Middle Click Scrolling extensions are dependent on Windowing APIs, Input APIs, and Cursor APIs, which all work very differently between UWP and Windows App SDK, so not porting for now, as I don't think they work for Windows App SDK at the moment, so probably need more attention.

With WebView2 now, we should figure out if we need to remap these extensions or how that should work.