phetsims / joist

Joist is the main framework for PhET Interactive Simulations. Joist creates and displays the simulation content, home screen, navigation bar, About dialog, enables switching between tabs, and other framework-related features.
MIT License
8 stars 6 forks source link

Add query parameters to customize Voicing features #968

Open jessegreenberg opened 1 month ago

jessegreenberg commented 1 month ago

We would like to make several public query parameters that customize the initial state of Voicing features. This came up in the context of an upcoming Voicing Report, which describes the featuer and its use cases in detail. We discussed the following query parameters, which are intended to be user friendly. They will support teachers and students loading sims with accessible configurations without requiring the student to navigate the Preferences dialog.

?voicingInitiallyEnabled - enables voicing on load with default settings
?voicingAddObjectResponses - enables object responses on load
?voicingAddContextResponses - enables context responses on load
?voicingAddHintResponses - enables hint responses on load
?voicingCollapseVoicingToolbar - loads with the voicing toolbar collapsed
?voicingRemoveVoicingToolbar - loads with the voicing toolbar removed

We discussed that browser audio auto play policy may sometimes prevent this from working smoothly on all platforms (especially Safari). But it is worth it to add them and make them available so that they can be used where possible. I will add them now and then we will add them to published Voicing sims in maintenance releases.

jessegreenberg commented 1 month ago

Ill review this with @terracoda before next steps.

terracoda commented 1 month ago

We can remove the second "Voicing":

?voicingCollapseToolbar - loads with the voicing toolbar collapsed ?voicingRemoveToolbar - loads with the voicing toolbar removed

jessegreenberg commented 1 month ago

Next steps:

jessegreenberg commented 1 month ago

Rename is done, ready for @terracoda to verify.

jessegreenberg commented 1 month ago

@terracoda reviewed and said they are good to go.