Skip to content
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

Router link components improvement #1651

Merged
merged 20 commits into from
Jul 27, 2018
Merged
Show file tree
Hide file tree
Changes from 13 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
3 changes: 3 additions & 0 deletions docs/app/i18n/en-US/pages.js
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@ export default {
title: 'Themes - Advanced',
nav: 'Advanced'
},
withRouter: {
title: 'Work with Vue Router'
},
components: {
title: 'Components',
},
Expand Down
15 changes: 13 additions & 2 deletions docs/app/pages/Components/BottomBar/examples/BarRouter.vue
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,26 @@
<div>
<div class="phone-viewport">
<md-bottom-bar md-sync-route>
<md-bottom-bar-item to="/components/bottom-bar/home" md-label="Home" md-icon="home"></md-bottom-bar-item>
<md-bottom-bar-item to="/components/bottom-bar" exact md-label="Home" md-icon="home"></md-bottom-bar-item>
<md-bottom-bar-item to="/components/bottom-bar/posts" md-label="Posts" md-icon="/assets/icon-whatshot.svg"></md-bottom-bar-item>
<md-bottom-bar-item to="/components/bottom-bar/favorites" md-label="Favorites" md-icon="favorite"></md-bottom-bar-item>
</md-bottom-bar>
</div>

<div class="phone-viewport">
<md-bottom-bar class="md-accent" md-sync-route>
<md-bottom-bar-item to="/components/bottom-bar/home" md-label="Home" md-icon="home"></md-bottom-bar-item>
<md-bottom-bar-item to="/components/bottom-bar" exact md-label="Home" md-icon="home"></md-bottom-bar-item>
<md-bottom-bar-item to="/components/bottom-bar/posts" md-label="Posts" md-icon="/assets/icon-whatshot.svg"></md-bottom-bar-item>
<md-bottom-bar-item to="/components/bottom-bar/favorites" md-label="Favorites" md-icon="favorite"></md-bottom-bar-item>
</md-bottom-bar>
</div>

<div class="phone-viewport">
<md-bottom-bar class="md-accent" md-sync-route>
<md-bottom-bar-item to="/components/bottom-bar/posts/1" md-label="Post 1" md-icon="/assets/icon-whatshot.svg"></md-bottom-bar-item>
<md-bottom-bar-item to="/components/bottom-bar/posts/2" md-label="Post 2" md-icon="/assets/icon-whatshot.svg"></md-bottom-bar-item>
</md-bottom-bar>
</div>
</div>
</template>

Expand All @@ -34,4 +41,8 @@
border: 1px solid rgba(#000, .26);
background: rgba(#000, .06);
}

.md-bottom-bar .md-bottom-bar-item.router-link-active {
text-shadow: 0 0 5px;
}
</style>
12 changes: 10 additions & 2 deletions docs/app/pages/Components/List/examples/ListTypes.vue
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,12 @@
<md-list-item>Plain Text</md-list-item>
<md-list-item @click="alert">Button</md-list-item>
<md-list-item href="https://google.com" target="_blank">Link</md-list-item>
<md-list-item to="/components/list/router">Link Router</md-list-item>
<md-list-item to="/components/list">Link Router Active Color</md-list-item>
<md-list-item to="/components/list" exact>Router <code>/</code></md-list-item>
<md-list-item to="/components/list/router">Router <code>/router/**</code></md-list-item>
</md-list>
<md-list>
<md-list-item to="/components/list/router/1">Router <code>/router/1</code></md-list-item>
<md-list-item to="/components/list/router/2">Router <code>/router/2</code></md-list-item>
</md-list>
</div>
</template>
Expand All @@ -29,4 +33,8 @@ export default {
vertical-align: top;
border: 1px solid rgba(#000, .12);
}

.md-list .router-link-active {
text-shadow: 0 0 5px;
}
</style>
10 changes: 9 additions & 1 deletion docs/app/pages/Components/Steppers/examples/StepperRoute.vue
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<template>
<div>
<md-steppers md-sync-route md-dynamic-height>
<md-step id="first" to="/components/steppers/first" md-label="First Step">
<md-step id="first" to="/components/steppers" exact md-label="First Step">
<p>Lorem ipsum dolor sit amet consectetur adipisicing elit. Molestias doloribus eveniet quaerat modi cumque quos sed, temporibus nemo eius amet aliquid, illo minus blanditiis tempore, dolores voluptas dolore placeat nulla.</p>
<p>Lorem ipsum dolor sit amet consectetur adipisicing elit. Molestias doloribus eveniet quaerat modi cumque quos sed, temporibus nemo eius amet aliquid, illo minus blanditiis tempore, dolores voluptas dolore placeat nulla.</p>
<p>Lorem ipsum dolor sit amet consectetur adipisicing elit. Molestias doloribus eveniet quaerat modi cumque quos sed, temporibus nemo eius amet aliquid, illo minus blanditiis tempore, dolores voluptas dolore placeat nulla.</p>
Expand All @@ -12,13 +12,21 @@
<p>Lorem ipsum dolor sit amet consectetur adipisicing elit. Molestias doloribus eveniet quaerat modi cumque quos sed, temporibus nemo eius amet aliquid, illo minus blanditiis tempore, dolores voluptas dolore placeat nulla.</p>
<p>Lorem ipsum dolor sit amet consectetur adipisicing elit. Molestias doloribus eveniet quaerat modi cumque quos sed, temporibus nemo eius amet aliquid, illo minus blanditiis tempore, dolores voluptas dolore placeat nulla.</p>
<p>Lorem ipsum dolor sit amet consectetur adipisicing elit. Molestias doloribus eveniet quaerat modi cumque quos sed, temporibus nemo eius amet aliquid, illo minus blanditiis tempore, dolores voluptas dolore placeat nulla.</p>
<md-list>
<md-list-item to="/components/steppers/second/sub1">Subpage 1</md-list-item>
<md-list-item to="/components/steppers/second/sub2">Subpage 2</md-list-item>
</md-list>
</md-step>

<md-step id="third" to="/components/steppers/third" md-label="Third Step">
<p>Lorem ipsum dolor sit amet consectetur adipisicing elit. Molestias doloribus eveniet quaerat modi cumque quos sed, temporibus nemo eius amet aliquid, illo minus blanditiis tempore, dolores voluptas dolore placeat nulla.</p>
<p>Lorem ipsum dolor sit amet consectetur adipisicing elit. Molestias doloribus eveniet quaerat modi cumque quos sed, temporibus nemo eius amet aliquid, illo minus blanditiis tempore, dolores voluptas dolore placeat nulla.</p>
</md-step>
</md-steppers>
<md-list>
<md-list-item to="/components/steppers/second/sub1">Subpage 2-1</md-list-item>
<md-list-item to="/components/steppers/second/sub2">Subpage 2-2</md-list-item>
</md-list>
</div>
</template>

Expand Down
2 changes: 1 addition & 1 deletion docs/app/pages/Components/Tabs/examples/TabContent.vue
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<template>
<div>
<md-tabs md-sync-route>
<md-tab id="tab-home" md-label="Home" to="/components/tabs/home">
<md-tab id="tab-home" md-label="Home" to="/components/tabs" exact>
Home Tab
</md-tab>

Expand Down
22 changes: 19 additions & 3 deletions docs/app/pages/Components/Tabs/examples/TabRouter.vue
Original file line number Diff line number Diff line change
@@ -1,12 +1,22 @@
<template>
<div>
<md-tabs md-sync-route>
<md-tab id="tab-home" md-label="Home" to="/components/tabs/home"></md-tab>
<md-tab id="tab-pages" md-label="Pages" to="/components/tabs/pages"></md-tab>
<md-tab id="tab-home" md-label="Home" to="/components/tabs" exact></md-tab>
<md-tab id="tab-pages" md-label="Pages" to="/components/tabs/pages">
<md-list>
<md-list-item to="/components/tabs/pages/1">Go to Subpage 1</md-list-item>
<md-list-item to="/components/tabs/pages/2">Go to Subpage 2</md-list-item>
</md-list>
</md-tab>
<md-tab id="tab-posts" md-label="Posts" to="/components/tabs/posts"></md-tab>
<md-tab id="tab-settings" md-label="Settings" to="/components/tabs/settings"></md-tab>
<md-tab id="tab-favorites" md-label="Favorites" to="/components/tabs/favorites"></md-tab>
<md-tab id="tab-disabled" md-label="Disabled" md-disabled></md-tab>
</md-tabs>
<h2>Mirror Subpage</h2>
<md-tabs md-sync-route>
<md-tab id="tab-pages-1" md-label="Pages 1" to="/components/tabs/pages/1">Subpage 1</md-tab>
<md-tab id="tab-pages-2" md-label="Pages 2" to="/components/tabs/pages/2">Subpage 2</md-tab>
</md-tabs>
</div>
</template>

Expand All @@ -15,3 +25,9 @@
name: 'TabRouter'
}
</script>

<style lang="scss" scoped>
.md-tabs /deep/ .md-tabs-navigation .md-button.router-link-active {
text-shadow: 0 0 5px;
}
</style>
35 changes: 35 additions & 0 deletions docs/app/pages/WithRouter.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<template>
<page-container centered :title="$t('pages.withRouter.title')">
<div class="page-container-section">
<h2 class="md-headline">Vue Material Router Link Components</h2>
<p>Vue router supported with <code><router-link to="/components/tabs">md-tab</router-link></code>, <code><router-link to="/components/list">md-list-item</router-link></code>, <code><router-link to="/components/bottom-bar">md-bottom-bar-item</router-link></code> and <code><router-link to="/components/steppers">md-step</router-link></code> so far.</p>
<p>Vue Material router link components will be auto-generated with the prop <code>to</code>. All <a href="https://router.vuejs.org/en/api/router-link.html"><code>router-link</code> props</a> except <code>tag</code> accepted.</p>
<h2 class="md-headline">Work with Router option <code>linkActiveClass</code></h2>
<p>Since Vue Router doesn't expose <code>isSameRoute</code> and <code>isIncludedRoute</code> methods, Vue Material cannot detect which links are active. Vue Material inject <code>linkActiveClass</code> with an extra active class to interact with router. Therefore, if you want to using an custom class for active link as default, you need to setup like this:</p>
<code-example title="Individual components">
const linkActiveClass = 'my-link-active-class'

// pass custom class to Vue Material
Vue.material.router.linkActiveClass = linkActiveClass

// pass custom class to Vue Router
router = new VueRouter({
routes,
linkActiveClass
})

const app = new Vue({
name: 'Root',
router,
})

</code-example>
</div>
</page-container>
</template>

<script>
export default {
name: 'WithRouter'
}
</script>
13 changes: 9 additions & 4 deletions docs/app/routes.js
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ export const routes = [
page: 'Components/Datepicker/Datepicker.vue'
},
{
path: '/components/steppers/:optional?',
path: '/components/steppers/:optional?/:sub?',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this :sub? needed? It's breaking the 'docs-build' task.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, they are for sub-subpages.

name: 'components/steppers',
page: 'Components/Steppers/Steppers.vue'
},
Expand All @@ -70,12 +70,12 @@ export const routes = [
page: 'Components/Snackbar/Snackbar.vue'
},
{
path: '/components/tabs/:optional?',
path: '/components/tabs/:optional?/:sub?',
name: 'components/tabs',
page: 'Components/Tabs/Tabs.vue'
},
{
path: '/components/bottom-bar/:optional?',
path: '/components/bottom-bar/:optional?/:sub?',
name: 'components/bottom-bar',
page: 'Components/BottomBar/BottomBar.vue'
},
Expand Down Expand Up @@ -202,7 +202,7 @@ export const routes = [
page: 'Components/File/File.vue'
},
{
path: '/components/list/:optional?',
path: '/components/list/:optional?/:sub?',
name: 'components/list',
page: 'Components/List/List.vue'
},
Expand Down Expand Up @@ -257,6 +257,11 @@ export const routes = [
name: 'ui-elements/typography',
page: 'UiElements/Typography/Typography.vue'
},
{
path: '/with-router',
name: 'with-router',
page: 'WithRouter.vue'
},
{
path: '*',
name: 'error',
Expand Down
2 changes: 2 additions & 0 deletions docs/app/template/MainNavContent.vue
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
<router-link to="/themes/advanced">{{ $t('pages.themeAdvanced.nav') }}</router-link>
</div>

<router-link to="/with-router">{{ $t('pages.withRouter.title') }}</router-link>

<router-link to="/ui-elements">{{ $t('pages.uiElements.title') }}</router-link>
<div class="main-nav-level">
<router-link to="/ui-elements/elevation">{{ $t('pages.elevation.title') }}</router-link>
Expand Down
63 changes: 13 additions & 50 deletions src/components/MdBottomBar/MdBottomBar.vue
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,16 @@
...MdPropValidator('md-type', ['fixed', 'shift'])
}
},
data: () => ({
MdBottomBar: {
mouseEvent: null,
activeItem: null,
items: {}
data () {
return {
MdBottomBar: {
mouseEvent: null,
activeItem: null,
items: {},
syncRoute: this.mdSyncRoute
}
}
}),
},
provide () {
return {
MdBottomBar: this.MdBottomBar
Expand All @@ -50,21 +53,12 @@
watch: {
activeItem () {
this.$emit('md-changed', this.activeItem)
},
mdSyncRoute () {
this.MdBottomBar.syncRoute = mdSyncRoute
}
},
methods: {
setupWatchers () {
if (this.mdSyncRoute) {
this.$watch('$route', {
deep: true,
handler () {
if (this.mdSyncRoute) {
this.setActiveItemByRoute()
}
}
})
}
},
hasActiveItem () {
return this.MdBottomBar.activeItem || this.mdActiveItem
},
Expand All @@ -84,47 +78,16 @@
} else {
this.MdBottomBar.activeItem = this.mdActiveItem
}
},
setActiveItemByRoute () {
const { items, keys } = this.getItemsAndKeys()
let tabIndex = null

if (this.$router) {
keys.forEach((key, index) => {
const item = items[key]
const toProp = item.props.to

if (toProp && toProp === this.$route.path) {
tabIndex = index
}
})
}

if (!this.hasActiveItem()) {
if (keys[tabIndex]) {
this.MdBottomBar.activeItem = keys[tabIndex]
} else {
this.MdBottomBar.activeItem = keys[0]
}
} else if (keys[tabIndex]) {
this.MdBottomBar.activeItem = keys[tabIndex]
}
}
},
created () {
this.MdBottomBar.type = this.mdType
},
mounted () {
this.$nextTick().then(() => {
if (this.mdSyncRoute) {
this.setActiveItemByRoute()
} else {
if (!this.mdSyncRoute) {
this.setActiveItemByIndex(0)
}

window.setTimeout(() => {
this.setupWatchers()
}, 100)
})

}
Expand Down
8 changes: 5 additions & 3 deletions src/components/MdBottomBar/MdBottomBarItem.vue
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,20 @@

<script>
import MdAssetIcon from 'core/mixins/MdAssetIcon/MdAssetIcon'
import MdRouterLink from 'core/mixins/MdRouterLink/MdRouterLink'
import MdUuid from 'core/utils/MdUuid'
import MdRouterLinkProps from 'core/utils/MdRouterLinkProps'

const ignoredProps = ['id', 'mdLabel', 'mdIcon', 'mdDisabled']

export default {
name: 'MdBottomBarItem',
mixins: [MdAssetIcon],
mixins: [MdAssetIcon, MdRouterLink],
props: {
id: {
type: String,
default: () => 'md-bottom-bar-item-' + MdUuid()
},
to: null,
mdLabel: String,
mdIcon: String,
mdDisabled: Boolean
Expand Down Expand Up @@ -101,7 +101,9 @@
})
},
setActiveItem ($event) {
this.MdBottomBar.activeItem = this.id
if (!this.MdBottomBar.syncRoute) {
this.MdBottomBar.activeItem = this.id
}

if (this.MdBottomBar.type === 'shift') {
this.MdBottomBar.mouseEvent = $event
Expand Down
Loading