TimeControlsKeyboardHelpSection¶

Overview¶

Help section that explains how to use a keyboard to toggle play/pause and time controls.

@author Jesse Greenberg (PhET Interactive Simulations)

Class TimeControlsKeyboardHelpSection¶

import { TimeControlsKeyboardHelpSection } from 'scenerystack/scenery-phet';

Constructor¶

new TimeControlsKeyboardHelpSection( providedOptions? : TimeControlKeyboardHelpSectionOptions )¶

Instance Methods¶

Type TimeControlKeyboardHelpSectionOptions¶

import type { TimeControlKeyboardHelpSectionOptions } from 'scenerystack/scenery-phet';

• headingString?: string | TReadOnlyProperty<string>
  The heading string for this section of keyboard help content
• pauseOrPlayActionStringProperty?: TReadOnlyProperty<string>
  Visible string that describes the action of pause/play from a key command. You may want sim-specific terminology for this command.
• pauseOrPlayActionDescriptionString?: string | TReadOnlyProperty<string>
  String for the PDOM (screen readers) that describes the hotkeys for play/pause.
• & KeyboardHelpSectionOptions

Source Code¶

See the source for TimeControlsKeyboardHelpSection.ts in the scenery-phet repository.