How to write parameter ts in vue3 route

Vue3 is one of the currently popular front-end frameworks, with excellent componentization and responsiveness. vue-router is the routing plug-in officially provided by Vue, which allows us to jump between pages in the front-end application and implement a single page application (SPA).

In development, we sometimes need to pass parameters between routes, such as jumping from one page to another and displaying the corresponding data. Next, we will introduce how to pass parameters through vue-router in Vue3, combined with TypeScript type checking, to avoid runtime exceptions caused by incorrect parameter passing.

Install vue-router

Before using vue-router to implement route jump, we need to install vue-router first:

npm install vue-router@next

Define route

Next, we need to define routes in the Vue application. In Vue3, routes are defined differently than in Vue2. The following is a simple sample code:

import { createRouter, createWebHistory } from 'vue-router';

const routes = [
  {
    path: '/',
    name: 'Home',
    component: Home,
    props: true
  },
  {
    path: '/page/:id',
    name: 'Page',
    component: Page,
    props: true
  }
];

const router = createRouter({
  history: createWebHistory(),
  routes
});

export default router;

Among them, createRouter and createWebHistory are factory methods provided by Vue3 for creating routing instances and history managers. .

When defining a route, we need to specify the path, route name and component. In addition, we can also pass the path parameters as component properties by setting props: true to facilitate the component to receive parameters.

Route jump

The following is a basic route jump sample code:

import router from '@/router';

router.push({ name: 'Page', params: { id: '1' } });

In the above code, we use the router.push method Perform route jump. Among them, name is the jump route name, params is the passed parameter object, and its internal key corresponds to the parameter name in the routing path.

Receive parameters

Finally, we need to receive parameters in the jumped page component and perform type checking.

There are two ways to pass parameters. One is through props, the other is through $route. Let’s take a look at the specific implementation of these two parameter passing methods respectively:

Passing parameters through props

When defining the route, we can pass the route parameters through the props option Passed as a property of the component. The following is a sample code:

// 路由定义
{
  path: '/page/:id',
  name: 'Page',
  component: Page,
  props: true
}

In the component, we can declare these properties directly and perform type checking through TypeScript. The following is a sample code:

<script lang="ts">
interface Props {
  id: string;
}

export default {
  props: {
    id: {
      type: String,
      required: true
    }
  },
  setup(props: Props) {
    /* ... */
  }
};
</script>

Here we use the newly introduced setup function of Vue3 to replace the data and computed## in Vue2. #, methods and other hook functions. Through the props object, we can get the passed parameters and perform type checking.

Passing parameters through $route

Another way to pass parameters is through

$route. In this way, we can get the routing parameters through the $route.params object. The following is a sample code:

<script lang="ts">
import { defineComponent } from 'vue';

export default defineComponent({
  setup() {
    const id = $route.params.id;
    /* ... */
  }
});
</script>

It should be noted that when using

$route, we need to import RouteLocationNormalized and RouteParams## through static types #Wait for routing related types, and perform type checking on parameters. <pre class='brush:typescript;toolbar:false;'>import { defineComponent } from 'vue'; import { RouteLocationNormalized, RouteParams } from 'vue-router'; export default defineComponent({ setup() { const route = $route as RouteLocationNormalized &amp; { params: RouteParams }; const id = route.params.id; /* ... */ } });</pre>Summary

Using vue-router to pass routing parameters and perform type checking under Vue3 is a safer and more reliable way. Through TypeScript's type checking, we can avoid runtime exceptions caused by incorrect parameter passing and improve the stability of the code. At the same time, new features such as

setup

functions and factory methods introduced by Vue3 also make it easier for us to manage and process routing during the development process.

The above is the detailed content of How to write parameter ts in vue3 route. For more information, please follow other related articles on the PHP Chinese website!