Vue3 Router Meta Tags

Automatically handle meta tags in your Vue3 Router.

Table of Contents

• Vue3 Router Meta Tags
  • Table of Contents
  • Installation
  • Usage
    • Configuration
      • defaultName
      • defaultLocale
      • locales
      • preconnect
      • textCallback
    • Manually setting meta tags
    • Updating the current locale
    • Setting your own JSON schema
    • Set a custom title
    • Set a custom description
    • Set follow and index
    • Skipping auto meta tag resolution

Installation

npm i @m-media/vue3-meta-tags

Usage

First, import the plugin and install it in your Vue app:

// main.js
import { metaTagPlugin } from "@m-media/vue3-meta-tags";

app.use(
  metaTagPlugin,
  {
    /* optional configuration here */
  },
  router
);

The third parameter is the router instance. The second parameter is an optional configuration object.

The package will automatically set some defaults on every page, but you can set your own meta attributes in a route too:

{
      path: "/",
      name: "home",
      meta: {
        title: "Home",
        description: "This is the home page",
        image: "https://example.com/image.png",
        locale: "en_US",
        metaTags:
          {
            "og:title": "Home",
            ... // other meta tags
          },
      },
      component: Home,
},

Configuration

The full configuration object that can be passed looks like this:

app.use(
  metaTagPlugin,
  {
    defaultName: import.meta.env.VITE_APP_NAME,
    defaultLocale: i18n.global.locale.value,
    locales: SUPPORT_LOCALES,
    preconnect: [import.meta.env.VITE_API_URL, "https://js.stripe.com"],
    textCallback: (text: string) => {
      return i18n.global.t(text);
    },
  },
  router
);

defaultName

The default name of your app. This will be used if no name/title is specified in the meta tags, and also for some tags like og:site_name.

defaultLocale

The default locale of your app. This sets the lang attribute of the html tag, as well as some other tags like og:locale. If the set locale is a right-to-left language, the dir attribute of the html tag will be set to rtl, otherwise its set to ltr.

locales

An array of locales that your app supports. This is used to generate the hreflang meta tags.

preconnect

An array of URLs that you want to preconnect to. This is used to generate the link tags with rel="preconnect".

textCallback

A callback function that is used to translate the text in the meta tags. This is useful if you are using a library like Vue I18n.

Manually setting meta tags

You can run

import { setMetaAttributes } from "@m-media/vue3-meta-tags";

const to = router.currentRoute.value;
const from = router.currentRoute.value; // or whatever route you want to set the meta tags for

// This will set the meta tags based on the route
setMetaAttributes(to, from);

Updating the current locale

import { setLocaleToUse } from "@m-media/vue3-meta-tags";

setLocaleToUse("en");

Setting your own JSON schema

You can set your own JSON schema for the page using the jsonSchema function.

import { updateOrCreateSchema } from "@m-media/vue3-meta-tags";

const structuredData = {
  "@context": "https://schema.org/",
  "@type": "Dataset",
  name: Maps.map.value?.title ?? "Untitled map",
  description: Maps.map.value?.description,
  url: window.location.href,
  license: "https://creativecommons.org/publicdomain/zero/1.0/",
  isAccessibleForFree: true,
  creator: {
    "@type": "Organization",
    url: "https://app.cartes.io/",
    name: "Cartes.io",
  },
  distribution: [
    {
      "@type": "DataDownload",
      encodingFormat: "JSON",
      contentUrl:
        import.meta.env.VITE_API_URL + "/api/maps/" + Maps.map.value?.uuid,
    },
  ],
  temporalCoverage: Maps.map.value?.created_at + "/..",
};

updateOrCreateSchema(structuredData);

Set a custom title

You can set a custom title for the page using the setTitle function.

import { setTitle } from "@m-media/vue3-meta-tags";

setTitle("My custom title");

Note that this function does not run through the textCallback function, so you should translate the text yourself.

Set a custom description

You can set a custom description for the page using the setDescription function.

import { setDescription } from "@m-media/vue3-meta-tags";

setDescription("My custom description");

Note that this function does not run through the textCallback function, so you should translate the text yourself.

Set follow and index

You can set the robots meta tag using the setFollowAndIndex function.

import { setFollow } from "@m-media/vue3-meta-tags";

setFollow(true);

Skipping auto meta tag resolution

You can skip the auto meta tag resolution by setting the skipAutoMetaTagResolution meta tag to true:

{
      path: "/",
      name: "home",
      meta: {
        skipMetaTagsHandler: true,
      },
      component: Home,
},

You should then manually set the meta tags using the setMetaAttributes function.