Skip to content

Commit 4c7b6a6

Browse files
docs(state) document the reload transition parameter
1 parent dfd1078 commit 4c7b6a6

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

src/state.js

+4-3
Original file line numberDiff line numberDiff line change
@@ -896,9 +896,10 @@ function $StateProvider( $urlRouterProvider, $urlMatcherFactory) {
896896
* - **`relative`** - {object=$state.$current}, When transitioning with relative path (e.g '^'),
897897
* defines which state to be relative from.
898898
* - **`notify`** - {boolean=true}, If `true` will broadcast $stateChangeStart and $stateChangeSuccess events.
899-
* - **`reload`** (v0.2.5) - {boolean=false}, If `true` will force transition even if the state or params
900-
* have not changed, aka a reload of the same state. It differs from reloadOnSearch because you'd
901-
* use this when you want to force a reload when *everything* is the same, including search params.
899+
* - **`reload`** (v0.2.5) - {boolean=false|string|object}, If `true` will force transition even if no state or params
900+
* have changed. It will reload the resolves and views of the current state and parent states.
901+
* If `reload` is a string (or state object), the state object is fetched (by name, or object reference); and \
902+
* the transition reloads the resolves and views for that matched state, and all its children states.
902903
*
903904
* @returns {promise} A promise representing the state of the new transition.
904905
*

0 commit comments

Comments
 (0)