react-teleport - npm Package Compare versions

Comparing version 0.0.0 to 0.1.0

package.json

@@ -6,4 +6,4 @@ {
     "repository"     : "https://github.com/coma/react-teleport",
-    "main"           : "./index.js",
-    "version"        : "0.0.0",
+    "main"           : "./src/index.js",
+    "version"        : "0.1.0",
     "license"        : "MIT",
@@ -14,11 +14,13 @@ "private"        : false,
     ],
-    "keywords"       : ["react"],
+    "keywords"       : [
+        "react"
+    ],
     "dependencies"   : {
+        "react": "0.13"
     },
     "devDependencies": {
-        "jsdom"              : "5.4",
-        "mocha"              : "2.2",
-        "should"             : "7.0",
-        "eslint"             : "0.24",
-        "eslint-plugin-react": "2.5"
+        "jsdom" : "5.4",
+        "mocha" : "2.2",
+        "should": "7.0",
+        "eslint": "0.24"
     },
@@ -30,6 +32,6 @@ "scripts"        : {
     "eslintConfig"   : {
-        "env"         : {
+        "env"  : {
             "node": true
         },
-        "rules"       : {
+        "rules": {
             "strict"                     : 0,
@@ -36,0 +38,0 @@ "new-cap"                    : 0,

README.md

@@ -1,2 +0,53 @@
-# react-teleport
+react-teleport
+==============
+
+[![Build Status](https://travis-ci.org/coma/react-teleport.png?branch=master)](https://travis-ci.org/coma/react-teleport)
+[![Dependency Status](https://david-dm.org/coma/react-teleport.png)](http://david-dm.org/coma/react-teleport)
+[![NPM version](https://badge.fury.io/js/react-teleport.png)](http://badge.fury.io/js/react-teleport)
+
 A neat way of handling views on other components
+
+Usage
+-----
+
+Just mount a destination on one of your components:
+
+```javascript
+var React       = require('react'),
+	Destination = require('react-teleport').Destination;
+
+module.exports = module.exports = React.createClass({
+	render: function () {
+
+		return (
+			<div>
+				<Destination name="header"/>
+			</div>
+		);
+	}
+});
+```
+
+and then send an element from another:
+
+```javascript
+var React  = require('react'),
+	Portal = require('react-teleport').Portal;
+
+module.exports = module.exports = React.createClass({
+	render: function () {
+
+		return (
+			<div>
+				<Portal destination="header">
+				    <nav>
+				        <a href="#">some</a>
+				        <a href="#">breadcrumbs</a>
+				        <a href="#">on the header!</a>
+				    </nav>
+				</Portal>
+			</div>
+		);
+	}
+});
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

29712

increased by992.75%

Dev dependency count

4

decreased by-20%

Number of package files

21

increased by425%

Lines of code

102

increased byInfinity%

Number of lines in readme file

54

increased by1700%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dependency count

1

increased byInfinity%

Dependency changes

• + Addedreact@0.13

• + Addedacorn@5.7.4(transitive)

• + Addedamdefine@1.0.1(transitive)

• + Addedast-types@0.9.6(transitive)

• + Addedbalanced-match@1.0.2(transitive)

• + Addedbase62@1.2.8(transitive)

• + Addedbrace-expansion@1.1.11(transitive)

• + Addedcommander@2.20.3(transitive)

• + Addedcommoner@0.10.8(transitive)

• + Addedconcat-map@0.0.1(transitive)

• + Addeddefined@1.0.1(transitive)

• + Addeddetective@4.7.1(transitive)

• + Addedenvify@3.4.1(transitive)

• + Addedesprima@3.1.3(transitive)

• + Addedesprima-fb@15001.1.0-dev-harmony-fb(transitive)

• + Addedglob@5.0.15(transitive)

• + Addedgraceful-fs@4.2.11(transitive)

• + Addediconv-lite@0.4.24(transitive)

• + Addedinflight@1.0.6(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedjstransform@11.0.3(transitive)

• + Addedminimatch@3.1.2(transitive)

• + Addedminimist@1.2.8(transitive)

• + Addedmkdirp@0.5.6(transitive)

• + Addedobject-assign@2.1.1(transitive)

• + Addedonce@1.4.0(transitive)

• + Addedpath-is-absolute@1.0.1(transitive)

• + Addedprivate@0.1.8(transitive)

• + Addedq@1.5.1(transitive)

• + Addedreact@0.13.3(transitive)

• + Addedrecast@0.11.23(transitive)

• + Addedsafer-buffer@2.1.2(transitive)

• + Addedsource-map@0.4.40.5.7(transitive)

• + Addedthrough@2.3.8(transitive)

• + Addedwrappy@1.0.2(transitive)