File tree Expand file tree Collapse file tree 1 file changed +35
-1
lines changed Expand file tree Collapse file tree 1 file changed +35
-1
lines changed Original file line number Diff line number Diff line change @@ -4,8 +4,9 @@ An HTML to React parser.
44
55``` js
66var Parser = require (' html-react-parser' );
7- var reactElement = Parser (' <p>Hello, world!</p> ' );
7+ // Parser(htmlString[, options] );
88
9+ var reactElement = Parser (' <p>Hello, world!</p>' );
910// ReactDOM.render(reactElement, node);
1011```
1112
@@ -15,6 +16,39 @@ var reactElement = Parser('<p>Hello, world!</p>');
1516$ npm install html-react-parser
1617```
1718
19+ ## Usage
20+
21+ Render to DOM:
22+
23+ ``` js
24+ var Parser = require (' html-react-parser' );
25+ var ReactDOM = require (' react-dom' );
26+
27+ // single element
28+ ReactDOM .render (
29+ Parser (' <p>single</p>' ),
30+ document .getElementById (' single' )
31+ );
32+
33+ // adjacent elements
34+ ReactDOM .render (
35+ React .createElement (' div' , {}, Parser (' <p>one</p><p>two</p>' ))
36+ document .getElementById (' adjacent' )
37+ );
38+
39+ // nested elements
40+ ReactDOM .render (
41+ Parser (' <ul><li>inside</li></ul>' ),
42+ document .getElementedById (' nested' )
43+ );
44+
45+ // attributes are preserved
46+ ReactDOM .render (
47+ Parser (' <section id="foo" class="bar baz" data-qux="42">look at me now</section>' ),
48+ document .getElementById (' attributes' )
49+ );
50+ ```
51+
1852## Testing
1953
2054``` sh
You can’t perform that action at this time.
0 commit comments