Add tandemSuffix option, specify and match conventions, see phetsims/…

…tandem#267
phetsims · Aug 26, 2022 · e3f7f3c · e3f7f3c
1 parent 0565bd2
commit e3f7f3c
Show file tree

Hide file tree

Showing 27 changed files with 39 additions and 12 deletions.
diff --git a/js/ABSwitch.ts b/js/ABSwitch.ts
@@ -74,6 +74,7 @@ export default class ABSwitch<T> extends HBox {
 
       // phet-io
       tandem: Tandem.REQUIRED,
+      tandemSuffix: 'Switch',
       visiblePropertyOptions: { phetioFeatured: true },
       phetioEnabledPropertyInstrumented: true // opt into default PhET-iO instrumented enabledProperty
     }, providedOptions );

diff --git a/js/AccordionBox.ts b/js/AccordionBox.ts
@@ -187,6 +187,7 @@ export default class AccordionBox extends Node {
 
       // phet-io support
       tandem: Tandem.REQUIRED,
+      tandemSuffix: 'AccordionBox',
       phetioType: AccordionBox.AccordionBoxIO,
       phetioEventType: EventType.USER,
       visiblePropertyOptions: { phetioFeatured: true }

diff --git a/js/AquaRadioButton.ts b/js/AquaRadioButton.ts
@@ -85,6 +85,7 @@ export default class AquaRadioButton<T> extends Voicing( Node ) {
 
       // phet-io
       tandem: Tandem.REQUIRED,
+      tandemSuffix: 'RadioButton',
       visiblePropertyOptions: { phetioFeatured: true },
       phetioEnabledPropertyInstrumented: true, // opt into default PhET-iO instrumented enabledProperty
 

diff --git a/js/AquaRadioButtonGroup.ts b/js/AquaRadioButtonGroup.ts
@@ -77,6 +77,7 @@ export default class AquaRadioButtonGroup<T> extends FlowBox {
 
       // phet-io
       tandem: Tandem.REQUIRED,
+      tandemSuffix: 'RadioButtonGroup',
       visiblePropertyOptions: { phetioFeatured: true },
       phetioEnabledPropertyInstrumented: true, // opt into default PhET-iO instrumented enabledProperty
 

diff --git a/js/Checkbox.ts b/js/Checkbox.ts
@@ -103,6 +103,7 @@ export default class Checkbox extends WidthSizable( Voicing( Node ) ) {
 
       // phet-io
       tandem: Tandem.REQUIRED,
+      tandemSuffix: 'Checkbox',
       phetioEventType: EventType.USER,
       visiblePropertyOptions: { phetioFeatured: true },
       phetioEnabledPropertyInstrumented: true, // opt into default PhET-iO instrumented enabledProperty

diff --git a/js/ComboBox.ts b/js/ComboBox.ts
@@ -233,6 +233,7 @@ export default class ComboBox<T> extends WidthSizable( Node ) {
 
       // phet-io
       tandem: Tandem.REQUIRED,
+      tandemSuffix: 'ComboBox',
       phetioType: ComboBox.ComboBoxIO,
       phetioEventType: EventType.USER,
       visiblePropertyOptions: { phetioFeatured: true },

diff --git a/js/ComboBoxListItemNode.ts b/js/ComboBoxListItemNode.ts
@@ -69,6 +69,7 @@ export default class ComboBoxListItemNode<T> extends Voicing( Node ) {
 
       // phet-io
       tandem: Tandem.REQUIRED,
+      tandemSuffix: 'Item',
 
       // Together, these options make it possible to reorder the combo box items in studio, and save a customized
       // simulation with the new order.

diff --git a/js/ExpandCollapseButton.ts b/js/ExpandCollapseButton.ts
@@ -46,7 +46,8 @@ export default class ExpandCollapseButton extends BooleanRectangularToggleButton
       touchAreaYDilation: 5,
 
       // phet-io
-      tandem: Tandem.REQUIRED
+      tandem: Tandem.REQUIRED,
+      tandemSuffix: 'Button'
     }, providedOptions );
 
     // BooleanRectangularToggleButtonOptions that are controlled by ExpandCollapseButton

diff --git a/js/NumberPicker.ts b/js/NumberPicker.ts
@@ -177,6 +177,7 @@ export default class NumberPicker extends AccessibleNumberSpinner( Node, 0 ) {
 
       // phet-io
       tandem: Tandem.REQUIRED,
+      tandemSuffix: 'Picker',
       phetioReadOnly: PhetioObject.DEFAULT_OPTIONS.phetioReadOnly,
       visiblePropertyOptions: { phetioFeatured: true },
       phetioEnabledPropertyInstrumented: true

diff --git a/js/NumberSpinner.ts b/js/NumberSpinner.ts
@@ -109,6 +109,7 @@ export default class NumberSpinner extends AccessibleNumberSpinner( Node, 0 ) {
 
       // PhET-iO
       tandem: Tandem.REQUIRED,
+      tandemSuffix: 'Spinner',
       phetioEnabledPropertyInstrumented: true // opt into default PhET-iO instrumented enabledProperty
     }, providedOptions );
 

diff --git a/js/PageControl.ts b/js/PageControl.ts
@@ -65,6 +65,7 @@ export default class PageControl extends Node {
 
       // NodeOptions
       tandem: Tandem.REQUIRED,
+      tandemSuffix: 'PageControl',
       visiblePropertyOptions: {
         phetioFeatured: true
       }

diff --git a/js/Slider.ts b/js/Slider.ts
@@ -219,6 +219,7 @@ export default class Slider extends AccessibleSlider( Node, 0 ) {
 
       // Supertype options
       tandem: Tandem.REQUIRED,
+      tandemSuffix: 'Slider',
       phetioType: Slider.SliderIO,
       visiblePropertyOptions: { phetioFeatured: true },
       phetioEnabledPropertyInstrumented: true // opt into default PhET-iO instrumented enabledProperty

diff --git a/js/SliderThumb.ts b/js/SliderThumb.ts
@@ -38,7 +38,8 @@ export default class SliderThumb extends Rectangle {
       fill: 'rgb( 50, 145, 184 )',
       stroke: 'black',
       lineWidth: 1,
-      tandem: Tandem.REQUIRED // Slider.js adds to this tandem to nest its dragListener under the thumb.
+      tandem: Tandem.REQUIRED, // Slider.js adds to this tandem to nest its dragListener under the thumb.
+      tandemSuffix: 'ThumbNode'
     }, providedOptions );
 
     // Set a default corner radius

diff --git a/js/SliderTrack.ts b/js/SliderTrack.ts
@@ -76,7 +76,8 @@ export default class SliderTrack extends Node {
       valueChangeSoundGeneratorOptions: {},
 
       // phet-io
-      tandem: Tandem.REQUIRED
+      tandem: Tandem.REQUIRED,
+      tandemSuffix: 'TrackNode'
     }, providedOptions );
 
     // If no sound generator was provided, create the default.

diff --git a/js/ToggleSwitch.ts b/js/ToggleSwitch.ts
@@ -110,6 +110,7 @@ export default class ToggleSwitch<T> extends Voicing( Node ) {
 
       // phet-io
       tandem: Tandem.REQUIRED,
+      tandemSuffix: 'Switch',
       phetioEventType: EventType.USER,
       phetioReadOnly: PhetioObject.DEFAULT_OPTIONS.phetioReadOnly,
       visiblePropertyOptions: { phetioFeatured: true },

diff --git a/js/buttons/BooleanRectangularToggleButton.ts b/js/buttons/BooleanRectangularToggleButton.ts
@@ -34,7 +34,8 @@ export default class BooleanRectangularToggleButton extends RectangularToggleBut
 
     const options = optionize<BooleanRectangularToggleButtonOptions, SelfOptions, RectangularToggleButtonOptions>()( {
       content: content,
-      tandem: Tandem.REQUIRED
+      tandem: Tandem.REQUIRED,
+      tandemSuffix: 'Button'
     }, providedOptions );
 
     super( booleanProperty, false, true, options );

diff --git a/js/buttons/BooleanRoundToggleButton.ts b/js/buttons/BooleanRoundToggleButton.ts
@@ -32,7 +32,8 @@ class BooleanRoundToggleButton extends RoundToggleButton<boolean> {
 
     const options = optionize<BooleanRoundToggleButtonOptions, SelfOptions, RoundToggleButtonOptions>()( {
       content: null,
-      tandem: Tandem.REQUIRED
+      tandem: Tandem.REQUIRED,
+      tandemSuffix: 'Button'
     }, providedOptions );
 
     const content = new BooleanToggleNode( booleanProperty, trueNode, falseNode, {

diff --git a/js/buttons/RectangularMomentaryButton.ts b/js/buttons/RectangularMomentaryButton.ts
@@ -36,7 +36,8 @@ export default class RectangularMomentaryButton<T> extends RectangularButton {
   public constructor( property: TProperty<T>, valueOff: T, valueOn: T, providedOptions?: RectangularMomentaryButtonOptions ) {
 
     const options = optionize<RectangularMomentaryButtonOptions, SelfOptions, RectangularButtonOptions>()( {
-      tandem: Tandem.REQUIRED
+      tandem: Tandem.REQUIRED,
+      tandemSuffix: 'Button'
     }, providedOptions );
 
     // Note it shares a tandem with this, so the emitter will be instrumented as a child of the button

diff --git a/js/buttons/RectangularPushButton.ts b/js/buttons/RectangularPushButton.ts
@@ -36,7 +36,8 @@ export default class RectangularPushButton extends RectangularButton {
 
     const options = optionize<RectangularPushButtonOptions, SelfOptions, SuperOptions>()( {
       soundPlayer: pushButtonSoundPlayer,
-      tandem: Tandem.REQUIRED
+      tandem: Tandem.REQUIRED,
+      tandemSuffix: 'Button'
     }, providedOptions );
 
     // Save the listener and add it after creating the button model.  This is done so that

diff --git a/js/buttons/RectangularRadioButton.ts b/js/buttons/RectangularRadioButton.ts
@@ -94,6 +94,7 @@ export default class RectangularRadioButton<T> extends RectangularButton {
 
       // phet-io
       tandem: Tandem.REQUIRED,
+      tandemSuffix: 'Button',
       phetioReadOnly: PhetioObject.DEFAULT_OPTIONS.phetioReadOnly // to support properly passing this to children, see https://github.com/phetsims/tandem/issues/60
     }, providedOptions );
 

diff --git a/js/buttons/RectangularRadioButtonGroup.ts b/js/buttons/RectangularRadioButtonGroup.ts
@@ -151,6 +151,7 @@ export default class RectangularRadioButtonGroup<T> extends FlowBox {
 
       // phet-io
       tandem: Tandem.REQUIRED,
+      tandemSuffix: 'ButtonGroup',
       visiblePropertyOptions: { phetioFeatured: true },
       phetioEnabledPropertyInstrumented: true, // opt into default PhET-iO instrumented enabledProperty
 

diff --git a/js/buttons/RectangularToggleButton.ts b/js/buttons/RectangularToggleButton.ts
@@ -47,7 +47,8 @@ export default class RectangularToggleButton<T> extends RectangularButton {
       valueOnSoundPlayer: toggleOnSoundPlayer,
 
       // phet-io support
-      tandem: Tandem.REQUIRED
+      tandem: Tandem.REQUIRED,
+      tandemSuffix: 'Button'
     }, providedOptions );
 
     // Note it shares a tandem with this, so the emitter will be instrumented as a child of the button

diff --git a/js/buttons/RoundMomentaryButton.ts b/js/buttons/RoundMomentaryButton.ts
@@ -35,7 +35,8 @@ export default class RoundMomentaryButton<T> extends RoundButton {
   public constructor( property: TProperty<T>, valueOff: T, valueOn: T, providedOptions?: RoundMomentaryButtonOptions ) {
 
     const options = optionize<RoundMomentaryButtonOptions, SelfOptions, RoundButtonOptions>()( {
-      tandem: Tandem.REQUIRED
+      tandem: Tandem.REQUIRED,
+      tandemSuffix: 'Button'
     }, providedOptions );
 
     // Note it shares a tandem with this, so the emitter will be instrumented as a child of the button

diff --git a/js/buttons/RoundPushButton.ts b/js/buttons/RoundPushButton.ts
@@ -37,7 +37,8 @@ export default class RoundPushButton extends RoundButton {
 
     const options = optionize<RoundPushButtonOptions, SelfOptions, SuperOptions>()( {
       soundPlayer: pushButtonSoundPlayer,
-      tandem: Tandem.REQUIRED
+      tandem: Tandem.REQUIRED,
+      tandemSuffix: 'Button'
     }, providedOptions );
 
     // Save the listener and add it after creating the button model. This is done so that

diff --git a/js/buttons/RoundStickyToggleButton.ts b/js/buttons/RoundStickyToggleButton.ts
@@ -42,7 +42,8 @@ export default class RoundStickyToggleButton<T> extends RoundButton {
       soundPlayer: pushButtonSoundPlayer,
 
       // RoundButtonOptions
-      tandem: Tandem.REQUIRED
+      tandem: Tandem.REQUIRED,
+      tandemSuffix: 'Button'
     }, providedOptions );
 
     // Note it shares a tandem with this, so the emitter will be instrumented as a child of the button

diff --git a/js/buttons/RoundToggleButton.ts b/js/buttons/RoundToggleButton.ts
@@ -47,7 +47,8 @@ export default class RoundToggleButton<T> extends RoundButton {
       valueOnSoundPlayer: toggleOnSoundPlayer,
 
       // phet-io support
-      tandem: Tandem.REQUIRED
+      tandem: Tandem.REQUIRED,
+      tandemSuffix: 'Button'
     }, providedOptions );
 
     // Note it shares a tandem with this, so the emitter will be instrumented as a child of the button

diff --git a/js/buttons/TextPushButton.ts b/js/buttons/TextPushButton.ts
@@ -36,6 +36,7 @@ export default class TextPushButton extends RectangularPushButton {
 
       // RectangularPushButtonOptions
       tandem: Tandem.REQUIRED,
+      tandemSuffix: 'Button',
       innerContent: text
     }, providedOptions );