Eko | docs |

EkoshellRoot

This serves as the topmost level addon of the platform UI

Props

No props

API

No API.

Events

No events.

parentContainer

Inapplicable (special case)

Sub-addons

• Container root

Schema

"root": {
    "type": "object",
    "properties": {
        "tapToPause": { "type": "boolean" } // if true, the clickCatcher will be defined to pause on tap, otherwise it will trigger ControlsOverlay 'toggleShow` 
    }
},

Notes

• The namespace for plugin options for this addon is root and not ekoshellroot
• Contains the default “root” container, all addons are placed by default in this container if not specified otherwise
• Registers the space key to toggle ControlsOverlay‘s togglePlayPause function
• Initializes ClickCatcher‘s clickAction based on the tapToPause option.