Skip to content

BasicActionsKeyboardHelpSection

Overview

General help information for how to navigation a simulation with a keyboard. In general, this file supports a fair number of options, like displaying group content, or shortcuts for checkbox interaction. The algorithm this type implements set all the optional potential rows as null, and then fills them in if the options is provided. Then at the end anything that is null is filtered out.

@author Jesse Greenberg (PhET Interactive Simulations) @author Michael Kauzmann (PhET Interactive Simulations)

Class BasicActionsKeyboardHelpSection

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

Constructor

new BasicActionsKeyboardHelpSection( providedOptions? : BasicActionsKeyboardHelpSectionOptions )

Instance Methods

Type BasicActionsKeyboardHelpSectionOptions

import type { BasicActionsKeyboardHelpSectionOptions } from 'scenerystack/scenery-phet';
  • withCheckboxContent?: boolean
    if true, the help content will include information about how to interact with checkboxes
  • withKeypadContent?: boolean
    if true, the help content will include information about how to interact with a keypad
  • & KeyboardHelpSectionOptions

Source Code

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