NavigationBarAudioToggleButton¶

Under Construction

This documentation is auto-generated, and is a work in progress. Please see the source code at https://github.com/phetsims/joist/blob/main/js/NavigationBarAudioToggleButton.ts for the most up-to-date information.

Overview¶

NavigationBarAudioToggleButton is a button for controlling whether audio is enabled or disabled that is designed to work on the PhET navigation bar. Audio includes all auditory features in the sim, so when this is button is toggled "off", the sim should be totally silent.

If you're wondering why this is drawn in code rather than using a Font Awesome node, please see https://github.com/phetsims/tambo/issues/19.

@author John Blanco @author Chris Klusendorf

Class NavigationBarAudioToggleButton¶

import { NavigationBarAudioToggleButton } from 'scenerystack/sim';

Constructor¶

new NavigationBarAudioToggleButton( soundEnabledProperty : BooleanProperty, backgroundColorProperty : TReadOnlyProperty<Color>, providedOptions : NavigationBarAudioToggleButtonOptions )¶

Instance Methods¶

Source Code¶

See the source for NavigationBarAudioToggleButton.ts in the joist repository.