react-dynamic-html v3.0.1

react-dynamic-html

Like dangerouslySetInnerHTML but with simple old-school template substitution, where values can be React components.

Because sometimes you just need to work with HTML from an older system or CMS.

• Tiny <1KB client-side bundle, no dependencies necessary
• Template values can be dynamic React components
• Universal, supports server side rendering (SSR)
• Components get the correct context from above
• Template updates even preserve component state!

Example

import Template from "react-dynamic-html";

/**
 * This app shows off rendering interactive React components and
 * dynamic values into an HTML string.
 */
class App extends React.Component {
  state = {
    name: "Alice"
  };

  toggleName = () => {
    this.setState(state => ({
      name: state.name === "Alice" ? "Bob" : "Alice"
    }));
  };

  render() {
    return (
      <Template
        string={`
          <h1>Hey, {name}!</h1>
          <p>Click here: {button}</p>
        `}
        values={{
          name: this.state.name,
          button: <button onClick={this.toggleName}>Toggle</button>
        }}
      />
    );
  }
}

API

Template

Props

The DOM element type in which to render the entire template.

The DOM element type in which to render React element values by default. To override the tag for individual values, use valueTags.

Whether or not to escape values inserted into the HTML.

The template HTML string.

The string or RegExp that specifies the variable substitution syntax. Each instance will be replaced. The second capture group should be the name of the variable.

An object mapping variable names (used in the template string) to their values. React element values will be rendered into a placeholder node.

The DOM element type in which to render specific React elements that appear in values. Only React elements are wrapped.

Other Solutions

This library should pretty much be a last resort. Here’s some advice:

If you can preprocess the HTML into a simple AST and serve that to your app instead, do that. Then you can easily translate nodes into React.createElement calls. Everything will be easier and React will be happy. (This library does exactly that during server-side rendering in order to render with the correct context, but doing this client-side requires large dependencies.)

If your HTML authors are technical and are editing raw HTML, you can avoid parsing {placeholders} and instead come up with some fancy data- attributes to indicate how to transform certain elements in React components (even allowing them to pass simple props). Then you just need to find and replace these nodes after mounting. (As above, you’ll still need an HTML parser on the server.)

If the HTML comes from a WYSIWYG editor where special {placeholder} syntax is more accessible, and you just need to stick React components (like interactive buttons) and text in a few places, use this library.