React Native TTS Reader

A simple and customizable text-to-speech (TTS) hook for React Native applications. This package provides an easy way to integrate TTS functionality into your app, allowing users to listen to text content.

Installation

To install the package, run:

npm install react-native-tts-reader

or

yarn add react-native-tts-reader

Usage

To use the useRead hook in your React Native application, follow these steps:

1. Import the hook:

import useRead from 'react-native-tts-reader/src/hooks/useRead';

2. Call the hook in your component:

const MyComponent = () => {
  const [
    doc,
    page,
    para,
    sentence,
    isReading,
    isPaused,
    shrill,
    speed,
    language,
    startReading,
    stopReading,
    resumeReading,
    pauseReading,
    forwardPage,
    forwardSentence,
    forwardPara,
    backPage,
    backPara,
    backSentence,
    jumpPage,
    setShrill,
    setSpeed,
    setLanaguage,
  ] = useRead(text);
  
  // Your component logic here
};

3. Use the provided methods to control the reading state and manage TTS functionality.

Example

An example application demonstrating the usage of the useRead hook can be found in the example directory. To run the example:

1. Navigate to the example directory:

cd example

2. Install the dependencies:

npm install

3. Run the application:

npm start

API Reference

Hook Return Values

| Parameter | Type | Description | |-----------|------|-------------| | doc | Page[] | Document pages array | | page | number | Current page index | | para | number | Current paragraph index | | sentence | number | Current sentence index | | isReading | boolean | Reading status | | isPaused | boolean | Pause status | | shrill | number | Voice pitch (1 is normal) | | speed | number | Reading speed (0.75 is normal) | | language | string | TTS language code |

Control Functions

• startReading(): Start reading from current position
• stopReading(): Stop reading and reset position
• pauseReading(): Pause reading
• resumeReading(): Resume from paused position
• forwardPage(): Move to next page
• backPage(): Move to previous page
• forwardPara(): Move to next paragraph
• backPara(): Move to previous paragraph
• forwardSentence(): Move to next sentence
• backSentence(): Move to previous sentence
• jumpPage(pageNumber): Jump to specific page

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.

License

MIT License

Copyright (c) 2025 Rajat Mishra

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

1. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

2. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.