Skip to content

VoicingRichText

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

Overview

RichText that composes ReadingBlock, adding support for Voicing and input listeners that speak content upon user activation.

Example usage: const voicingRichText = new VoicingRichText( 'Hello, world!' );

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

@author Jesse Greenberg (PhET Interactive Simulations)

Class VoicingRichText

import { VoicingRichText } from 'scenerystack/scenery';

Constructor

new VoicingRichText( text : string | TReadOnlyProperty<string>, providedOptions? : VoicingRichTextOptions )

Instance Methods

Type VoicingRichTextOptions

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

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

Source Code

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