Rename MAX_WIDTH to TEXT_MAX_WIDTH and document, see phetsims/my-sola…

…r-system#95
phetsims · Mar 15, 2023 · e330bfe · e330bfe
1 parent 5a22788
commit e330bfe
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/js/SolarSystemCommonConstants.ts b/js/SolarSystemCommonConstants.ts
@@ -16,8 +16,8 @@ const SolarSystemCommonConstants = {
   SCREEN_VIEW_X_MARGIN: 15,
   SCREEN_VIEW_Y_MARGIN: 15,
 
-  //REVIEW: maximum width for.... what? Should be documented, and possibly renamed to something more informative
-  MAX_WIDTH: 200,
+  // Max width for many of the text labels
+  TEXT_MAX_WIDTH: 200,
 
   CONTROL_PANEL_OPTIONS: {
     stroke: null,

diff --git a/js/view/BodyNode.ts b/js/view/BodyNode.ts
@@ -82,7 +82,7 @@ export default class BodyNode extends ShadedSphereNode {
 
       textOptions: {
         fill: 'white', // Not a colorProperty because it is not dynamic
-        maxWidth: SolarSystemCommonConstants.MAX_WIDTH,
+        maxWidth: SolarSystemCommonConstants.TEXT_MAX_WIDTH,
         font: new PhetFont( 16 )
       },
 

diff --git a/js/view/createArrowsVisibilityCheckboxes.ts b/js/view/createArrowsVisibilityCheckboxes.ts
@@ -22,7 +22,7 @@ import solarSystemCommon from '../solarSystemCommon.js';
 const ARROW_Y_COORDINATE = -10;
 
 const TEXT_OPTIONS = combineOptions<TextOptions>( {
-  maxWidth: SolarSystemCommonConstants.MAX_WIDTH
+  maxWidth: SolarSystemCommonConstants.TEXT_MAX_WIDTH
 }, SolarSystemCommonConstants.TEXT_OPTIONS );
 
 const SPACING = 10;

diff --git a/js/view/createVisibilityInformationCheckboxes.ts b/js/view/createVisibilityInformationCheckboxes.ts
@@ -25,7 +25,7 @@ import pathIconProjector_png from '../../images/pathIconProjector_png.js';
 
 // constants
 const TEXT_OPTIONS = combineOptions<TextOptions>( {
-  maxWidth: SolarSystemCommonConstants.MAX_WIDTH
+  maxWidth: SolarSystemCommonConstants.TEXT_MAX_WIDTH
 }, SolarSystemCommonConstants.TEXT_OPTIONS );
 
 const createVisibilityInformationCheckboxes = ( model: SolarSystemCommonModel, tandem: Tandem ): SolarSystemCommonCheckbox[] => {