Welcome
Overview
Component Name: gpii.firstDiscovery.panel.welcome
File: panels.js
Displays the welcome message.
Using the Welcome Panel
Option 1: In the
Auxiliary Schema,
specify the name of the panel as the type
property of the panel
section:
"welcome": {
"type": "gpii.firstDiscovery.welcome",
"panel": {
"type": "gpii.firstDiscovery.panel.welcome",
"container": ".gpiic-fd-prefsEditor-panel-welcome",
"template": "%templatePrefix/welcomeTemplate.html",
"message": "%messagePrefix/welcome.json"
}
}
Option 2: Outside the context of the First Discovery Tool, developers may wish to create a standalone component:
var myPanel = gpii.firstDiscovery.panel.welcome(container, options);
Grades
This component uses the following base grades:
Options
This component can be configured using the following options:
Name | Description | Values | Default |
---|---|---|---|
selectors |
Javascript object containing selectors for various fragments of the markup, including the containers for the subcomponents. | See Selectors below |
Selectors
One of the options that can be provided to Infusion components is a set of CSS-based selectors identifying where in the DOM different elements can be found. Components use a DOM Binder to access the named elements.
The value for the selectors
option is itself a Javascript object containing name/value pairs:
selectors: {
selector1Name: "selector 1 string",
selector2Name: "selector 2 string",
...
}
Selector Name | Description | Default |
---|---|---|
message |
The container to display the welcome message. | ".gpiic-fd-welcome-instructions" |
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>