Support for ToggleVisibility

[arluko]

First, thank a lot for this library. It made my job a lot easier but a little but crucial piece for my use-case is missing.

I would like to build an AdaptiveCard to achieve the following:

• I have a card with some text and a link
• When I click on the link I want to show more details
• If I click again on the link I want to hide the details again

I have built an example which you can try out in the Preview mode of the designer:

{
    "type": "AdaptiveCard",
    "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
    "version": "1.5",
    "body": [
        {
            "type": "TextBlock",
            "text": "Something has failed",
            "wrap": true,
            "style": "heading"
        },
        {
            "id": "details",
            "type": "TextBlock",
            "text": "Lorem ipsum dolor sit amet ...",
            "wrap": true,
            "isVisible": false
        },
        {
            "type": "Container",
            "selectAction": {
                "type": "Action.ToggleVisibility",
                "targetElements": [
                    "details",
                    "showDetails",
                    "hideDetails"
                ]
            },
            "items": [
                {
                    "type": "TextBlock",
                    "id": "showDetails",
                    "color": "Accent",
                    "text": "Show details"
                },
                {
                    "type": "TextBlock",
                    "id": "hideDetails",
                    "color": "Accent",
                    "text": "Hide details",
                    "isVisible": false
                }
            ]
        }
    ]
}

The following pieces are currently missing:

1. targetElements can not be set on the Action.ToggleVisibility (see schema)
2. isVisible can not be set on an Container (see schema)

Note: isVisible can not only be set on Container but a lot more element but for my use-case a container should be enough.

Can you add support for these two properties?

[atc0005]

Hi @arluko

Thank you for the detailed GH issue.

No promises on implementation time, but a quick review suggests this should be doable.

I will try to share a curl snippet and JSON file to test functionality in the near future so you can test delivering to your Teams instance. This will help confirm that the generated JSON payload will work as expected.

[atc0005]

@arluko

Place this within a text file (e.g., gh-243-test-payload1.json):

{
    "type": "message",
    "attachments": [
        {
            "contentType": "application/vnd.microsoft.card.adaptive",
            "content": {
                "type": "AdaptiveCard",
                "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
                "version": "1.5",
                "body": [
                    {
                        "type": "TextBlock",
                        "text": "Something has failed",
                        "wrap": true,
                        "style": "heading"
                    },
                    {
                        "id": "details",
                        "type": "TextBlock",
                        "text": "Lorem ipsum dolor sit amet ...",
                        "wrap": true,
                        "isVisible": false
                    },
                    {
                        "type": "Container",
                        "selectAction": {
                            "type": "Action.ToggleVisibility",
                            "targetElements": [
                                "details",
                                "showDetails",
                                "hideDetails"
                            ]
                        },
                        "items": [
                            {
                                "type": "TextBlock",
                                "id": "showDetails",
                                "color": "Accent",
                                "text": "Show details"
                            },
                            {
                                "type": "TextBlock",
                                "id": "hideDetails",
                                "color": "Accent",
                                "text": "Hide details",
                                "isVisible": false
                            }
                        ]
                    }
                ]
            }
        }
    ]
}

and use this snippet to deliver it (substituting the example webhook URL for your own):

webhook_url="https://example.webhook.office.com/webhookb2/a1269812-6d10-44b1-abc5-b84f93580ba0@9e7b80c7-d1eb-4b52-8582-76f921e416d9/IncomingWebhook/3fdd6767bae44ac58e5995547d66a4e4/f332c8d9-3397-4ac5-957b-b8e3fc465a8c"
curl \
    -X POST \
    -H "Content-type: application/json" \
    -d @/path/to/gh-243-test-payload1.json \
    "${webhook_url}"

[arluko]

@atc0005 I have tested your sample with curl and it works on my teams instance.

[atc0005]

Thank you for testing and confirming the results.

[atc0005]

I've been working on this, but it will take some time to work out the changes. I'll post again when there is something ready for testing/feedback.

[atc0005]

@arluko The initial prototype support can be found in the v2.9.0-alpha.1 release here:

• https://github.com/atc0005/go-teams-notify/releases/tag/v2.9.0-alpha.1

Examples are included.

Feedback is welcome.

[arluko]

@atc0005 I have tested the v2.9.0-alpha.1 release and it works for my use-case. Thanks a lot for the fast implementation. When can we expect a v2.9.0 release with this feature?

[atc0005]

Hi @arluko ,

Thanks for testing and providing feedback.

As I worked on these changes I ran into several places in the code that I would have liked to change to make integrating the new support easier, to make the steps feel more natural, but that would require an API change and thus a version bump to v3.

I would like to avoid that here if possible; I would like to wait a bit longer and gather additional feedback before including this code as part of the next stable release.

While this initial implementation is subject to change (to fix any discovered problems), the tag I shared will remain in case you wish to move forward with the existing behavior in your application(s) while we wait on others to respond.

[arluko]

@atc0005 I have restructured my card (for now) to work without the toggle visibility feature, so I am not really dependent on a immediate release with this feature. If there is a release sometime in the future with this functionality, I will integrate it, but in the meantime I have a working solution.