diff options
Diffstat (limited to 'node_modules/@concordance/react/README.md')
| -rw-r--r-- | node_modules/@concordance/react/README.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/node_modules/@concordance/react/README.md b/node_modules/@concordance/react/README.md new file mode 100644 index 000000000..baf16efcf --- /dev/null +++ b/node_modules/@concordance/react/README.md @@ -0,0 +1,20 @@ +# @concordance/react + +React plugin for [Concordance](https://github.com/concordancejs/concordance). + +Allows +[`React.createElement()`](https://facebook.github.io/react/docs/react-api.html#createelement) +objects to be compared, formatted, diffed and serialized. Also supports +`toJSON()` renderings of +[`react-test-renderer`](https://www.npmjs.com/package/react-test-renderer). +These may be compared to `React.createElement()` objects. + +When comparing [React +component](https://facebook.github.io/react/docs/components-and-props.html) +elements, the element type is compared by identity. After deserialization the +element types are compared by function name, taking into account whether +serialization and / or comparison is done using Node.js 4, which has less +reliable support for function names. + +Component elements are formatted with a ⍟ character after the element +name. Properties and children are formatted by [Concordance](https://github.com/concordancejs/concordance). |