ShareButton

Shares the active interactive experience

Props

isios {boolean} - Are we running on iOS
ismacOS {boolean} - Are we running on OSX
icon {string} - The URL for the button icon

API

openShareDialog(e {event}) - Activates the player’s share functionality.

Events

SHAREBTN_SHARE_CLICK: "ekoshell.button.share"

parentContainer

ProjectMetaData_buttonRow

Plugin Options

"sharebutton": {
    "anyOf": [
        { "type": "boolean" },
        {
            "type": "object",
            "properties": {
                "icon": {
                    "type": "object",
                    "required": [
                        "default",
                        "ios"
                    ],
                    "properties": {
                        "default": {
                            "type": "string",
                            "description": "URL of icon to show for non-ios platforms"
                        },
                        "ios": {
                            "type": "string",
                            "description": "URL of icon to show for ios platforms"
                        }
                    }
                },       
            }
        }
    ]
},

Notes

Button should be disabled if overlayed by a different addon (for example, when the ShareScreen addon is visible on top)