Closed arouinfar closed 2 years ago
I made preferences tabs and their visibleProperties phetioFeatured: true in the commit.
The preferencesModel is overwhelming, especially for sims that do not leverage all those features. It seems best to start with that subset being phetioFeatured for the next few releases.
If we only want to feature the stateful properties, then voicingEnabledProperty should be phetioFeatured: false.
I'll mark it as phetioFeatured: false in the next commit.
OK fixed and ready for review, the featured tree now looks like this for GAO:
And the tabs and their visibleProperties are now featured.
Thanks @samreid. Master generally looks good, but I think you may have accidentally unfeatred colorProfileProperty
. It's stateful and cited in an example customization in the guide, so I think it should remain phetioFeatured: true
.
Thanks, I added that. Can you please test on phet-dev?
Thanks @samreid, looks good!
In https://github.com/phetsims/molecule-shapes/issues/230 and https://github.com/phetsims/gravity-and-orbits/issues/470, QA reported that
preferencesDialog.preferencesTabs.LocalizationTab.visibleProperty
was missing from the tree. It's not actually missing, but I realized that it wasn'tphetioFeatured: true
. It seems reasonable to feature anyphetioID
mentioned in the Preferences section PhET-iO Guide, so I reviewed the tree to see what else should be featured.The guide describes how to hide the preferences tabs in the dialog, so I think we should feature
preferencesDialogCapsule.archetype.preferencesTabs.*Tab.visibleProperty
.I also found this in the guide:
The only elements linked under the
preferencesModel
that we specifically refer to in the documentation are the stateful properties:audioEnabledProperty
,localeProperty
, andcolorProfileProperty
. These are allphetioFeatured: true
. However, the quote above suggests that users may want to inspect all of thepreferencesModel
contents, which they can only do if viewing "All" elements. Here's whatpreferencesModel
looks like when viewing Featured vs. All elements.Should we feature all of the target elements collected here? Or should we specify that users should view "All" elements when inspecting the
preferencesModel
? If we only want to feature the stateful properties, thenvoicingEnabledProperty
should bephetioFeatured: false
.For the foreseeable future, most of the properties under
preferencesModel
aren't actually applicable to most sims, so I am leaning towards just featuring the stateful properties. @zepumph @samreid what would you advise?