summaryrefslogtreecommitdiffstats
path: root/node_modules/babel-plugin-transform-react-jsx/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/babel-plugin-transform-react-jsx/README.md')
-rw-r--r--node_modules/babel-plugin-transform-react-jsx/README.md115
1 files changed, 115 insertions, 0 deletions
diff --git a/node_modules/babel-plugin-transform-react-jsx/README.md b/node_modules/babel-plugin-transform-react-jsx/README.md
new file mode 100644
index 0000000..128536d
--- /dev/null
+++ b/node_modules/babel-plugin-transform-react-jsx/README.md
@@ -0,0 +1,115 @@
+# babel-plugin-transform-react-jsx
+
+> Turn JSX into React function calls
+
+## Example
+
+### React
+
+**In**
+
+```javascript
+var profile = <div>
+ <img src="avatar.png" className="profile" />
+ <h3>{[user.firstName, user.lastName].join(' ')}</h3>
+</div>;
+```
+
+**Out**
+
+```javascript
+var profile = React.createElement("div", null,
+ React.createElement("img", { src: "avatar.png", className: "profile" }),
+ React.createElement("h3", null, [user.firstName, user.lastName].join(" "))
+);
+```
+
+### Custom
+
+**In**
+
+```javascript
+/** @jsx dom */
+
+var { dom } = require("deku");
+
+var profile = <div>
+ <img src="avatar.png" className="profile" />
+ <h3>{[user.firstName, user.lastName].join(' ')}</h3>
+</div>;
+```
+
+**Out**
+
+```javascript
+/** @jsx dom */
+
+var dom = require("deku").dom;
+
+var profile = dom( "div", null,
+ dom("img", { src: "avatar.png", className: "profile" }),
+ dom("h3", null, [user.firstName, user.lastName].join(" "))
+);
+```
+
+## Installation
+
+```sh
+npm install --save-dev babel-plugin-transform-react-jsx
+```
+
+## Usage
+
+### Via `.babelrc` (Recommended)
+
+**.babelrc**
+
+Without options:
+
+```json
+{
+ "plugins": ["transform-react-jsx"]
+}
+```
+
+With options:
+
+```json
+{
+ "plugins": [
+ ["transform-react-jsx", {
+ "pragma": "dom" // default pragma is React.createElement
+ }]
+ ]
+}
+```
+
+### Via CLI
+
+```sh
+babel --plugins transform-react-jsx script.js
+```
+
+### Via Node API
+
+```javascript
+require("babel-core").transform("code", {
+ plugins: ["transform-react-jsx"]
+});
+```
+
+## Options
+
+### `pragma`
+
+`string`, defaults to `React.createElement`.
+
+Replace the function used when compiling JSX expressions.
+
+Note that the `@jsx React.DOM` pragma has been deprecated as of React v0.12
+
+### `useBuiltIns`
+
+`boolean`, defaults to `false`.
+
+When spreading props, use `Object.assign` directly instead of Babel's extend helper.