Overview

Component Name: gpii.firstDiscovery.panel.keyboardTts

File: panels.js

Adds the self-voicing to read the instructions at the various stages of the Sticky Keys Panel workflow. This component is not intended to be used on its own, but provided as a grade to the Sticky Keys Panel Component. This component also relies on the availability of a component with the fluid.textToSpeech grade within the component hierarchy to do the actual speaking.

Using the Sticky Keys Panel – Text-to-Speech grade

Typically, the Sticky Keys Panel – Text-to-Speech grade is added as an extra grade to the Sticky Keys Panel specification in the Auxiliary Schema:

To use the Sticky Keys Panel – Text-to-Speech grade, supply it as a gradeNames option in the Auxiliary Schema:

"keyboard": {
    "type": "gpii.firstDiscovery.stickyKeys",
    "panel": {
        "type": "gpii.firstDiscovery.panel.keyboard",
        "container": ".gpiic-fd-prefsEditor-panel-keyboard",
        "template": "%templatePrefix/keyboard.html",
        "message": "%messagePrefix/keyboard.json",
        "gradeNames": ["gpii.firstDiscovery.panel.keyboardTts", "gpii.firstDiscovery.panel.keyboard.prefEditorConnection"]
    }
}}

Methods

Method	Description	Parameters
speakStickyKeysState	Announces whether or not the sticky keys preference is turned on	that (object) an instance of gpii.firstDiscovery.panel.keyboardTts state (boolean) the state of the sticky keys preference
speakPanelInstructions	Speaks the panel instruction	none

Dependencies

<script type="text/javascript" src="src/lib/infusion/infusion-custom.js"></script>
<script type="text/javascript" src="src/js/msgLookup.js"></script>
<script type="text/javascript" src="src/js/tooltip.js"></script>
<script type="text/javascript" src="src/js/panels.js"></script>