Need help with vue-headful?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

troxler
230 Stars 19 Forks MIT License 16 Commits 0 Opened issues

Description

Set document title and meta tags with Vue.js

Services available

!
?

Need anything else?

Contributors list

# 34,151
CSS
css-fra...
meta-ta...
HTML
16 commits

vue-headful

vue-headful allows to set the title and several meta tags of your document from any Vue.js view. vue-headful is a tiny wrapper around Headful, a generic library to set meta tags with JavaScript.

Install

npm i vue-headful

Usage

Register the component:

import Vue from 'vue';
import vueHeadful from 'vue-headful';

Vue.component('vue-headful', vueHeadful);

new Vue({ // your configuration });

And then use the

vue-headful
component in every of your views:

Documentation

vue-headful is only a wrapper around Headful and by itself does not do that much. vue-headful supports all the head properties that are supported by Headful. You can find a non-complete list of head properties in the following example:


If there are any other head properties or attributes you want to set, you can use

html
(for arbitrary elements in the whole document) or
head
(for elements within
) as follows.
The selectors can be any valid CSS selector.

If you want to remove a previously defined attribute from an element, you can set it to

null
as in the example below:

Note that neither Headful nor vue-headful add missing HTML elements, they only add attribute values. So it is important that you add everything that you want to have populated in your HTML first. For example, to specify the title and description you have to prepare the HTML as follows.

<title></title>
<meta itemprop="name">
<meta property="og:title">
<meta name="twitter:title">
<meta name="description">
<meta itemprop="description">
<meta property="og:description">
<meta name="twitter:description">

vue-headful also supports dynamic properties (e.g.

v-bind:title="variableName"
or
:title="variableName"
) and adds watchers to everything. That means you can also set head properties asynchronously, for example after an API request.

Also see the non-complete list of meta tags and other head properties you can define using vue-headful:

For more information on everything you can put into

, have a look at https://gethead.info/.

Compatibility

vue-headful works with every current and most reasonably old web browsers. If you need to support older browsers including Internet Explorer, have a look at Headful: Compatibility.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.