Skip to content

RoundToggleButton

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

Overview

RoundToggleButton is a round toggle button that toggles the value of a Property between 2 values. It has the same look for both values.

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

Class RoundToggleButton

import { RoundToggleButton } from 'scenerystack/sun';

Constructor

new RoundToggleButton( property : Property<T>, valueOff : T, valueOn : T, providedOptions? : RoundToggleButtonOptions )

Instance Methods

dispose()

Type RoundToggleButtonOptions

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

Source Code

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