Skip to content

KeyboardHelpButton

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

Overview

The button that pops up the Keyboard Help Dialog, which appears in the right side of the navbar and to the left of the PhetButton.

@author Jesse Greenberg

Class KeyboardHelpButton

import { KeyboardHelpButton } from 'scenerystack/sim';

Constructor

new KeyboardHelpButton( screens : AnyScreen[], screenProperty : Property<AnyScreen>, backgroundColorProperty : TReadOnlyProperty<Color>, providedOptions : KeyboardHelpButtonOptions )

Instance Methods

Type KeyboardHelpButtonOptions

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

PickRequired<JoistButtonOptions, "tandem"> & Pick<JoistButtonOptions, "pointerAreaDilationX" | "pointerAreaDilationY">

Source Code

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