diff options
Diffstat (limited to 'web/src/vendor/react-router/docs/api/misc/Location.md')
-rw-r--r-- | web/src/vendor/react-router/docs/api/misc/Location.md | 66 |
1 files changed, 0 insertions, 66 deletions
diff --git a/web/src/vendor/react-router/docs/api/misc/Location.md b/web/src/vendor/react-router/docs/api/misc/Location.md deleted file mode 100644 index f0b2077b..00000000 --- a/web/src/vendor/react-router/docs/api/misc/Location.md +++ /dev/null @@ -1,66 +0,0 @@ -API: `Location` (object) -========================== - -You can supply the router with your own location implementation. The -following methods must be implemented: - -Methods -------- - -### `setup(onChange)` - -Called when the router is first setup. Whenever an external actor should -cause the router to react, call `onChange` (for example, on -`window.hashchange`). - -### `teardown` - -Called when the router is torn down. - -### `push` - -Called when the router is transitioning from one path to another. - -### `replace` - -Called when ther router is replacing (not transitioning) one url with -another. - -### `pop` - -Called when the router attempts to go back one entry in the history. - -### `getCurrentPath` - -Should return the current path as a string. - -### `toString` - -Should return a useful string for logging and debugging. - -Example -------- - -This is a terrible example, you're probably better off looking at the -implementations in this repository. - -```js -var MyLocation = { - - setup: function (onChange) {}, - - teardown: function () {}, - - push: function (path) {}, - - replace: function (path) {}, - - pop: function () {}, - - getCurrentPath: function () {}, - - toString: function () {} - -}; -``` - |