Skip to content

Commit 154afba

Browse files
committed
[changed] location of public modules
this puts all public modules in the root of the package to: - conveniently require them - easily identify what is public v. private for example: ```js // instead of doing this var Router = require('react-router'); var Link = Router.Link; // or this var Link = require('react-router/modules/Link'); // you can now do this var Link = require('react-router/Link'); ``` closes #154
1 parent a597441 commit 154afba

File tree

26 files changed

+46
-33
lines changed

26 files changed

+46
-33
lines changed

ActiveState.js

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
module.exports = require('./modules/mixins/ActiveState');

AsyncState.js

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
module.exports = require('./modules/mixins/AsyncState');

Link.js

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
module.exports = require('./modules/components/Link');

Route.js

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
module.exports = require('./modules/components/Route');

Routes.js

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
module.exports = require('./modules/components/Routes');

docs/api/README.md

+11
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,14 @@ React Router API
1616
- [`ActiveState`](/docs/api/mixins/ActiveState.md)
1717
- [`AsyncState`](/docs/api/mixins/AsyncState.md)
1818

19+
20+
Public Modules
21+
--------------
22+
23+
All modules found at the repository root are considered public. You can
24+
require them conveniently with `var Route = require('react-router/Route');` etc.
25+
26+
Note that we do not support requiring modules from our `modules`
27+
directory. (No notes in the changelog, no changes to the versioning of
28+
the lib, etc.)
29+

docs/api/mixins/ActiveState.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,12 @@ Let's say you are using bootstrap and want to get `active` on those `li`
2626
tags for the Tabs:
2727

2828
```js
29-
var Router = require('react-router');
30-
var Link = Router.Link;
29+
var Link = require('react-router/Link');
30+
var ActiveState = require('react-router/ActiveState');
3131

3232
var Tab = React.createClass({
3333

34-
mixins: [ Router.ActiveState ],
34+
mixins: [ ActiveState ],
3535

3636
getInitialState: function () {
3737
return { isActive: false };

docs/guides/overview.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ Guide: Overview
22
===============
33

44
```
5-
var Routes = require('react-router').Routes;
6-
var Route = require('react-router').Route;
5+
var Routes = require('react-router/Routes');
6+
var Route = require('react-router/Route');
77
88
React.renderComponent((
99
<Routes>
@@ -50,7 +50,7 @@ will render the active child route handler.
5050
Here's the rest of the application:
5151

5252
```js
53-
var Link = require('react-router').Link;
53+
var Link = require('react-router/Link');
5454

5555
var App = React.createClass({
5656
render: function() {

examples/animations/app.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/** @jsx React.DOM */
22
var React = require('react');
3-
var Router = require('../../modules/main');
3+
var Router = require('../../index');
44
var Routes = Router.Routes;
55
var Route = Router.Route;
66
var Link = Router.Link;

examples/auth-flow/app.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/** @jsx React.DOM */
22
var React = require('react');
3-
var Router = require('../../modules/main');
3+
var Router = require('../../index');
44
var Route = Router.Route;
55
var Routes = Router.Routes;
66
var Link = Router.Link;

examples/data-flow/app.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/** @jsx React.DOM */
22
var React = require('react');
3-
var Router = require('../../modules/main');
3+
var Router = require('../../index');
44
var Route = Router.Route;
55
var Routes = Router.Routes;
66
var Link = Router.Link;

examples/dynamic-segments/app.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/** @jsx React.DOM */
22
var React = require('react');
3-
var Router = require('../../modules/main');
3+
var Router = require('../../index');
44
var Route = Router.Route;
55
var Routes = Router.Routes;
66
var Link = Router.Link;

examples/master-detail/app.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/** @jsx React.DOM */
22
var React = require('react');
3-
var Router = require('../../modules/main');
3+
var Router = require('../../index');
44
var Route = Router.Route;
55
var Routes = Router.Routes;
66
var Link = Router.Link;

examples/partial-app-loading/app.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/** @jsx React.DOM */
22
var React = require('react');
3-
var Router = require('../../modules/main');
3+
var Router = require('../../index');
44
var Route = Router.Route;
55
var Routes = Router.Routes;
66
var Link = Router.Link;

examples/partial-app-loading/dashboard.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/** @jsx React.DOM */
22

33
var React = require('react');
4-
var ReactRouter = require('../../modules/main');
4+
var ReactRouter = require('../../index');
55
var Link = ReactRouter.Link;
66

77
var Dashboard = React.createClass({

examples/query-params/app.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/** @jsx React.DOM */
22
var React = require('react');
3-
var Router = require('../../modules/main');
3+
var Router = require('../../index');
44
var Route = Router.Route;
55
var Routes = Router.Routes;
66
var Link = Router.Link;

examples/shared-root/app.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/** @jsx React.DOM */
22
var React = require('react');
3-
var Router = require('../../modules/main');
3+
var Router = require('../../index');
44
var Route = Router.Route;
55
var Routes = Router.Routes;
66
var Link = Router.Link;

examples/simple-master-detail/app.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/** @jsx React.DOM */
22
var React = require('react');
3-
var Router = require('../../modules/main');
3+
var Router = require('../../index');
44
var Route = Router.Route;
55
var Routes = Router.Routes;
66
var Link = Router.Link;

examples/transitions/app.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/** @jsx React.DOM */
22
var React = require('react');
3-
var Router = require('../../modules/main');
3+
var Router = require('../../index');
44
var Route = Router.Route;
55
var Routes = Router.Routes;
66
var Link = Router.Link;

goBack.js

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
module.exports = require('./modules/helpers/goBack');

index.js

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
exports.ActiveState = require('./ActiveState');
2+
exports.AsyncState = require('./AsyncState');
3+
exports.Link = require('./Link');
4+
exports.Route = require('./Route');
5+
exports.Routes = require('./Routes');
6+
exports.goBack = require('./goBack');
7+
exports.replaceWith = require('./replaceWith');
8+
exports.transitionTo = require('./transitionTo');

modules/main.js

-14
This file was deleted.

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"react",
77
"router"
88
],
9-
"main": "modules/main",
9+
"main": "./index",
1010
"repository": {
1111
"type": "git",
1212
"url": "https://github.com/rackt/react-router.git"

replaceWith.js

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
module.exports = require('./modules/helpers/replaceWith');

script/build

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
#!/bin/sh
22
mkdir -p dist
3-
NODE_ENV=production node_modules/.bin/browserify modules/main.js -t browserify-shim -t envify --detect-globals false -s ReactRouter > dist/react-router.js
3+
NODE_ENV=production node_modules/.bin/browserify index.js -t browserify-shim -t envify --detect-globals false -s ReactRouter > dist/react-router.js
44
node_modules/.bin/uglifyjs dist/react-router.js --compress warnings=false > dist/react-router.min.js

transitionTo.js

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
module.exports = require('./modules/helpers/transitionTo');

0 commit comments

Comments
 (0)