Adjust RichText stringProperty API to accept read-only Properties sim…

…ilarly to Text, see #1671
phetsims · Nov 5, 2024 · 2275077 · 2275077
1 parent e1300ab
commit 2275077
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/js/nodes/RichText.ts b/js/nodes/RichText.ts
@@ -452,12 +452,15 @@ export default class RichText extends WidthSizable( Node ) {
 
   /**
    * See documentation for Node.setVisibleProperty, except this is for the text string.
+   *
+   * NOTE: Setting the .string after passing a truly read-only Property will fail at runtime. We choose to allow passing
+   * in read-only Properties for convenience.
    */
-  public setStringProperty( newTarget: TProperty<string> | null ): this {
-    return this._stringProperty.setTargetProperty( newTarget, this, RichText.STRING_PROPERTY_TANDEM_NAME );
+  public setStringProperty( newTarget: TReadOnlyProperty<string> | null ): this {
+    return this._stringProperty.setTargetProperty( newTarget as TProperty<string>, this, RichText.STRING_PROPERTY_TANDEM_NAME );
   }
 
-  public set stringProperty( property: TProperty<string> | null ) { this.setStringProperty( property ); }
+  public set stringProperty( property: TReadOnlyProperty<string> | null ) { this.setStringProperty( property ); }
 
   public get stringProperty(): TProperty<string> { return this.getStringProperty(); }
 

diff --git a/js/nodes/Text.ts b/js/nodes/Text.ts
@@ -199,6 +199,9 @@ export default class Text extends Paintable( Node ) {
 
   /**
    * See documentation for Node.setVisibleProperty, except this is for the text string.
+   *
+   * NOTE: Setting the .string after passing a truly read-only Property will fail at runtime. We choose to allow passing
+   * in read-only Properties for convenience.
    */
   public setStringProperty( newTarget: TReadOnlyProperty<string> | null ): this {
     return this._stringProperty.setTargetProperty( newTarget as TProperty<string>, this, Text.STRING_PROPERTY_TANDEM_NAME );