Skip to content

RoundStickyToggleButton

Under Construction

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

Overview

RoundStickyToggleButton is a round toggle button that toggles the value of a Property between 2 values. It has a different look (referred to as 'up' and 'down') for the 2 values.

@author John Blanco (PhET Interactive Simulations) @author Sam Reid (PhET Interactive Simulations)

Class RoundStickyToggleButton

import { RoundStickyToggleButton } from 'scenerystack/sun';

Constructor

new RoundStickyToggleButton( valueProperty : TProperty<T>, valueUp : T, valueDown : T, providedOptions? : RoundStickyToggleButtonOptions )

Instance Methods

dispose()

Type RoundStickyToggleButtonOptions

import type { RoundStickyToggleButtonOptions } from 'scenerystack/sun';

Source Code

See the source for RoundStickyToggleButton.ts in the sun repository.