Skip to content

chore(playground): upgrade to script setup syntax and TypeScript #2490

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
52 changes: 22 additions & 30 deletions packages/playground/src/AppLink.vue
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
:class="classes"
target="_blank"
rel="noopener noreferrer"
:href="to"
:href="String(to)"
:tabindex="disabled ? -1 : undefined"
:aria-disabled="disabled"
>
Expand All @@ -26,38 +26,30 @@
</a>
</template>

<script>
import { RouterLink, START_LOCATION, useLink, useRoute } from 'vue-router'
import { computed, defineComponent, toRefs } from 'vue'
<script setup lang="ts">
import { START_LOCATION, useLink, useRoute } from 'vue-router'
import { computed, useAttrs, } from 'vue'
import type { RouterLinkProps } from 'vue-router'

export default defineComponent({
props: {
...RouterLink.props,
disabled: Boolean,
},
const { replace, to, disabled } = defineProps<RouterLinkProps & {disabled?: boolean}>()
const attrs = useAttrs()

setup(props, { attrs }) {
const { replace, to, disabled } = toRefs(props)
const isExternalLink = computed(
() => typeof to.value === 'string' && to.value.startsWith('http')
)
const isExternalLink = computed(
() => typeof to === 'string' && to.startsWith('http')
)

const currentRoute = useRoute()
const currentRoute = useRoute()

const { route, href, isActive, isExactActive, navigate } = useLink({
to: computed(() => (isExternalLink.value ? START_LOCATION : to.value)),
replace,
})

const classes = computed(() => ({
// allow link to be active for unrelated routes
'router-link-active':
isActive.value || currentRoute.path.startsWith(route.value.path),
'router-link-exact-active':
isExactActive.value || currentRoute.path === route.value.path,
}))

return { attrs, isExternalLink, href, navigate, classes, disabled }
},
const { route, href, isActive, isExactActive, navigate } = useLink({
to: computed(() => (isExternalLink.value ? START_LOCATION : to)),
replace,
})

const classes = computed(() => ({
// allow link to be active for unrelated routes
'router-link-active':
isActive.value || currentRoute.path.startsWith(route.value.path),
'router-link-exact-active':
isExactActive.value || currentRoute.path === route.value.path,
}))
</script>
24 changes: 24 additions & 0 deletions packages/playground/src/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,30 @@ export interface RouteNamedMap {
{ path: ParamValue<true> },
{ path: ParamValue<false> }
>
long: RouteRecordInfo<
'long',
'/long-:n(\\d+)',
{ n: ParamValue<true> },
{ n: ParamValue<false> }
>
Nested: RouteRecordInfo<
'Nested',
'/nested',
Record<never, never>,
Record<never, never>
>
'absolute-child': RouteRecordInfo<
'absolute-child',
'/nested/also-as-absolute',
Record<never, never>,
Record<never, never>
>
repeat: RouteRecordInfo<
'repeat',
'/rep/:a*',
{ a: ParamValue<true> },
{ a: ParamValue<false> }
>
}

declare module 'vue-router' {
Expand Down
13 changes: 8 additions & 5 deletions packages/playground/src/views/ComponentWithData.vue
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
</div>
</template>

<script>
<script lang="ts">
import { defineComponent, toRefs, reactive } from 'vue'
import { getData, delay } from '../api'
import { onBeforeRouteUpdate } from 'vue-router'

export default defineComponent({
const ComponentWithData = defineComponent({
name: 'ComponentWithData',
async setup() {
const data = reactive({ other: 'old', fromApi: null })
const data = reactive<{ other: string, fromApi: null | {message: string, time: number }}>({ other: 'old', fromApi: null })

onBeforeRouteUpdate(async (to, from, next) => {
data.fromApi = await getData()
Expand All @@ -30,9 +30,12 @@ export default defineComponent({
console.log('this in beforeRouteEnter', this)
await delay(300)
next(vm => {
console.log('got vm', vm)
vm.other = 'Hola'
console.log('got vm', vm);
// Workaround for https://github.com/vuejs/router/issues/701
(vm as InstanceType<typeof ComponentWithData>).other = 'Hola'
})
},
})

export default ComponentWithData
</script>
8 changes: 1 addition & 7 deletions packages/playground/src/views/Dynamic.vue
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,4 @@
<div>This was added dynamically</div>
</template>

<script>
import { defineComponent } from 'vue'

export default defineComponent({
name: 'Dynamic',
})
</script>
<script setup lang="ts"></script>
8 changes: 1 addition & 7 deletions packages/playground/src/views/Generic.vue
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,4 @@
</section>
</template>

<script>
import { defineComponent } from 'vue'

export default defineComponent({
name: 'Generic',
})
</script>
<script setup lang="ts"></script>
28 changes: 10 additions & 18 deletions packages/playground/src/views/GuardedWithLeave.vue
Original file line number Diff line number Diff line change
Expand Up @@ -5,26 +5,18 @@
</div>
</template>

<script>
// @ts-check
import { defineComponent } from 'vue'
<script setup lang="ts">
import { ref } from 'vue'
import { onBeforeRouteLeave } from 'vue-router'

export default defineComponent({
name: 'GuardedWithLeave',
data: () => ({ tries: 0 }),
const tries = ref(0)

setup() {
console.log('setup in cant leave')
onBeforeRouteLeave(function (to, from, next) {
if (window.confirm('Do you really want to leave?')) next()
else {
// @ts-ignore
this.tries++
next(false)
}
})
return {}
},
console.log('setup in cant leave')
onBeforeRouteLeave((to, from, next) => {
if (window.confirm('Do you really want to leave?')) next()
else {
tries.value++
next(false)
}
})
</script>
4 changes: 2 additions & 2 deletions packages/playground/src/views/Home.vue
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
</div>
</template>

<script>
<script lang="ts">
import { defineComponent, getCurrentInstance, ref } from 'vue'

export default defineComponent({
Expand All @@ -22,7 +22,7 @@ export default defineComponent({
setup() {
const me = getCurrentInstance()

function log(value) {
function log(value: any) {
console.log(value)
return value
}
Expand Down
11 changes: 2 additions & 9 deletions packages/playground/src/views/LongView.vue
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,8 @@
</section>
</template>

<script>
import { defineComponent } from 'vue'
<script setup lang="ts">
import { useRoute } from 'vue-router'

export default defineComponent({
name: 'LongView',
setup() {
const route = useRoute()
return { route }
},
})
const route = useRoute<'long'>()
</script>
17 changes: 4 additions & 13 deletions packages/playground/src/views/Nested.vue
Original file line number Diff line number Diff line change
Expand Up @@ -60,18 +60,9 @@
</div>
</template>

<script>
import { defineComponent, inject, provide } from 'vue'
<script setup lang="ts">
import { inject, provide } from 'vue'

export default defineComponent({
name: 'Nested',
setup() {
const level = inject('level', 1)
provide('level', level + 1)

return {
level,
}
},
})
const level = inject('level', 1)
provide('level', level + 1)
</script>
17 changes: 4 additions & 13 deletions packages/playground/src/views/NestedWithId.vue
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,11 @@
</div>
</template>

<script>
<script setup lang="ts">
import { defineComponent, inject, provide } from 'vue'

export default defineComponent({
props: ['id'],
name: 'NestedWithId',
setup(props) {
const level = inject('level', 1)
provide('level', level + 1)
const props = defineProps<{id: string}>()

return {
props,
level,
}
},
})
const level = inject('level', 1)
provide('level', level + 1)
</script>
11 changes: 2 additions & 9 deletions packages/playground/src/views/NotFound.vue
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,8 @@
<div>Not Found: {{ route.fullPath }}</div>
</template>

<script>
import { defineComponent } from 'vue'
<script setup lang="ts">
import { useRoute } from 'vue-router'

export default defineComponent({
name: 'NotFound',
setup() {
const route = useRoute()
return { route }
},
})
const route = useRoute()
</script>
33 changes: 13 additions & 20 deletions packages/playground/src/views/RepeatedParams.vue
Original file line number Diff line number Diff line change
Expand Up @@ -9,31 +9,24 @@
</div>
</template>

<script>
import { defineComponent, computed } from 'vue'
<script setup lang="ts">
import { computed } from 'vue'
import { useRoute } from 'vue-router'

export default defineComponent({
name: 'RepeatedParams',
const route = useRoute<'repeat'>()

setup() {
const route = useRoute()
const lessNesting = computed(() => {
const a = [...(route.params.a || [])]
a.pop()

const lessNesting = computed(() => {
const a = [...(route.params.a || [])]
a.pop()

return { params: { a } }
})

const moreNesting = computed(() => {
const a = [...(route.params.a || [])]
a.push('more')
return { params: { a } }
})

return { params: { a } }
})
const moreNesting = computed(() => {
const a = [...(route.params.a || [])]
a.push('more')

return { lessNesting, moreNesting }
},
return { params: { a } }
})

</script>
15 changes: 5 additions & 10 deletions packages/playground/src/views/User.vue
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,15 @@
<div>User: {{ id }}</div>
</template>

<script>
import { defineComponent } from 'vue'
<script setup lang="ts">
import { onBeforeRouteUpdate } from 'vue-router'

export default defineComponent({
name: 'User',
props: {
id: String,
},
defineProps<{ id: string }>()

beforeRouteUpdate(to, from, next) {
console.log('in beforeRouteUpdate this', this)
onBeforeRouteUpdate((to, from, next) => {
console.log('in beforeRouteUpdate this', this)
next(vm => {
console.log('in next callback', vm)
})
},
})
</script>