[Android] Overflow Actions (onto main branch)

[robin-liao]

Related Issue

ActionSet overflow flyout (... actions menu) 4715

Description

To introduce a new feature of overflow actions, the implementation follows the spec:

1. This new feature will bring as part of Schema version 1.5

2. Introduce a new property field mode to all Action type. Its value can be primary (default) or secondary. For all secondary action instances in the same actions array (either the root level actions section or ActionSet inside card elements) they'll group as overflow actions, wrap up within a "..." button and display flyout context menu when user clicks "..." button.

3. hostConfig.actions.maxActions doesn't count "..." button itself.

4. Client callbacks are added to control overflow button "..." and flyout menu actions rendering:

   • View onRenderOverflowAction(@NonNull ViewGroup viewGroup, boolean isRootLevelActions)

     • It will be called when “…” overflow button will be rendered. viewGroup is the container view to which client can optionally attach the Overflow view, and isRootLevelActions indicates if the current "..." overflow action belongs to root level actions array. If it's false then it indicates it's ActionSet as body elements.
     • Client callback requires to return a View instance. Returning null means let SDK continue to render "..." button, while View informs SDK don't render the current "..." button.

   • boolean onDisplayOverflowActionMenu(@NonNull List<View> actionViewList, @NonNull View view)

     • It will be called when overflow context menu will be shown. The first argument actionViewList are those rendered secondary actions views , and view is the element that triggered the context menu, which usually is the “…” button. It can be used by client to position the context menu if client wants to render flyout actions itself.
     • Client callback requires to return a boolean value. Returning false means let SDK continue to render flyout context menu, while true informs SDK don't render flyout (which implies client code might render context menu by itself via onDisplayOverflowActionMenu callback)

   • boolean shouldAllowMoreThanMaxActionsInOverflowMenu()

     • Client callback requires to return a boolean value. Returning true indicates that the actions exceeding the number defined in hostConfig.actions.maxActions will be auto wrapped up as overflow actions and "..." button for context menu will be displayed and false indicates excess action elements will be left out.

Sample Card

{
  "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
  "type": "AdaptiveCard",
  "version": "1.2",
  "body": [
	{
	  "type": "Image",
	  "url": "https://adaptivecards.io/content/adaptive-card-50.png"
	},
	{
	  "type": "TextBlock",
	  "text": "Hello **Adaptive Cards!**"
	},
	{
	  "type": "ActionSet",
	  "actions": [
		{
		  "type": "Action.Submit",
		  "title": "Action Submit",
		  "data": {
			"key": "Submit from overflow menu"
		  }
		},
		{
		  "type": "Action.Submit",
		  "title": "Edit",
		  "data": {
			"key": "Edit from overflow menu"
		  },
		  "mode": "secondary"
		}
	  ]
	}
  ],
  "actions": [

	{
	  "type": "Action.Submit",
	  "title": "Submit"
	},
	{
	  "type": "Action.Submit",
	  "title": "Edit"
	},
	{
	  "type": "Action.Submit",
	  "title": "Delete",
	  "data": {
		"key": "Submit from overflow menu"
	  },
	  "mode": "Secondary"
	},
	{
	  "type": "Action.OpenUrl",
	  "iconUrl": "https://adaptivecards.io/content/cats/2.png",
	  "url": "https://adaptivecards.io",
	  "title": "Open Url",
	  "mode": "Secondary"
	},{
	  "type": "Action.ShowCard",
	  "title": "Action.ShowCard",
	  "card": {
		"type": "AdaptiveCard",
		"body": [
		  {
			"type": "TextBlock",
			"text": "What do you think?"
		  }
		],
		"actions": [
		  {
			"type": "Action.Submit",
			"title": "Neat!"
		  }
		]
	  },
	  "mode": "Secondary"
	}

  ]
}

How Verified

Added Unit Test "SecondaryAcrionsPropertiesSet.Java" to test the different scenarios.

Overflow	Displaying Menu

[ghost]

Hi @robin-liao. Thanks for helping make the AdaptiveCards JS renderer + tooling better. As additional verification, once the JS build succeeds, please go to the test site to test out your website/designer changes.

[golddove]

Just commenting here for future reference: original PR was #5606 which has review comments / approvals.