Skip to content

HomeScreenButton

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

Overview

A HomeScreenButton is displayed on the HomeScreen for choosing a screen. The button can be in a selected or unselected state - it's large with a yellow frame in its selected state, and small in its unselected state. Selecting the button when in its "selected" state will result in that screen being chosen.

@author Michael Kauzmann (PhET Interactive Simulations) @author Chris Klusendorf (PhET Interactive Simulations)

Class HomeScreenButton

import { HomeScreenButton } from 'scenerystack/sim';

Constructor

new HomeScreenButton( screen : Screen<IntentionalAny, IntentionalAny>, homeScreenModel : HomeScreenModel, providedOptions? : HomeScreenButtonOptions )

Instance Methods

Instance Properties

screen : Screen<IntentionalAny, IntentionalAny>

(readonly)

Type HomeScreenButtonOptions

import type { HomeScreenButtonOptions } from 'scenerystack/sim';

Source Code

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