Skip to content

refactor: extract the functions from layout to mixins #314

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 12 additions & 98 deletions lib/default-theme/Layout.vue
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,25 @@
</template>

<script>
import Vue from 'vue'
import nprogress from 'nprogress'
import Home from './Home.vue'
import Navbar from './Navbar.vue'
import Page from './Page.vue'
import Sidebar from './Sidebar.vue'
import { pathToComponentName } from '@app/util'
import store from '@app/store'
import { resolveSidebarItems } from './util'
import throttle from 'lodash.throttle'
import { nprogressMixin, scrollListenerMixin, updateHeadMixin } from './mixins'

export default {
components: { Home, Page, Sidebar, Navbar },
mixins: [
nprogressMixin,
scrollListenerMixin,
updateHeadMixin
],
components: {
Home,
Navbar,
Page,
Sidebar
},
data () {
return {
isSidebarOpen: false
Expand Down Expand Up @@ -87,56 +93,12 @@ export default {
}
},

created () {
if (this.$ssrContext) {
this.$ssrContext.title = this.$title
this.$ssrContext.lang = this.$lang
this.$ssrContext.description = this.$page.description || this.$description
}
},

mounted () {
// update title / meta tags
this.currentMetaTags = []
const updateMeta = () => {
document.title = this.$title
document.documentElement.lang = this.$lang
const meta = [
{
name: 'description',
content: this.$description
},
...(this.$page.frontmatter.meta || [])
]
this.currentMetaTags = updateMetaTags(meta, this.currentMetaTags)
}
this.$watch('$page', updateMeta)
updateMeta()

window.addEventListener('scroll', this.onScroll)

// configure progress bar
nprogress.configure({ showSpinner: false })

this.$router.beforeEach((to, from, next) => {
if (to.path !== from.path && !Vue.component(pathToComponentName(to.path))) {
nprogress.start()
}
next()
})

this.$router.afterEach(() => {
nprogress.done()
this.isSidebarOpen = false
})
},

beforeDestroy () {
updateMetaTags(null, this.currentMetaTags)

window.removeEventListener('scroll', this.onScroll)
},

methods: {
toggleSidebar (to) {
this.isSidebarOpen = typeof to === 'boolean' ? to : !this.isSidebarOpen
Expand All @@ -158,57 +120,9 @@ export default {
this.toggleSidebar(false)
}
}
},
onScroll: throttle(function () {
this.setActiveHash()
}, 300),
setActiveHash () {
const sidebarLinks = [].slice.call(document.querySelectorAll('.sidebar-link'))
const anchors = [].slice.call(document.querySelectorAll('.header-anchor'))
.filter(anchor => sidebarLinks.some(sidebarLink => sidebarLink.hash === anchor.hash))

const scrollTop = Math.max(window.pageYOffset, document.documentElement.scrollTop, document.body.scrollTop)

for (let i = 0; i < anchors.length; i++) {
const anchor = anchors[i]
const nextAnchor = anchors[i + 1]

const isActive = i === 0 && scrollTop === 0 ||
(scrollTop >= anchor.parentElement.offsetTop + 10 &&
(!nextAnchor || scrollTop < nextAnchor.parentElement.offsetTop - 10))

if (isActive && this.$route.hash !== anchor.hash) {
store.disableScrollBehavior = true
this.$router.replace(anchor.hash, () => {
// execute after scrollBehavior handler.
this.$nextTick(() => {
store.disableScrollBehavior = false
})
})
return
}
}
}
}
}

function updateMetaTags (meta, current) {
if (current) {
current.forEach(c => {
document.head.removeChild(c)
})
}
if (meta) {
return meta.map(m => {
const tag = document.createElement('meta')
Object.keys(m).forEach(key => {
tag.setAttribute(key, m[key])
})
document.head.appendChild(tag)
return tag
})
}
}
</script>

<style src="prismjs/themes/prism-tomorrow.css"></style>
Expand Down
9 changes: 9 additions & 0 deletions lib/default-theme/mixins/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import nprogressMixin from './nprogress'
import scrollListenerMixin from './scrollListener'
import updateHeadMixin from './updateHead'

export {
nprogressMixin,
scrollListenerMixin,
updateHeadMixin
}
20 changes: 20 additions & 0 deletions lib/default-theme/mixins/nprogress.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import Vue from 'vue'
import nprogress from 'nprogress'
import { pathToComponentName } from '@app/util'

export default {
mounted () {
nprogress.configure({ showSpinner: false })

this.$router.beforeEach((to, from, next) => {
if (to.path !== from.path && !Vue.component(pathToComponentName(to.path))) {
nprogress.start()
}
next()
})

this.$router.afterEach(() => {
nprogress.done()
})
}
}
43 changes: 43 additions & 0 deletions lib/default-theme/mixins/scrollListener.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
import throttle from 'lodash.throttle'
import store from '@app/store'

export default {
mounted () {
window.addEventListener('scroll', this.onScroll)
},
beforeDestroy () {
window.removeEventListener('scroll', this.onScroll)
},
methods: {
onScroll: throttle(function () {
this.setActiveHash()
}, 300),
setActiveHash () {
const sidebarLinks = [].slice.call(document.querySelectorAll('.sidebar-link'))
const anchors = [].slice.call(document.querySelectorAll('.header-anchor'))
.filter(anchor => sidebarLinks.some(sidebarLink => sidebarLink.hash === anchor.hash))

const scrollTop = Math.max(window.pageYOffset, document.documentElement.scrollTop, document.body.scrollTop)

for (let i = 0; i < anchors.length; i++) {
const anchor = anchors[i]
const nextAnchor = anchors[i + 1]

const isActive = i === 0 && scrollTop === 0 ||
(scrollTop >= anchor.parentElement.offsetTop + 10 &&
(!nextAnchor || scrollTop < nextAnchor.parentElement.offsetTop - 10))

if (isActive && this.$route.hash !== anchor.hash) {
store.disableScrollBehavior = true
this.$router.replace(anchor.hash, () => {
// execute after scrollBehavior handler.
this.$nextTick(() => {
store.disableScrollBehavior = false
})
})
return
}
}
}
}
}
48 changes: 48 additions & 0 deletions lib/default-theme/mixins/updateHead.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
export default {
created () {
if (this.$ssrContext) {
this.$ssrContext.title = this.$title
this.$ssrContext.lang = this.$lang
this.$ssrContext.description = this.$page.description || this.$description
}
},
mounted () {
// update title / meta tags
this.currentMetaTags = []
const updateMeta = () => {
document.title = this.$title
document.documentElement.lang = this.$lang
const meta = [
{
name: 'description',
content: this.$description
},
...(this.$page.frontmatter.meta || [])
]
this.currentMetaTags = updateMetaTags(meta, this.currentMetaTags)
}
this.$watch('$page', updateMeta)
updateMeta()
},
beforeDestroy () {
updateMetaTags(null, this.currentMetaTags)
}
}

function updateMetaTags (meta, current) {
if (current) {
current.forEach(c => {
document.head.removeChild(c)
})
}
if (meta) {
return meta.map(m => {
const tag = document.createElement('meta')
Object.keys(m).forEach(key => {
tag.setAttribute(key, m[key])
})
document.head.appendChild(tag)
return tag
})
}
}