1.0.25 • Published 1 year ago

react-read-text v1.0.25

Weekly downloads
-
License
ISC
Repository
github
Last release
1 year ago

react-read-text

Reads the text content of the given document id. Here's an example, open and click on "Start reading": https://react-read-text.vercel.app/

Feature highlight

How to use it

Install

yarn add react-read-text

Then

  const {
    reading,
    readingId,
    handleReading,
    handleStopReading,
    available,
  } = useTextReading({
    excludeChildIds: ["qset-code-block"],
  });
propTypeMeanining
readingBooleanIf it's currently reading a text
readingIdStringDocument id which you passed
handleReading(id: String) => voidPass the Document id you want to read
handleStopReading() => voidStop reading
availableBooleanReading is supported or not in the device

Style

You can customize the style of reading word by css classname reading-word. Add it to your style sheet and add styles to it.

Example

View the example code inside /example folder.

1.0.25

1 year ago

1.0.24

1 year ago

1.0.23

1 year ago

1.0.22

1 year ago

1.0.21

1 year ago

1.0.20

1 year ago

1.0.19

1 year ago

1.0.18

1 year ago

1.0.17

1 year ago

1.0.16

1 year ago