react-from-html
v0.1.5
Published
> Convert HTML into React components
Downloads
15
Readme
react-from-html
Convert HTML into React components
Intro
react-from-html allows you to convert individual DOM nodes into React components. This means you can use React components in non-React contexts.
You can go from this:
<div class="ShowMore" data-content="Hello, World!"></div>to this:
<ShowMore content="Hello, World!" />Quick Start
Install
npm install --save react-from-htmlMap your selectors to your components
import React from "react";
import reactFromHTML from "react-from-html";
// Your component
const ShowMore = ({ content }) => (
<div className="ShowMore" data-content={content} />
);
// Can be anywhere on page. You can also have multiple entry points.
const root = document.querySelector("body");
reactFromHTML(root, {
// Map all `.ShowMore` elements using a hydrator
".ShowMore": async el => <ShowMore content={el.dataset.content} />,
});API
reactFromHTML(root, hydrators, options)
Params:
- root: Element - Root element containing your components
- hydrators: Object - mapping functions
- key: String - The query selector for the component
- value: Func - A Hydrator Function, describing how to map this element to a React component (see below).
- Options: Object
- extra: Object - additional properties passed to each hydrator
- getQuerySelector: (key:String): String - a function for defining custom query selectors for each key
hydrator(el, hydrate, extra): ReactNode
Defined by you for each component you want to convert back into React. It maps an Element into a ReactNode.
- el: Element - the element for this component, as defined by the query selector
- hydrate(el): Func - a convenience, prebaked version of
reactFromHTMLused for hydrating child nodes. For example, convertinginnerHTMLinto React children. - extra: Object - additional params as defined in the initial
reactFromHTML()call.
Examples
Basic hydration
This example shows hydration of a basic component, with the single prop content that is assigned to a data attribute.
React
const ShowMore = ({ content }) => (
<div className="ShowMore" data-content={content} />
);
// <ShowMore content="Hello, World" />HTML
<body>
<div class="ShowMore" data-content="Hello, World"></div>
</body>Hydration
reactFromHTML(document.querySelector("body"), {
".ShowMore": async el => <ShowMore content={el.dataset.content} />,
});Advanced hydration
This example shows hydration of a more complex component, with multiple props, and children which may themselves need hydrating.
React
const Modal = ({ children }) => (
<div className="Modal">
<div class="Modal-title">{title}</div>
<div class="Modal-inner">{children}</div>
</div>
);
const ShowMore = ({ content }) => (
<div className="ShowMore" data-content={content} />
);
// <Modal title="My Modal">
// <ShowMore content="Hello, World">
// </Modal>HTML
<body>
<div class="Modal">
<div class="Modal-title">My Modal</div>
<div class="Modal-inner">
<div class="ShowMore" data-content="Hello, World"></div>
</div>
</div>
</body>Hydration
const ModalHydrator = async (el, hydrate) => (
<Modal title={el.querySelector(".Modal-title").innerHTML}>
{await hydrate(el.querySelector(".Modal-inner"))}
</Modal>
);
const ShowMoreHydrator = async el => <ShowMore content={el.dataset.content} />;
reactFromHTML(document.querySelector("body"), {
".Modal": ModalHydrator,
".ShowMore": ShowMoreHydrator,
});Acknowledgement
This package is based on the excellent react-from-markup from Simon Andrews.
LICENSE
MIT