Skip to content

Commit d20161d

Browse files
authored
Merge pull request #2435 from AnnMarieW/update-dcc-location-docstrigs
Updated docstrings for dcc.Location
2 parents dfd6dfe + 632013d commit d20161d

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

components/dash-core-components/src/components/Location.react.js

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -148,9 +148,13 @@ Location.propTypes = {
148148
href: PropTypes.string,
149149

150150
/**
151-
* If True, refresh the page when the location is updated.
152-
* If 'callback-nav' it will navigate to the new page when the location is updated in
153-
* a callback without refreshing the page.
151+
* Use `True` to navigate outside the Dash app or to manually refresh a page.
152+
* Use `False` if the same callback that updates the Location component is also
153+
* updating the page content - typically used in multi-page apps that do not use Pages.
154+
* Use 'callback-nav' if you are updating the URL in a callback, or a different
155+
* callback will respond to the new Location with updated content. This is
156+
* typical with multi-page apps that use Pages. This will allow for
157+
* navigating to a new page without refreshing the page.
154158
*/
155159
refresh: PropTypes.oneOfType([
156160
PropTypes.oneOf(['callback-nav']),

0 commit comments

Comments
 (0)