# react-innertext

> Returns the innerText of a React JSX object.

Latest version **1.1.5** (published 2019-06-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-innertext
pnpm add react-innertext
yarn add react-innertext
bun add react-innertext
```

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.1.5 |
| Published | 2019-06-15 |
| First published | 2018-05-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 50 |
| Author | Charles Stover |
| Maintainers | charlesstover |
| Keywords | innerText, jsx, react, reactjs |

## Links

- npm: https://www.npmjs.com/package/react-innertext
- Repository: https://github.com/CharlesStover/react-innertext
- Homepage: https://github.com/CharlesStover/react-innertext#readme
- Issues: https://github.com/CharlesStover/react-innertext/issues
- npm.io page: https://npm.io/package/react-innertext

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.1.5 (latest) — 2019-06-15
- 1.1.4 — 2019-06-15
- 1.1.3 — 2019-02-11
- 1.1.2 — 2018-07-19
- 1.1.1 — 2018-05-15
- 1.1.0 — 2018-05-15

## README

# React innerText [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=You%20can%20access%20the%20innerText%20of%20React%20components%20as%20if%20they%20were%20DOM%20nodes%20by%20using%20the%20react-innertext%20package.&url=https://github.com/CharlesStover/react-innertext&via=CharlesStover&hashtags=react,reactjs,javascript,webdev,webdeveloper,webdevelopment) [![version](https://img.shields.io/npm/v/react-innertext.svg)](https://www.npmjs.com/package/react-innertext) [![minzipped size](https://img.shields.io/bundlephobia/minzip/react-innertext.svg)](https://www.npmjs.com/package/react-innertext) [![downloads](https://img.shields.io/npm/dt/react-innertext.svg)](https://www.npmjs.com/package/react-innertext) [![build](https://travis-ci.com/CharlesStover/react-innertext.svg)](https://travis-ci.com/CharlesStover/react-innertext/)

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

## Install

* `npm install react-innertext` or
* `yarn add react-innertext`

## Use

### Client-Side Rendering (ES6)

```JS
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!'
```

### Server-Side Rendering (CommonJS)

```JS
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`.

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

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

---
_Source: https://npm.io/package/react-innertext · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._