JSPM – @mhpdev/react-native-speech@1.2.1

Package Exports

@mhpdev/react-native-speech
@mhpdev/react-native-speech/lib/module/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@mhpdev/react-native-speech) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

A high-performance text-to-speech library built for bare React Native and Expo, compatible with Android and iOS. It enables seamless speech management and provides events for detailed synthesis management.

Documentation · Example

Only New Architecture: This library is only compatible with the new architecture. If you're using React Native 0.76 or higher, it is already enabled. However, if your React Native version is between 0.68 and 0.75, you need to enable it first. Click here if you need help enabling the new architecture

Preview

Android	iOS
Android Preview	iOS Preview

Features

🚀 High Performance - Built on Turbo Modules for a fast, native-like experience on Android & iOS
🎛️ Full Control - Complete set of methods for comprehensive speech synthesis management
🪄 Consistent Playback - Offers pause and resume support for iOS and Android. Since this functionality isn’t natively available on Android, the library provides a custom implementation (API 26+) designed to emulate the iOS experience
🔊 Optional Audio Ducking - Automatically lowers other app audio to ensure clear, uninterrupted speech
📡 Rich Events - Comprehensive event system for precise synthesis lifecycle monitoring
💅 Visual Feedback - Customizable HighlightedText component for real-time speech visualization
✅ Type Safety - Fully written in TypeScript with complete type definitions

Installation

Bare React Native

Install the package using either npm or Yarn:

npm install @mhpdev/react-native-speech

Or with Yarn:

yarn add @mhpdev/react-native-speech

For iOS, navigate to the ios directory and install the pods:

cd ios && pod install

Expo

For Expo projects, follow these steps:

Install the package:

npx expo install @mhpdev/react-native-speech

Since it is not supported on Expo Go, run:
```
npx expo prebuild
```

Usage

To learn how to use the library, check out the usage section.

Quick Start

import React from 'react';
import Speech from '@mhpdev/react-native-speech';
import {SafeAreaView, StyleSheet, Text, TouchableOpacity} from 'react-native';

const App: React.FC = () => {
  const onSpeakPress = () => {
    Speech.speak('Hello World!');
  };

  return (
    <SafeAreaView style={styles.container}>
      <TouchableOpacity style={styles.button} onPress={onSpeakPress}>
        <Text style={styles.buttonText}>Speak</Text>
      </TouchableOpacity>
    </SafeAreaView>
  );
};

export default App;

const styles = StyleSheet.create({
  container: {
    flex: 1,
    alignItems: 'center',
    justifyContent: 'center',
  },
  button: {
    padding: 12.5,
    borderRadius: 5,
    backgroundColor: 'skyblue',
  },
  buttonText: {
    fontSize: 22,
    fontWeight: '600',
  },
});

To become more familiar with the usage of the library, check out the example project.

Testing

To mock the package's methods and components using the default mock configuration provided, follow these steps:

Create a file named @mhpdev/react-native-speech.ts inside your __mocks__ directory.

Copy the following code into that file:

module.exports = require('@mhpdev/react-native-speech/jest');

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT