aboutsummaryrefslogtreecommitdiff
path: root/node_modules/@concordance/react/README.md
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2017-08-14 05:01:11 +0200
committerFlorian Dold <florian.dold@gmail.com>2017-08-14 05:02:09 +0200
commit363723fc84f7b8477592e0105aeb331ec9a017af (patch)
tree29f92724f34131bac64d6a318dd7e30612e631c7 /node_modules/@concordance/react/README.md
parent5634e77ad96bfe1818f6b6ee70b7379652e5487f (diff)
node_modules
Diffstat (limited to 'node_modules/@concordance/react/README.md')
-rw-r--r--node_modules/@concordance/react/README.md20
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 &#x235F; character after the element
+name. Properties and children are formatted by [Concordance](https://github.com/concordancejs/concordance).