Skip to content

PhetButton

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/PhetButton.ts for the most up-to-date information.

Overview

The button that pops up the PhET menu, which appears in the bottom right of the home screen and on the right side of the navbar.

@author Sam Reid (PhET Interactive Simulations) @author Michael Kauzmann (PhET Interactive Simulations)

Class PhetButton

import { PhetButton } from 'scenerystack/sim';

Constructor

new PhetButton( sim : Sim, backgroundFillProperty : TReadOnlyProperty<Color>, tandem : Tandem )

Instance Methods

Static Properties

PhetButtonIO : IOType

(readonly)

PhET-iO Type for PhetButton, to interface with PhET-iO API. The PhetButtonIO acts as the main phet-io branding/logo in the sim. It doesn't inherit from NodeIO because we neither need all of NodeIO's API methods, nor do we want to support maintaining overriding no-ops in this file see https://github.com/phetsims/scenery/issues/711 for more info.

Source Code

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