• Public
  • Public/Protected
  • All

Interface OnScreenMenuCustomButtonParams

Interface to describe parameters that are used to construct a custom button for the On-Screen Menu.




action : function

Function that represents the action to be performed on the click of the button.

    • Parameters

      Returns void

Optional color

color : undefined | string

Optional color value for this button. If no value is specified, the color will be chosen from the theme.

Optional dimensions

dimensions : OnScreenMenuDimensions

Optional icon

icon : undefined | string

Path to an icon that this button will display.

Optional label

label : undefined | string

Optional label to be displayed on the button.

Optional opacity

opacity : undefined | string

Optional opacity for the button. Accepts a value between 0 and 1, were 0 is transparent and 1 is opaque.

Optional shape

Optional value for the shape of the button.