RectangularRadioButton¶

Overview¶

RectangularRadioButton is a single rectangular radio button. It typically appears as part of a RectangularRadioButtonGroup, but can be used in other context.

@author Aaron Davis (PhET Interactive Simulations)

Class RectangularRadioButton¶

import { RectangularRadioButton } from 'scenerystack/sun';

Constructor¶

new RectangularRadioButton( property : TProperty<T>, value : T, providedOptions? : RectangularRadioButtonOptions )¶

Instance Methods¶

dispose()¶

fire()¶

fire on up if the button is enabled, public for use in the accessibility tree

Instance Properties¶

property : TProperty<T>¶

(readonly)

the Property this button changes

value : T¶

(readonly)

the value that is set to the Property when this button is pressed

interactionStateProperty : RadioButtonInteractionStateProperty<T>¶

(readonly)

Static Properties¶

FlatAppearanceStrategy : TButtonAppearanceStrategy¶

(readonly)

FlatAppearanceStrategy is a value for RectangularRadioButton options.buttonAppearanceStrategy. It makes radio buttons that look flat, i.e. no shading or highlighting, but that change color on mouseover, press, selected, etc.

ContentAppearanceStrategy : TContentAppearanceStrategy¶

(readonly)

ContentAppearanceStrategy is a value for RectangularRadioButton options.contentAppearanceStrategy. It changes their look based on the value of interactionStateProperty.

Type RectangularRadioButtonOptions¶

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

• soundPlayer?: TSoundPlayer | null
  Sound generation - If set to null a default will be used that is based on this button's position within the radio button group. Can be set to nullSoundPlayer to turn off all sound generation.
• & StrictOmit<TrimParallelDOMOptions<RectangularButtonOptions>, "enabledProperty" | "enabled">

Source Code¶

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