Release v3.0.1

Changes

• Simplifies the build by using babel-dual-package. The one notable change from this is the CJS build now uses a .cjs extension for source files and .cts for declaration files. These changes should be transparent to users, however.
• Simplifies the internal signature for creating the control icons when using the <TextToSpeech>. This does not affect the public API.

Release v3.0.0

Breaking Changes

• None, the package was always published as ESM. The major version was changed due to the package being defined as ESM (may be a violation of semver, but felt better to err on the side of caution).

Features

• CommonJS build is published through package.json exports.
• Consumers that happen to need a CJS version due to build requirements of their framework, for example older versions of Next.js, may now be able to remove any transpileModules configuration related to tts-react from their Next.js configuration file.

Changes

• Package is now defined as ESM, i.e. "type": "module".
• Changes min/max supported volumes from 0.01/0.99 to 0/1. Previous values were to support an edge case in Edge on Android.
• Project is now using npm workspaces.

Issues

• Closes #39
• Fixes #41

Release v2.0.1

• Attempts to fix the broken publish workflow.

Release v2.0.0 (DEPRECATED)

DEPRECATED

DO NOT USE THIS VERSION, IT IS AN EMPTY PUBLISH. INSTEAD USE v3.x.x.

Release v1.2.0

Features:

• Adds a UMD build.

Release v1.1.0

Features:

• Changes to ESM build.
• Increases browser coverage.
• Adds an export of BCP 47 Language Tags to use for SpeechSynthesisVoice.lang.

Release v1.0.1

Fixes:

• Consistent isPlaying state cross-browser by using native events to indicate playing state.
• Restores most inline styles for TextToSpeech controls and utilizes internal stylesheets better to prevent any FOUC during a useEffect.
• Clamps volume values to a min of 0.01 and a max of 0.99 for better cross-browser support of muting controls. In Edge on Android toggling muting with volume values of 0 and 1 was not being respected (0 would be ignored).

Release v1.0.0

First major version release.

BREAKING CHANGES:

• useTts
  • onReset renamed to replay
  • onPlay renamed to play
  • onStop renamed to stop
  • onPause renamed to pause
  • onPlayStop renamed to playOrStop
  • onPlayPause renamed to playOrPause
  • onToggleMute renamed to toggleMute

Features added:

• Event callbacks like onStart, onEnd, onPause, and onBoundary, which receive the underlying event object.
• More positions for the TextToSpeech component controls.

Release v0.8.1

• Revert to keeping logic of resume vs play in the onPlay handler returned from useTts. Stories were playing paused content from other stories.
• Additionally, call clear before playing to empty the utterance queue used by window.speechSynthesis.

Release v0.8.0

• Adds onEnd callback that gets invoked for SpeechSynthesisUtterance.end and HTMLMediaElement.ended events.
• Adds a rate parameter to set the initial SpeechSynthesisUtterance.rate or the HTMLMediaElement.defaultPlaybackRate.
• Adds a volume parameter to set the volume.
• Delegates handling of resume/play to the controller class behind useTts.

The volume and rate are clamped by their respective specs (HTMLMediaElement or SpeechSynthesisUtterance).