On-Screen Keyboard Panel API

Owned by Cindy Li

Last updated: Sept 02, 2015 by Alan HarnumVersion comment

1 min read

On-Screen Keyboard Panel Overview

Allows users to choose whether they want to use the on-screen keyboard. This component uses Yes/No Panel as a base grade so it has the same component structure as Yes/No Panel in aspect of the model, options, selectors and dependencies.

On This Page

See Also

Still need help?

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

Adding a On-Screen Keyboard Panel to a Component/Grade

Option 1: Typically the On-Screen Keyboard Panel is integrated into the first discovery tool by supplying it as a type option in an Auxiliary Schema:

"onScreenKeyboard": {
    "type": "gpii.firstDiscovery.onScreenKeyboard",
    "panel": {
        "type": "gpii.firstDiscovery.panel.onScreenKeyboard",
        "container": ".gpiic-fd-prefsEditor-panel-onScreenKeyboard",
        "template": "%prefix/yesNo.html",
        "message": "%prefix/onScreenKeyboard.json"
    }
}

Working in conjunction with the Auxiliary Schema, the type and its default value of the on-screen keyboard preference are defined in the Primary Schema:

fluid.defaults("gpii.firstDiscovery.schemas.onScreenKeyboard", {
    gradeNames: ["autoInit", "fluid.prefs.schemas"],
    schema: {
        "gpii.firstDiscovery.onScreenKeyboard": {
            "type": "boolean",
            "default": true
        }
    }
});

Option 2: Adding as a stand alone component:

var myPanel = gpii.firstDiscovery.panel.onScreenKeyboard(container, options);

Grades

The base grades used by the On-Screen Keyboard Panel:

gpii.firstDiscovery.panel.yesNo