Skip to content

VoicingText

Under Construction

This documentation is auto-generated, and is a work in progress. Please see the source code at https://github.com/phetsims/scenery/blob/main/js/accessibility/voicing/nodes/VoicingText.ts for the most up-to-date information.

Overview

Text that mixes ReadingBlock, supporting features of Voicing and adding listeners that speak the text string upon user input.

Example usage: const voicingText = new VoicingText( 'Hello, world!' );

Example usage: const voicingText = new VoicingText( 'Hello, world!', { accessibleParagraph: 'Custom Voicing Text' } );

@author Jesse Greenberg (PhET Interactive Simulations)

Class VoicingText

import { VoicingText } from 'scenerystack/scenery';

Constructor

new VoicingText( text : string | TReadOnlyProperty<string>, providedOptions? : VoicingTextOptions )

Instance Methods

Type VoicingTextOptions

import type { VoicingTextOptions } from 'scenerystack/scenery';

ReadingBlockOptions & StrictOmit<TextOptions, "innerContent" | "focusHighlight">

Source Code

See the source for VoicingText.ts in the scenery repository.