SliderControlsKeyboardHelpSection¶

Overview¶

Content for a KeyboardHelpDialog that describes how to use sliders.

@author Jesse Greenberg

Class SliderControlsKeyboardHelpSection¶

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

Constructor¶

new SliderControlsKeyboardHelpSection( providedOptions? : SliderControlsKeyboardHelpSectionOptions )¶

Instance Methods¶

Static Properties¶

ArrowKeyIconDisplay¶

(readonly)

Class ArrowKeyIconDisplay¶

Configurations of arrow keys that can be displayed for 'Move between items in a group'

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

Static Properties¶

UP_DOWN : ArrowKeyIconDisplay¶

(readonly)

LEFT_RIGHT : ArrowKeyIconDisplay¶

(readonly)

BOTH : ArrowKeyIconDisplay¶

(readonly)

enumeration : Enumeration¶

(readonly)

Type SliderControlsKeyboardHelpSectionOptions¶

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

• arrowKeyIconDisplay?: ArrowKeyIconDisplay
  Whether to show up/down, left/right or both sets of keyboard help icons to cue the slider interaction.
• headingStringProperty?: TReadOnlyProperty<string>
  heading string for this content
• adjustSliderStringProperty?: TReadOnlyProperty<string>
  custom string for the "Adjust Slider" row
• adjustInSmallerStepsStringProperty?: TReadOnlyProperty<string>
  custom string for the "Adjust in Smaller Steps" row
• adjustInLargerStepsStringProperty?: TReadOnlyProperty<string>
  custom string for the "Adjust in Larger Steps" row
• verbStringProperty?: TReadOnlyProperty<string>
  verb used to describe the movement of the slider - this will be filled into the default pattern for each row so you cannot use this and the other string options at the same time
• sliderStringProperty?: TReadOnlyProperty<string>
  name to call the slider (lowercase), default to "slider" - this will be filled into the default pattern for each row so you cannot use this and the other string options at the same time
• maximumStringProperty?: TReadOnlyProperty<string>
  Strings for extremities to support shortcuts like "jump to maximum" (renaming "maximum" if desired. @deprecated - use jumpToMaximumStringProperty and jumpToMinimumStringProperty instead.
• minimumStringProperty?: TReadOnlyProperty<string>
• jumpToMaximumStringProperty?: TReadOnlyProperty<string>
  Custom strings for the full 'Jump to Minimum' and 'Jump to Maximum' rows. Mutually exclusive with minimumStringProperty and maximumStringProperty.
• jumpToMinimumStringProperty?: TReadOnlyProperty<string>
• includeSmallerStepsRow?: boolean
  Determines whether this keyboard help section will have the "Adjust in Smaller Steps" row.
• includeLargerStepsRow?: boolean
  Determines whether this keyboard help section will have the "Adjust in Larger Steps" row.
• additionalRows?: KeyboardHelpSectionRow[]
  Sometimes a slider has custom key commands. Provide additional rows for those commands and they will be added below default slider controls content.
• & KeyboardHelpSectionOptions

Source Code¶

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