Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PhET-iO design review for 1.6 release #241

Closed
pixelzoom opened this issue Aug 30, 2022 · 5 comments
Closed

PhET-iO design review for 1.6 release #241

pixelzoom opened this issue Aug 30, 2022 · 5 comments

Comments

@pixelzoom
Copy link
Contributor

pixelzoom commented Aug 30, 2022

#239 (add support for dynamic locale) will certainly result in many API changes, and there have been many common-code API changes and additions. So this sim will require a full design review of the PhET-iO API.

This includes ph-scale-basics.

@pixelzoom
Copy link
Contributor Author

Related to phetsims/tandem#267 ... Tandem names for all Text nodes now have a "Text" suffix, for example "labelText", "titleText". This is an API change. See above commits.

@arouinfar
Copy link
Contributor

arouinfar commented Oct 6, 2022

Getting started on this now. Review will focus on:

@arouinfar
Copy link
Contributor

@pixelzoom I would like to feature model.dropper.visibleProperty. There is an example customization that requires hiding the dropper, so it makes sense to make it phetioFeatured: true.

I tried following the steps outlined in https://github.com/phetsims/phet-io-sim-specific/issues/11#issuecomment-1258969845, but it's just too complicated for me. I'll add comments in that issue, but I spent about 30 minutes and then bailed.

@pixelzoom here are the contents of the overrides. Can you please make the commits and regenerate the API files?

ph-scale-phet-io-overrides.js
/* eslint-disable */
window.phet.preloads.phetio.phetioElementsOverrides =
  {
    "phScale.macroScreen.model.autofillEnabledProperty": {
      "phetioFeatured": true
    },
    "phScale.macroScreen.model.dropper.soluteProperty": {
      "phetioFeatured": true
    },
    "phScale.macroScreen.model.dropper.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.macroScreen.model.pHMeter.pHProperty": {
      "phetioFeatured": true
    },
    "phScale.macroScreen.model.solution.pHProperty": {
      "phetioFeatured": true
    },
    "phScale.macroScreen.model.solution.soluteVolumeProperty": {
      "phetioFeatured": true
    },
    "phScale.macroScreen.model.solution.totalVolumeProperty": {
      "phetioFeatured": true
    },
    "phScale.macroScreen.model.solution.waterVolumeProperty": {
      "phetioFeatured": true
    },
    "phScale.macroScreen.view.beakerNode.tickMarks.tickLabels.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.macroScreen.view.beakerNode.tickMarks.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.macroScreen.view.drainFaucetNode.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.macroScreen.view.neutralIndicatorNode.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.macroScreen.view.pHMeterNode.pHIndicatorNode.numberDisplay.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.macroScreen.view.volumeIndicatorNode.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.macroScreen.view.waterFaucetNode.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.macroScreen.view.waterFaucetNode.waterText.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.model.autofillEnabledProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.model.dropper.soluteProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.model.dropper.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.model.solution.concentrationH2OProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.model.solution.concentrationH3OProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.model.solution.concentrationOHProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.model.solution.numberOfH2OMoleculesProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.model.solution.numberOfH3OMoleculesProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.model.solution.numberOfOHMoleculesProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.model.solution.pHProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.model.solution.quantityH2OProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.model.solution.quantityH3OProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.model.solution.quantityOHProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.model.solution.soluteVolumeProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.model.solution.totalVolumeProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.model.solution.waterVolumeProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.view.beakerControlPanel.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.view.beakerNode.tickMarks.tickLabels.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.view.beakerNode.tickMarks.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.view.drainFaucetNode.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.view.graphNode.expandedProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.view.graphNode.graphControlPanel.graphUnitsSwitch.concentrationText.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.view.graphNode.graphControlPanel.graphUnitsSwitch.quantityText.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.view.graphNode.graphControlPanel.graphUnitsSwitch.visibleProperty": {
      "phetioFeatured": false
    },
    "phScale.microScreen.view.graphNode.graphScaleProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.view.graphNode.graphScaleSwitch.linearText.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.view.graphNode.graphScaleSwitch.logarithmicText.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.view.graphNode.graphUnitsProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.view.graphNode.linearGraphNode.indicatorH2ONode.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.view.graphNode.linearGraphNode.indicatorH3ONode.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.view.graphNode.linearGraphNode.indicatorOHNode.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.view.graphNode.linearGraphNode.zoomButtonGroup.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.view.graphNode.linearGraphNode.zoomButtonGroup.zoomInButton.enabledProperty": {
      "phetioFeatured": false
    },
    "phScale.microScreen.view.graphNode.linearGraphNode.zoomButtonGroup.zoomInButton.visibleProperty": {
      "phetioFeatured": false
    },
    "phScale.microScreen.view.graphNode.linearGraphNode.zoomButtonGroup.zoomOutButton.enabledProperty": {
      "phetioFeatured": false
    },
    "phScale.microScreen.view.graphNode.linearGraphNode.zoomButtonGroup.zoomOutButton.visibleProperty": {
      "phetioFeatured": false
    },
    "phScale.microScreen.view.graphNode.logarithmicGraphNode.indicatorH2ONode.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.view.graphNode.logarithmicGraphNode.indicatorH3ONode.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.view.graphNode.logarithmicGraphNode.indicatorOHNode.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.view.graphNode.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.view.pHAccordionBox.expandedProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.view.ratioNode.ratioProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.view.viewProperties.moleculeCountVisibleProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.view.viewProperties.ratioVisibleProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.view.volumeIndicatorNode.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.view.waterFaucetNode.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.microScreen.view.waterFaucetNode.waterText.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.mySolutionScreen.model.solution.concentrationH2OProperty": {
      "phetioFeatured": true
    },
    "phScale.mySolutionScreen.model.solution.concentrationH3OProperty": {
      "phetioFeatured": true
    },
    "phScale.mySolutionScreen.model.solution.concentrationOHProperty": {
      "phetioFeatured": true
    },
    "phScale.mySolutionScreen.model.solution.numberOfH2OMoleculesProperty": {
      "phetioFeatured": true
    },
    "phScale.mySolutionScreen.model.solution.numberOfH3OMoleculesProperty": {
      "phetioFeatured": true
    },
    "phScale.mySolutionScreen.model.solution.numberOfOHMoleculesProperty": {
      "phetioFeatured": true
    },
    "phScale.mySolutionScreen.model.solution.pHProperty": {
      "phetioFeatured": true
    },
    "phScale.mySolutionScreen.model.solution.quantityH2OProperty": {
      "phetioFeatured": true
    },
    "phScale.mySolutionScreen.model.solution.quantityH3OProperty": {
      "phetioFeatured": true
    },
    "phScale.mySolutionScreen.model.solution.quantityOHProperty": {
      "phetioFeatured": true
    },
    "phScale.mySolutionScreen.model.solution.totalVolumeProperty": {
      "phetioFeatured": true
    },
    "phScale.mySolutionScreen.view.beakerControlPanel.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.mySolutionScreen.view.beakerNode.tickMarks.tickLabels.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.mySolutionScreen.view.beakerNode.tickMarks.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.mySolutionScreen.view.graphNode.expandedProperty": {
      "phetioFeatured": true
    },
    "phScale.mySolutionScreen.view.graphNode.graphControlPanel.graphUnitsSwitch.concentrationText.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.mySolutionScreen.view.graphNode.graphControlPanel.graphUnitsSwitch.quantityText.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.mySolutionScreen.view.graphNode.graphControlPanel.graphUnitsSwitch.visibleProperty": {
      "phetioFeatured": false
    },
    "phScale.mySolutionScreen.view.graphNode.graphUnitsProperty": {
      "phetioFeatured": true
    },
    "phScale.mySolutionScreen.view.graphNode.logarithmicGraphNode.indicatorH2ONode.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.mySolutionScreen.view.graphNode.logarithmicGraphNode.indicatorH3ONode.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.mySolutionScreen.view.graphNode.logarithmicGraphNode.indicatorOHNode.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.mySolutionScreen.view.graphNode.visibleProperty": {
      "phetioFeatured": true
    },
    "phScale.mySolutionScreen.view.pHAccordionBox.expandedProperty": {
      "phetioFeatured": true
    },
    "phScale.mySolutionScreen.view.ratioNode.ratioProperty": {
      "phetioFeatured": true
    },
    "phScale.mySolutionScreen.view.viewProperties.moleculeCountVisibleProperty": {
      "phetioFeatured": true
    },
    "phScale.mySolutionScreen.view.viewProperties.ratioVisibleProperty": {
      "phetioFeatured": true
    },
    "phScale.mySolutionScreen.view.volumeIndicatorNode.visibleProperty": {
      "phetioFeatured": true
    }
  };
ph-scale-basics-phet-io-overrides.js
/* eslint-disable */
window.phet.preloads.phetio.phetioElementsOverrides =
  {
    "phScaleBasics.macroScreen.model.autofillEnabledProperty": {
      "phetioFeatured": true
    },
    "phScaleBasics.macroScreen.model.dropper.soluteProperty": {
      "phetioFeatured": true
    },
    "phScaleBasics.macroScreen.model.dropper.visibleProperty": {
      "phetioFeatured": true
    },
    "phScaleBasics.macroScreen.model.pHMeter.pHProperty": {
      "phetioFeatured": true
    },
    "phScaleBasics.macroScreen.model.solution.pHProperty": {
      "phetioFeatured": true
    },
    "phScaleBasics.macroScreen.model.solution.soluteVolumeProperty": {
      "phetioFeatured": true
    },
    "phScaleBasics.macroScreen.model.solution.totalVolumeProperty": {
      "phetioFeatured": true
    },
    "phScaleBasics.macroScreen.model.solution.waterVolumeProperty": {
      "phetioFeatured": true
    },
    "phScaleBasics.macroScreen.view.beakerNode.tickMarks.tickLabels.visibleProperty": {
      "phetioFeatured": true
    },
    "phScaleBasics.macroScreen.view.beakerNode.tickMarks.visibleProperty": {
      "phetioFeatured": true
    },
    "phScaleBasics.macroScreen.view.drainFaucetNode.visibleProperty": {
      "phetioFeatured": true
    },
    "phScaleBasics.macroScreen.view.neutralIndicatorNode.visibleProperty": {
      "phetioFeatured": true
    },
    "phScaleBasics.macroScreen.view.pHMeterNode.pHIndicatorNode.numberDisplay.visibleProperty": {
      "phetioFeatured": true
    },
    "phScaleBasics.macroScreen.view.volumeIndicatorNode.visibleProperty": {
      "phetioFeatured": true
    },
    "phScaleBasics.macroScreen.view.waterFaucetNode.visibleProperty": {
      "phetioFeatured": true
    },
    "phScaleBasics.macroScreen.view.waterFaucetNode.waterText.visibleProperty": {
      "phetioFeatured": true
    }
  };

@arouinfar arouinfar assigned pixelzoom and unassigned arouinfar Dec 2, 2022
pixelzoom added a commit to phetsims/ph-scale-basics that referenced this issue Dec 2, 2022
@pixelzoom
Copy link
Contributor Author

@arouinfar Done - model.dropper.visibleProperty is now featured. Back to you for review.

@pixelzoom pixelzoom assigned arouinfar and unassigned pixelzoom Dec 2, 2022
@arouinfar
Copy link
Contributor

Thanks @pixelzoom! Looks good in master. That's it for this issue, closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants