Sticky Keys Adjuster API

Sept 02, 2015

Sticky Keys Adjuster Overview

Creates the interface for users to experiment the keyboard feature when the sticky key preference is turned on or off.

On This Page

See Also

Still need help?

Join the infusion-users mailing list and ask your questions there.

Adding a Sticky Keys Adjuster Component

Option 1: Typically used as a sub-component of a Sticky Key Panel.

Adding as sub-component:

assistance: {
    type: "gpii.firstDiscovery.keyboard.stickyKeysAdjuster",
    container: "{that}.container",
    options: {}
}

Option 2: Adding as a stand alone component:

var myStickyKeyAdjuster = gpii.firstDiscovery.keyboard.stickyKeysAdjuster(container, options);

Grades

The base grades used by the Sticky Keys Adjuster:

Model

Path	Description	Values	Default

Path	Description	Values	Default
`stickyKeysEnabled`	Whether or not the sticky key preference is turned on.	`Boolean`	undefined
`tryAccommodation`	Whether or not the user has chosen to try the sticky key feature.	`Boolean`	undefined

Methods

Method	Description	Parameters

Method	Description	Parameters
`toggleStickyKeys`	Toggles `model.stickyKeysEnabled` between an enabled/disabled state.	None
`toggleTry`	Toggles `model.tryAccommodation` between an enabled/disabled state.	None

Selectors

One of the options that can be provided to the First Discovery Editor is a set of CSS-based selectors identifying where in the DOM different elements can be found. The value for the option is itself a Javascript object containing name/value pairs:

selectors: {
    selector1Name: "selector 1 string",
    selector2Name: "selector 2 string",
      ...
}

Selector Name	Description	Default

Selector Name	Description	Default
`description`	The description of why the sticky key feature is useful.	".gpiic-fd-keyboard-stickyKeysAdjuster-desc"
`tryButton`	The try it button.	".gpiic-fd-keyboard-stickyKeysAdjuster-try"
`accommodation`	The wrapper container of elements to operate the sticky key feature. Typically includes these elements: `accommodationInstr`, `accommodationName`, `accommodationState`, `accommodationToggle`	".gpiic-fd-keyboard-stickyKeysAdjuster-accommodation"
`accommodationInstr`	The description of an example of how to use the sticky key feature.	".gpiic-fd-keyboard-stickyKeysAdjuster-accommodationInstr"
`accommodationName`	The label of "Sticky Keys".	".gpiic-fd-keyboard-stickyKeysAdjuster-accommodationName"
`accommodationState`	The current on/off state of the sticky key feature.	".gpiic-fd-keyboard-stickyKeysAdjuster-accommodationState"
`accommodationToggle`	The button to toggle the on/off state of the sticky key feature.	".gpiic-fd-keyboard-stickyKeysAdjuster-accommodationToggle"

Dependencies

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