jsx-to-string
Parse your React JSX components to string
Install
npm install jsx-to-string
Usage
;;// or var jsxToString = require('jsx-to-string'); let Basic = React; //this is your react component console; //outputs: <Basic test1="test" />
Defaults
- The default value for function is
...
. UsekeyValueOverride
for custom key values.
Options
-
useFunctionCode (boolean)
Optional. Defaults to false. Whether or not to use the function actual source code instead of
...
For example:
;;//or var jsxToString = require('jsx-to-string'); let Basic = React; //this is your react component let { //no-op}console; //outputs: <Basic onClick={function _onClickHandler() { //no-op }} />
-
functionNameOnly (boolean)
Optional. Defaults to false. Whether prop function values should contain only the name. This flag will only be used if
useFunctionCode
is set to true.For example:
;;//or var jsxToString = require('jsx-to-string'); let Basic = React; //this is your react component let {//no-op}console; //outputs: <Basic onClick={_onClickHandler} />
-
keyValueOverride (object)
A key-value map that overrides the value of any React props with exact match with the given key. For example:
;;//or var jsxToString = require('jsx-to-string'); let Basic = React; //this is your react component let { //no-op}console; //outputs: <Basic onClick={_onClickHandler} />
-
ignoreProps (array)
An array of string keys that should be ignored from the JSX string. For example:
;;//or var jsxToString = require('jsx-to-string'); let Basic = React; //this is your react component console; //outputs: <Basic />
-
ignoreTags (array)
An array of string tags that should be ignored from the JSX string. For example:
;;//or var jsxToString = require('jsx-to-string'); let Basic = React; //this is your react component console; //outputs: <Basic><p>I am alone</p></Basic>
- shortBooleanSyntax (boolean)
Optional. Defaults to false. Whether or not to show the short or long boolean syntax.
;;//or var jsxToString = require('jsx-to-string'); let Basic = React; //this is your react component console; //outputs: <Basic test test2={false} test3 />
-
displayName (string)
A custom value to be used as the component name. For example:
;;//or var jsxToString = require('jsx-to-string'); let Basic = React; //this is your react component console; //outputs: <CustomName />