-
-
Notifications
You must be signed in to change notification settings - Fork 5.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(vue-app): support
app/router.scrollBehavior.js and deprecate `…
…scrollBehavior` (#6055)
- Loading branch information
Showing
13 changed files
with
138 additions
and
112 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| <% if (router.scrollBehavior) { %> | ||
| export default <%= serializeFunction(router.scrollBehavior) %> | ||
| <% } else { %>import { getMatchedComponents } from './utils' | ||
|
|
||
| if (process.client) { | ||
| if ('scrollRestoration' in window.history) { | ||
| window.history.scrollRestoration = 'manual' | ||
|
|
||
| // reset scrollRestoration to auto when leaving page, allowing page reload | ||
| // and back-navigation from other pages to use the browser to restore the | ||
| // scrolling position. | ||
| window.addEventListener('beforeunload', () => { | ||
| window.history.scrollRestoration = 'auto' | ||
| }) | ||
|
|
||
| // Setting scrollRestoration to manual again when returning to this page. | ||
| window.addEventListener('load', () => { | ||
| window.history.scrollRestoration = 'manual' | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| export default function (to, from, savedPosition) { | ||
| // if the returned position is falsy or an empty object, | ||
| // will retain current scroll position. | ||
| let position = false | ||
|
|
||
| // if no children detected and scrollToTop is not explicitly disabled | ||
| const Pages = getMatchedComponents(to) | ||
| if ( | ||
| Pages.length < 2 && | ||
| Pages.every(Page => Page.options.scrollToTop !== false) | ||
| ) { | ||
| // scroll to the top of the page | ||
| position = { x: 0, y: 0 } | ||
| } else if (Pages.some(Page => Page.options.scrollToTop)) { | ||
| // if one of the children has scrollToTop option set to true | ||
| position = { x: 0, y: 0 } | ||
| } | ||
|
|
||
| // savedPosition is only available for popstate navigations (back button) | ||
| if (savedPosition) { | ||
| position = savedPosition | ||
| } | ||
|
|
||
| const nuxt = window.<%= globals.nuxt %> | ||
|
|
||
| // triggerScroll is only fired when a new component is loaded | ||
| if (to.path === from.path && to.hash !== from.hash) { | ||
| nuxt.$nextTick(() => nuxt.$emit('triggerScroll')) | ||
| } | ||
|
|
||
| return new Promise((resolve) => { | ||
| // wait for the out transition to complete (if necessary) | ||
| nuxt.$once('triggerScroll', () => { | ||
| // coords will be used if no selector is provided, | ||
| // or if the selector didn't match any element. | ||
| if (to.hash) { | ||
| let hash = to.hash | ||
| // CSS.escape() is not supported with IE and Edge. | ||
| if (typeof window.CSS !== 'undefined' && typeof window.CSS.escape !== 'undefined') { | ||
| hash = '#' + window.CSS.escape(hash.substr(1)) | ||
| } | ||
| try { | ||
| if (document.querySelector(hash)) { | ||
| // scroll to anchor by returning the selector | ||
| position = { selector: hash } | ||
| } | ||
| } catch (e) { | ||
| console.warn('Failed to save scroll position. Please add CSS.escape() polyfill (https://github.com/mathiasbynens/CSS.escape).') | ||
| } | ||
| } | ||
| resolve(position) | ||
| }) | ||
| }) | ||
| } | ||
| <% } %> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters