Skip to content

Overlay Mode

Gregory Miller edited this page Aug 4, 2019 · 2 revisions

The overlay mode is designed to cover the entire card when displayed. The box with the controls is then drawn on top. The overlay section prevents interaction with the rest of the card until the control is hidden.

For example, a dialog box can be displayed, and requires interaction like hitting an okay button before proceeding. The size and position of the control box and working area are manually set. It will be necessary to size and position the widget to cover the card.

overlayMode "Show as an Overlay"

  • Boolean value, when set to true it activates overlay mode.
  • Default = false

overlayAlign "Overlay Alignment"

  • Alignment consists of 2 words, the first being vertical, the second being horizontal. Options are "top left,top center,top right,center left,center center,center right,bottom left,bottom center,bottom right"
  • Default = "center center"

overlayHeight "Overlay-Box Height"

  • Set the height of the control's box when in overlay mode.
  • Default = 200

overlayWidth "Overlay-Box Width"

  • Set the width of the control's box when in overlay mode.
  • Default = 300

overlayOffset "Overlay Offset from Edge"

  • Changes the position of the control's box
  • Default = 13

overlayColor "Overlay Color"

  • Sets the color of the overlay background, this is only relevant if the Opacity > 0. (See the Colors section for more information about how to configure colors.)
  • Default = "bottom"

overlayOpacity "Overlay Opacity"

  • Sets how transparent/opaque the overlay territory is. At 0% the overlay is clear but the respondent will not be able to interact with anything below it. At 100% the overlay area is a solid color.
  • Options are 0% to 100% in 10% increments.
  • Default = 0

Clone this wiki locally