Help Button API

Owned by Justin Obara
Last updated: Sept 02, 2015 by Alan HarnumVersion comment
1 min read

Help Button Overview

The Help Button provides a component for handling the interface and interaction of help. This has only been roughed in and currently only sets the text of the help button to assist with localization.

On This Page
See Also
Still need help?

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

Adding a Help Button Component

Option 1: Typically used as a sub-component of a Preferences Editor Loader, particularly the First Discovery Tool Editor.

Adding as a sub-component:

helpButton: {
    type: "gpii.firstDiscovery.helpButton",
    container: "{that}.dom.helpButton",
    options: {}
}

Option 2: Adding as a stand alone component:

var myHelpButton = gpii.firstDiscovery.helpButton(container, options);

Grades

The base grades used by the Help Button:

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/helpButton.js"></script>