Widget Customization does not show template JSON

[ramonmata]

Describe the bug

Learning from the example widget provider once I select the option "✏️Customize Widget" the card grows but the customization template does not show.

Debugging the code I found that OnCustomizationRequested callback never gets executed.

Steps to reproduce the bug

Follow instructions from Microsoft learning document Implementing widget customization

Expected behavior

Widget host must call OnCustomizationRequested in order to load the template JSON for the customization card

Screenshots

NuGet package version

Windows App SDK 1.4.2: 1.4.231008000

Packaging type

Packaged (MSIX)

Windows version

Windows 11 version 22H2 (22621, 2022 Update)

IDE

Visual Studio 2022

Additional context

No response

[beervoley]

Thanks for submitting the issue @ramonmata!

Have you started seeing this issue only with winappsdk 1.4.231008000 or this is the initial version of winappsdk you're using to add customization?

Could you please also confirm the version of Widget Dashboard you have? You can find it in Widgets Dashboard settings in the bottom of the page (click "Gears" icon in the top right corner of the Widgets Dashboard) or you can also run get-appxpackage MicrosoftWindows.Client.WebExperience in PowerShell and get the version from there :)

It would be perfect to also have small repro app with the widget provider if you can attach it to this issue :)

[ramonmata]

Hi @beervoley

winappsdk 1.4.231008000 was the initial version as it was the latest.

The current status of this issue is partially solved with the latest Windows 11 update, tried with both winappsdk 1.4.231115000 and the latest winappsdk 1.4.231115000

The remaining issues are as following:

• Widget grows from Small to Medium
• When you exit customization Widget stays as Medium Size
• The More options ( ... ) button becomes grayed out, not letting me choose the customize or unpin options.

Here you have the URL to the repo with the sample code I took from the Learning site from Micrsoft. https://github.com/ramonmata/ExampleWidgetProvider

My windows version

Edition Windows 11 Pro
Version 23H2
Installed on    ‎2/‎18/‎2023
OS build    22631.2715
Experience  Windows Feature Experience Pack 1000.22677.1000.0

And the information of Widgets Dashboard version from PowerShell

PS C:\Users\Ramon> get-appxpackage MicrosoftWindows.Client.WebExperience

Name              : MicrosoftWindows.Client.WebExperience
Publisher         : CN=Microsoft Windows, O=Microsoft Corporation, L=Redmond, S=Washington, C=US
Architecture      : X64
ResourceId        :
Version           : 423.29700.0.0
PackageFullName   : MicrosoftWindows.Client.WebExperience_423.29700.0.0_x64__cw5n1h2txyewy
InstallLocation   : C:\Program Files\WindowsApps\MicrosoftWindows.Client.WebExperience_423.29700.0.0_x64__cw5n1h2txyewy
IsFramework       : False
PackageFamilyName : MicrosoftWindows.Client.WebExperience_cw5n1h2txyewy
PublisherId       : cw5n1h2txyewy
IsResourcePackage : False
IsBundle          : False
IsDevelopmentMode : False
NonRemovable      : False
Dependencies      : {Microsoft.VCLibs.140.00_14.0.32530.0_x64__8wekyb3d8bbwe}
IsPartiallyStaged : False
SignatureKind     : Store
Status            : Ok

[beervoley]

Hi @ramonmata, thanks for quick response :)

I can repro the behaviour you're seeing. Dashboard team is aware of the bugs and they're in their backlog :) I don't have a timeline yet for it but once I do, I will update this issue.

I know this is not ideal, but for the time being to enable customization without relying on Widgets API (until the bug is fixed), you can add a button to your Widget that a user will click to trigger customization. It's usually a little Gear Icon button somewhere in the right top/bottom corner of your Adaptive Card :)