rts

react-to-string

Convert React elements to strings

Showing:

Popularity

Downloads/wk

3.8K

GitHub Stars

8

Maintenance

Last Commit

3yrs ago

Contributors

3

Package

Dependencies

0

Size (min+gzip)

0.5KB

License

Type Definitions

Tree-Shakeable

No?

Categories

Readme

React-To-String TravisCI status CircleCI

Convert React elements to strings 👌

React-To-String allows you to easily convert React elements to pure strings - no HTML tags, no react attributes - just strings.

This is useful for when you might want to toggle between eventful & styled React elements & a pure string version of those elements.

React-To-String itself has 0 dependencies and has a minimized bundle size of 1kb. ⚡

You can use React-To-String to easily convert complex react-elements like:

<div>
  <p>
    Feeling <a href="/tired">tired</a>? Need some <a href="/food">food</a>?
    { ' ' }
    <button>Try React-To-String!</button>
    { ' ' }
    <span className="small-text">
      Disclaimer: This library only converts React elements to strings.
    </span>
  </p>
</div>

to

Feeling tired? Need some food? Try React-To-String! Disclaimer: This library only converts React elements to strings.

Installation

To install, use your package manager to install react-to-string:

npm install --save react-to-string

or

yarn add react-to-string

Usage

import React, { Component } from 'react';
import reactToString from 'react-to-string';

class App extends Component {
  render() {
    return <div>Hello world!</div>
  }
}

reactToString(<App />);
// Returns "Hello world!"

reactToString(<p>Are you interested in this library? <a href="signup">Click here!</a></p>);
// Returns "Are you interested in this library? Click here!"

Note: This example uses ES6 syntax, if you are using ES5 require syntax, make sure to require react-to-string as a ES6 module like so:

var reactToString = require('react-to-string').default

API

reactToString(element: React element || String || Array (Strings or ReactElements)) : Function => String

Takes in a React element and traverses its children to return a pure string.

Note: react-to-string always returns a string. If an undefined or some other unknown object is passed is provided as an argument, react-to-string will return an empty string.

Development

React-To-String uses jest to handle tests. To develop React-To-String locally:

  1. Clone this repo and cd into the newly cloned folder.
  2. Install dev dependencies by running npm install or yarnRun npm test or yarn test to run the test suite.
  3. Run npm test or yarn test to run the test suite.

Looking for server-side rendering or string output with HTML tags?

React-To-String won't be able to do that for you, but you can find more about server-side rendering or string output with HTML tags (static markup) with React at the official docs here: https://facebook.github.io/react/docs/react-dom-server.html

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100