keyboard help content adjustments for GFLBasics, phetsims/gravity-for…

…ce-lab-basics#118
phetsims · Apr 24, 2019 · 883df95 · 883df95
1 parent ccfcf0d
commit 883df95
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 4 deletions.
diff --git a/js/SceneryPhetA11yStrings.js b/js/SceneryPhetA11yStrings.js
@@ -81,6 +81,9 @@ define( function( require ) {
     keyboardHelpDialogExitDialogDescription: {
       value: 'Exit a dialog with Escape key.'
     },
+    toggleCheckboxesDescription: {
+      value: 'Toggle checkboxes with Space key.'
+    },
 
     // help descriptions for sliders
     keyboardHelpDialogAdjustDefaultStepsString: {

diff --git a/js/keyboard/help/GeneralKeyboardHelpSection.js b/js/keyboard/help/GeneralKeyboardHelpSection.js
@@ -26,13 +26,15 @@ define( function( require ) {
   var keyboardHelpDialogMoveToPreviousItemOrGroupString = require( 'string!SCENERY_PHET/keyboardHelpDialog.moveToPreviousItemOrGroup' );
   var keyboardHelpDialogMoveToPreviousItemString = require( 'string!SCENERY_PHET/keyboardHelpDialog.moveToPreviousItem' );
   var keyboardHelpDialogPressButtonsString = require( 'string!SCENERY_PHET/keyboardHelpDialog.pressButtons' );
+  var keyboardHelpDialogToggleCheckboxString = require( 'string!SCENERY_PHET/keyboardHelpDialog.toggleCheckboxes' );
 
   // a11y strings
   var keyboardHelpDialogTabDescriptionString = SceneryPhetA11yStrings.keyboardHelpDialogTabDescription.value;
   var keyboardHelpDialogShiftTabDescriptionString = SceneryPhetA11yStrings.keyboardHelpDialogShiftTabDescription.value;
   var keyboardHelpDialogPressButtonsDescriptionString = SceneryPhetA11yStrings.keyboardHelpDialogPressButtonsDescription.value;
   var keyboardHelpDialogGroupNavigationDescriptionString = SceneryPhetA11yStrings.keyboardHelpDialogGroupNavigationDescription.value;
   var keyboardHelpDialogExitDialogDescriptionString = SceneryPhetA11yStrings.keyboardHelpDialogExitDialogDescription.value;
+  var toggleCheckboxesDescriptionString = SceneryPhetA11yStrings.toggleCheckboxesDescription.value;
 
   /**
    * @constructor
@@ -41,7 +43,8 @@ define( function( require ) {
   function GeneralKeyboardHelpSection( options ) {
 
     options = _.extend( {
-      withGroupContent: false // if true, the help content will include information about how to interact with groups
+      withGroupContent: false, // if true, the help content will include information about how to interact with groups
+      withCheckboxContent: false // if true, the help content will include information about how to interact with checkboxes
     }, options );
 
     // 'press buttons' content
@@ -52,7 +55,7 @@ define( function( require ) {
     var exitADialogIcon = new EscapeKeyNode();
     var exitADialogRow = KeyboardHelpSection.labelWithIcon( keyboardHelpDialogExitADialogString, exitADialogIcon, keyboardHelpDialogExitDialogDescriptionString );
 
-    var content = [ pressButtonsItemRow, exitADialogRow ];   
+    var content = [ pressButtonsItemRow, exitADialogRow ];
 
     var nextItemString;
     var previousItemString;
@@ -66,16 +69,22 @@ define( function( require ) {
       var leftRightArrowsIcon = KeyboardHelpSection.leftRightArrowKeysRowIcon();
       var upDownArrowsIcon = KeyboardHelpSection.upDownArrowKeysRowIcon();
       var leftRightOrUpDownIcon = KeyboardHelpSection.iconOrIcon( leftRightArrowsIcon, upDownArrowsIcon );
-      var moveBetweenItemsInAGroupRow = KeyboardHelpSection.labelWithIcon( keyboardHelpDialogMoveBetweenItemsInAGroupString, leftRightOrUpDownIcon, keyboardHelpDialogGroupNavigationDescriptionString );
+      var moveBetweenItemsInAGroupRow = KeyboardHelpSection.labelWithIcon( keyboardHelpDialogMoveBetweenItemsInAGroupString,
+        leftRightOrUpDownIcon, keyboardHelpDialogGroupNavigationDescriptionString );
 
       // the "group" content row row comes just before the "exite a dialog" row
-      content.splice( content.indexOf( exitADialogRow ), 0, moveBetweenItemsInAGroupRow );   
+      content.splice( content.indexOf( exitADialogRow ), 0, moveBetweenItemsInAGroupRow );
     }
     else {
       nextItemString = keyboardHelpDialogMoveToNextItemString;
       previousItemString = keyboardHelpDialogMoveToPreviousItemString;
     }
 
+    if ( options.withCheckboxContent ) {
+      content.push( KeyboardHelpSection.labelWithIcon( keyboardHelpDialogToggleCheckboxString, new SpaceKeyNode(),
+        toggleCheckboxesDescriptionString ) );
+    }
+
     // 'move to next item' content
     var moveToNextItemIcon = new TabKeyNode();
     var moveToNextItemRow = KeyboardHelpSection.labelWithIcon( nextItemString, moveToNextItemIcon, keyboardHelpDialogTabDescriptionString );

diff --git a/scenery-phet-strings_en.json b/scenery-phet-strings_en.json
@@ -116,6 +116,9 @@
   "keyboardHelpDialog.exitADialog": {
     "value": "Exit a dialog"
   },
+  "keyboardHelpDialog.toggleCheckboxes": {
+    "value": "Toggle checkboxes"
+  },
   "keyboardHelpDialog.or": {
     "value": "or"
   },