Back to directory
quisido avatar

react-innertext

Returns the innerText of a React JSX object.. Read more below about its uses, features, and usage.

Clone repository

git clone https://github.com/quisido/react-innertext.git

53

Stars

4

Forks

1

Watchers

MIT

License

React innerText

version downloads

Returns the innerText of a React JSX object, similar to the innerText property of DOM elements.

Install

  • npm install react-innertext --save or
  • yarn add react-innertext

Use

ECMAScript, TypeScript

import innerText from 'react-innertext';
innerText(
  <div>
    Hello <strong>world</strong>!
    I am <span children={3} /> years old!
  </div>
) // 'Hello world! I am 3 years old!'

CommonJS

const innerText = require('react-innertext');
innerText(
  <div>
    Hello <strong>world</strong>!
    I am <span children={3} /> years old!
  </div>
) // 'Hello world! I am 3 years old!'

Real World Example

In the below example, the title attribute of the <th> element sanitizes the children prop. This allows the children to contain HTML or other React Elements, while providing a safe, plain text string for the title.

function MyTableHeader() {
  return (
    <thead>
      <tr>
        <MyTableHeaderCell>
          <b>Username</b>
          <SortButton />
        </MyTableHeaderCell>
      </tr>
    </thead>
  );
}

// title="Username"
function MyTableHeaderCell({ children }) {
  return (
    <th
      children={children}
      title={innerText(children)}
    />
  );
}

Releases

Jun 15, 2019

1.1.4

Download .zip

Bug Fixes 🐛

react-innertext now works in window-less environments, such as Node. #6 (Thanks @DimaRGB!)

New Features ✨

react-innertext now has TypeScript definitions built into the package.