Skip to main content

CoachingOverlay.configure()

CoachingOverlay.configure({ animationColor, promptColor, promptText, disablePrompt })

Description

Configures behavior and look of the Coaching Overlay.

Parameters (All Optional)

ParameterTypeDefaultDescription
animationColorString'white'Color of the Coaching Overlay animation. This parameter accepts valid CSS color arguments.
promptColorString'white'Color of all the Coaching Overlay text. This parameter accepts valid CSS color arguments.
promptTextString'Move device forward and back'Sets the text string for the animation explainer text that informs users of the motion they need to make to generate scale.
disablePromptBooleanfalseSet to true to hide default Coaching Overlay in order to use Coaching Overlay events for a custom overlay.

Returns

None

Example - Code

CoachingOverlay.configure({
animationColor: '#E86FFF',
promptText: 'To generate scale push your phone forward and then pull back',
})