Rename helpText -> accessibleHelpText, see phetsims/scenery#1688

doc/Checkbox.md

@@ -78,7 +78,7 @@ checkbox widgets is not relevant. I have adapted the content from the ARIA pract
   or name for the group.
 - When the presentation includes additional descriptive static text (i.e., help text) relevant to a checkbox or group of
   checkboxes, using `aria-describedby` is an option to provide automatically read help text. We have, however, that
-  automatic helptext is not needed in our sims. Users seem to prefer on-demand help text.
+  automatic accessibleHelpText is not needed in our sims. Users seem to prefer on-demand help text.
 
 ### Simplified HTML Examples for PDOM
 

js/ABSwitch.ts

@@ -151,7 +151,7 @@ export default class ABSwitch<T> extends HBox {
     this.toggleSwitch = toggleSwitch;
     this.setLabelEnabled = options.setLabelEnabled;
 
-    // pdom - Setting helpText on ABSwitch forwards the values to the actual ToggleSwitch.
+    // pdom - Setting accessibleHelpText on ABSwitch forwards the values to the actual ToggleSwitch.
     ParallelDOM.forwardHelpText( this, toggleSwitch );
 
     // Find accessible names from the labels if optional values were not provided.

js/AccordionBox.ts

@@ -121,13 +121,13 @@ type SelfOptions = {
   contextResponseExpanded?: TAlertable;
   contextResponseCollapsed?: TAlertable;
 
-  // pdom - AccordionBoxes usually don't have helpText. If they do, the content is usually only available
+  // pdom - AccordionBoxes usually don't have accessibleHelpText. If they do, the content is usually only available
   // when collapsed. There is one option for each state.
   helpTextExpanded?: PDOMValueType | null;
   helpTextCollapsed?: PDOMValueType | null;
 
-  // voicing - AccordionBoxes usually don't have helpText, so default values for voicing are not
-  // set from helpText. Usually, the hint response is removed when the accordion box is expanded.
+  // voicing - AccordionBoxes usually don't have accessibleHelpText, so default values for voicing are not
+  // set from accessibleHelpText. Usually, the hint response is removed when the accordion box is expanded.
   // There is one option for each state.
   voicingHintResponseExpanded?: ResolvedResponse;
   voicingHintResponseCollapsed?: ResolvedResponse;
@@ -432,12 +432,12 @@ export default class AccordionBox extends Sizable( Node ) {
     } );
     this.addChild( pdomContainerNode );
 
-    // So that setting accessibleName and helpText on AccordionBox forwards it to the correct subcomponents for the
+    // So that setting accessibleName and accessibleHelpText on AccordionBox forwards it to the correct subcomponents for the
     // accessibility implemenation.
     ParallelDOM.forwardAccessibleName( this, this.expandCollapseButton );
-    this.helpTextBehavior = ( node, options, helpText, forwardingCallbacks ) => {
+    this.accessibleHelpTextBehavior = ( node, options, accessibleHelpText, forwardingCallbacks ) => {
       forwardingCallbacks.push( () => {
-        pdomHelpTextNode.innerContent = helpText;
+        pdomHelpTextNode.innerContent = accessibleHelpText;
       } );
       return options;
     };
@@ -485,7 +485,7 @@ export default class AccordionBox extends Sizable( Node ) {
 
       pdomContainerNode.setPDOMAttribute( 'aria-hidden', !expanded );
 
-      this.helpText = expanded ? options.helpTextExpanded : options.helpTextCollapsed;
+      this.accessibleHelpText = expanded ? options.helpTextExpanded : options.helpTextCollapsed;
       this.expandCollapseButton.voicingHintResponse = expanded ? options.voicingHintResponseExpanded : options.voicingHintResponseCollapsed;
 
       const contextResponse = expanded ? options.contextResponseExpanded : options.contextResponseCollapsed;

js/AquaRadioButtonGroup.ts

@@ -96,7 +96,7 @@ export default class AquaRadioButtonGroup<T> extends FlowBox {
       tagName: 'ul',
       labelTagName: 'h3',
       ariaRole: 'radiogroup',
-      helpTextBehavior: ParallelDOM.HELP_TEXT_BEFORE_CONTENT,
+      accessibleHelpTextBehavior: ParallelDOM.HELP_TEXT_BEFORE_CONTENT,
       groupFocusHighlight: true
     }, providedOptions );
 
@@ -150,7 +150,7 @@ export default class AquaRadioButtonGroup<T> extends FlowBox {
         else {
           targetButton.voicingSpeakFullResponse( {
             contextResponse: null,
-            hintResponse: this.helpText
+            hintResponse: this.accessibleHelpText
           } );
         }
       }

js/Checkbox.ts

@@ -139,7 +139,7 @@ export default class Checkbox extends WidthSizable( Voicing( Node ) ) {
       voicingCheckedObjectResponse: null,
       voicingUncheckedObjectResponse: null,
       accessibleNameBehavior: Voicing.BASIC_ACCESSIBLE_NAME_BEHAVIOR,
-      helpTextBehavior: Voicing.BASIC_HELP_TEXT_BEHAVIOR,
+      accessibleHelpTextBehavior: Voicing.BASIC_HELP_TEXT_BEHAVIOR,
 
       // Utterances to be spoken with a screen reader after the checkbox is pressed. Also used for
       // the voicingContextResponse

js/ComboBox.ts

@@ -88,17 +88,17 @@ export type ComboBoxItemNoNode<T> = StrictOmit<ComboBoxItem<T>, 'createNode'>;
 export type ComboBoxListPosition = typeof LIST_POSITION_VALUES[number];
 export type ComboBoxAlign = typeof ALIGN_VALUES[number];
 
-// The definition for how ComboBox sets its accessibleName and helpText in the PDOM. Forward it onto its button. See
+// The definition for how ComboBox sets its accessibleName and accessibleHelpText in the PDOM. Forward it onto its button. See
 // ComboBox.md for further style guide and documentation on the pattern.
 const ACCESSIBLE_NAME_BEHAVIOR: PDOMBehaviorFunction = ( node, options, accessibleName, otherNodeCallbacks ) => {
   otherNodeCallbacks.push( () => {
     ( node as ComboBox<unknown> ).button.accessibleName = accessibleName;
   } );
   return options;
 };
-const HELP_TEXT_BEHAVIOR: PDOMBehaviorFunction = ( node, options, helpText, otherNodeCallbacks ) => {
+const HELP_TEXT_BEHAVIOR: PDOMBehaviorFunction = ( node, options, accessibleHelpText, otherNodeCallbacks ) => {
   otherNodeCallbacks.push( () => {
-    ( node as ComboBox<unknown> ).button.helpText = helpText;
+    ( node as ComboBox<unknown> ).button.accessibleHelpText = accessibleHelpText;
   } );
   return options;
 };
@@ -248,7 +248,7 @@ export default class ComboBox<T> extends WidthSizable( Node ) {
       tagName: 'div', // must have accessible content to support behavior functions
       buttonLabelTagName: 'p',
       accessibleNameBehavior: ACCESSIBLE_NAME_BEHAVIOR,
-      helpTextBehavior: HELP_TEXT_BEHAVIOR,
+      accessibleHelpTextBehavior: HELP_TEXT_BEHAVIOR,
 
       comboBoxVoicingNameResponsePattern: SunConstants.VALUE_NAMED_PLACEHOLDER,
       comboBoxVoicingContextResponse: null,
@@ -312,7 +312,7 @@ export default class ComboBox<T> extends WidthSizable( Node ) {
 
       comboBoxVoicingNameResponsePattern: options.comboBoxVoicingNameResponsePattern,
 
-      // pdom - accessibleName and helpText are set via behavior functions on the ComboBox
+      // pdom - accessibleName and accessibleHelpText are set via behavior functions on the ComboBox
       labelTagName: options.buttonLabelTagName,
 
       // phet-io

js/Panel.ts

@@ -73,7 +73,7 @@ const DEFAULT_OPTIONS: OptionizeDefaults<SelfOptions, SuperOptions> = {
 
   // pdom
   labelTagName: 'span', // A labelTagName ensures the accessibleName gets its own tag before child content.
-  helpTextBehavior: ParallelDOM.HELP_TEXT_BEFORE_CONTENT // Help text comes first for Nodes that are content containers.
+  accessibleHelpTextBehavior: ParallelDOM.HELP_TEXT_BEFORE_CONTENT // Help text comes first for Nodes that are content containers.
 };
 assert && Object.freeze( DEFAULT_OPTIONS );
 

js/buttons/RectangularRadioButtonGroup.ts

@@ -163,7 +163,7 @@ export default class RectangularRadioButtonGroup<T> extends FlowBox {
       tagName: 'ul',
       labelTagName: 'h3',
       ariaRole: 'radiogroup',
-      helpTextBehavior: ParallelDOM.HELP_TEXT_BEFORE_CONTENT,
+      accessibleHelpTextBehavior: ParallelDOM.HELP_TEXT_BEFORE_CONTENT,
       groupFocusHighlight: true
     }, providedOptions );
 

js/demo/buttons/demoAquaRadioButtonGroup.ts

@@ -49,7 +49,7 @@ export default function demoAquaRadioButtonGroup( layoutBounds: Bounds2 ): Node
 
     // pdom
     accessibleName: 'Vertical AquaRadioButtonGroup',
-    helpText: 'This is a description of the vertical AquaRadioButtonGroup.'
+    accessibleHelpText: 'This is a description of the vertical AquaRadioButtonGroup.'
   } );
 
   // pdom - context response for the changing value