diff options
Diffstat (limited to 'web/src/vendor/react-router/README.md')
| -rw-r--r-- | web/src/vendor/react-router/README.md | 135 |
1 files changed, 0 insertions, 135 deletions
diff --git a/web/src/vendor/react-router/README.md b/web/src/vendor/react-router/README.md deleted file mode 100644 index a3746aaf..00000000 --- a/web/src/vendor/react-router/README.md +++ /dev/null @@ -1,135 +0,0 @@ -React Router -============ - -[](https://travis-ci.org/rackt/react-router) - -A complete routing library for React. - -Docs ----- - -- [Guide: Overview](/docs/guides/overview.md) -- [API](/docs/api/) - -Important Notes ---------------- - -### **** NPM USERS THIS PACKAGE MOVED **** - -This package has moved from `react-nested-router` to `react-router`. - -Update your package.json to point to the new package, or if you aren't -ready to update, make sure your package.json specifically points to -`0.3.5` or less, `0.3.6` just throws an error telling you the package -has moved. - -### SemVer - -Before our `1.0` release, breaking API changes will cause a bump to -`0.x`. For example, `0.4.1` and `0.4.8` will have the same API, but -`0.5.0` will have breaking changes. - -Please refer to the [upgrade guide](/UPGRADE_GUIDE.md) and -[changelog](/CHANGELOG.md) when upgrading. - -Installation ------------- - -```sh -npm install react-router -# or -bower install react-router -``` - -This library is written with CommonJS modules. If you are using -browserify, webpack, or similar, you can consume it like anything else -installed from npm. - -There is also a UMD build available on bower, find the library on -`window.ReactRouter`. - -Features --------- - -- Nested views mapped to nested routes -- Modular construction of route hierarchy -- Fully asynchronous transition hooks -- Transition abort / redirect / retry -- Dynamic segments -- Query parameters -- Links with automatic `.active` class when their route is active -- Multiple root routes -- Hash or HTML5 history URLs - -Check out the `examples` directory to see how simple previously complex UI -and workflows are to create. - -What's it look like? --------------------- - -```js -React.renderComponent(( - <Routes location="history"> - <Route path="/" handler={App}> - <DefaultRoute handler={Home} /> - <Route name="about" handler={About} /> - <Route name="users" handler={Users}> - <Route name="recent-users" path="recent" handler={RecentUsers} /> - <Route name="user" path="/user/:userId" handler={User} /> - <NotFoundRoute handler={UserRouteNotFound}/> - </Route> - </Route> - <NotFoundRoute handler={NotFound}/> - <Redirect path="company" to="about" /> - </Routes> -), document.body); -``` - -All of the `handler`s will render inside their parent route `handler`. - -See more in the [overview guide](/docs/guides/overview.md). - -Benefits of This Approach -------------------------- - -1. **Incredible screen-creation productivity** - There is only one - use-case when a user visits a route: render something. Every user - interface has layers (or nesting) whether its a simple navbar or - multiple levels of master-detail. Coupling nested routes to these - nested views gets rid of a ton of work for the developer to wire all - of it together when the user switches routes. Adding new screens - could not get faster. - -2. **Immediate understanding of application structure** - When routes - are declared in one place, developers can easily construct a mental - image of the application. It's essentially a sitemap. There's not a - better way to get so much information about your app this quickly. - -3. **Code tractability** - When a developer gets a ticket to fix a bug - at as specific url they simply 1) look at the route config, then 2) - go find the handler for that route. Every entry point into your - application is represented by these routes. - -4. **URLs are your first thought, not an after-thought** - With React - Router, you don't get UI on the page without configuring a url first. - Fortunately, its wildly productive this way, too. - -Related Modules ---------------- - -- [rnr-constrained-route](https://github.com/bjyoungblood/rnr-constrained-route) - validate paths - and parameters on route handlers. -- [react-router-bootstrap](https://github.com/mtscout6/react-router-bootstrap) - Integration with [react-bootstrap](https://github.com/react-bootstrap/react-bootstrap) components. - -Contributing ------------- - -Please see [CONTRIBUTING](CONTRIBUTING.md) - -Thanks, Ember -------------- - -This library is highly inspired by the Ember.js routing API. In general, -its a translation of the Ember router api to React. Huge thanks to the -Ember team for solving the hardest part already. - |