Overview

Component Name: gpii.firstDiscovery.panel.captions

File: panels.js

The Captions panel presents an adjuster that allows the user to adjust the captions preference settings. The adjuster presents Yes and No buttons that allows users to choose whether they want to see captions when playing videos.

This component uses Yes/No Panel as a base grade so it has the same component structure as Yes/No Panel in terms of the model, options, selectors and dependencies.

Using the Captions Panel

Option 1: In the Auxiliary Schema, specify the name of the panel as the type property of the panel section:

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

Working in conjunction with the Auxiliary Schema, the type and default value of the captions preference are defined in the Primary Schema:

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

Option 2: Outside the context of the First Discovery Tool, developers may wish to create a standalone component:

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

Grades

This component uses the following base grades:

• gpii.firstDiscovery.panel.yesNo