https://github.com/jonathanconway/react-sr-pronounce

A React component that lets you control how content is pronounced by screen-readers.
https://github.com/jonathanconway/react-sr-pronounce

Last synced: about 12 hours ago
JSON representation

A React component that lets you control how content is pronounced by screen-readers.

• Host: GitHub
• URL: https://github.com/jonathanconway/react-sr-pronounce
• Owner: jonathanconway
• License: mit
• Created: 2017-06-16T04:22:30.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-06-16T04:43:06.000Z (over 7 years ago)
• Last Synced: 2024-04-25T12:43:22.548Z (9 months ago)
• Language: JavaScript
• Homepage: http://jonathanconway.co/react-sr-pronounce
• Size: 350 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# react-sr-pronounce

A React component that lets you control how content is pronounced by screen-readers. It does this using the [`ruby`](https://www.w3.org/wiki/HTML/Elements/ruby) element. The trick is described in an answer to the Stackoverflow question [#43491644](https://stackoverflow.com/a/43491802/23341).

## Installation

Install with npm (or yarn).

```sh

npm install react-sr-pronounce --save

```

## Usage

```

import React, { Component } from 'react';

import { HashRouter } from 'react-router-dom';

import SrPronounce from 'react-sr-pronounce';

export default class App extends Component {

  render() {

    return (

      


        In this sentence, record is pronounced as a noun.

      

    );

  }

}

```


## Demo

Try out the [live example](http://jonathanconway.co/react-sr-pronounce).

## Support

Tested with:

* VoiceOver on macOS Sierra 10.12.5 in Chrome

## License

[MIT](LICENSE). Copyright (c) 2017 Jonathan Conway.