Update HTML meta tags for title, description and others automatically based on the route in your Angular app.
ng2-meta v5.0.0+ requires Angular 6.
On Angular 5 or lower, use ng2-meta v4.0.0 (npm install ng2-meta@4.0.0)
For the AngularJS (1.x) module, check out ngMeta
To install this library, run:
$ npm install ng2-meta --saveAdd meta tags and MetaGuard to routes. By default, title and description values are duplicated for og:title and og:description, so there's no need to add them separately.
import { MetaGuard } from 'ng2-meta';
const routes: Routes = [
{
path: 'home',
component: HomeComponent,
canActivate: [MetaGuard],
data: {
meta: {
title: 'Home page',
description: 'Description of the home page'
}
}
},
{
path: 'dashboard',
component: DashboardComponent,
canActivate: [MetaGuard],
data: {
meta: {
title: 'Dashboard',
description: 'Description of the dashboard page',
'og:image': 'http://example.com/dashboard-image.png'
}
}
}
];
...
import { MetaModule } from 'ng2-meta';
@NgModule({
declarations: [
AppComponent,
...
],
imports: [
BrowserModule,
FormsModule,
HttpModule,
RouterModule.forRoot(routes),
MetaModule.forRoot()
],
bootstrap: [AppComponent]
})
import { MetaService } from 'ng2-meta';
@Component({
...
})
export class AppComponent {
constructor(private metaService: MetaService) {}
}
You're all set! ng2-meta will update the meta tags whenever the route changes.
Set default values for tags. These values are used when routes without meta: {} information are encountered.
import { MetaConfig, MetaService } from 'ng2-meta';
const metaConfig: MetaConfig = {
//Append a title suffix such as a site name to all titles
//Defaults to false
useTitleSuffix: true,
defaults: {
title: 'Default title for pages without meta in their route',
titleSuffix: ' | Site Name',
'og:image': 'http://example.com/default-image.png',
'any other': 'arbitrary tag can be used'
}
};
@NgModule({
declarations: [
AppComponent,
...
],
imports: [
...,
MetaModule.forRoot(metaConfig)
],
bootstrap: [AppComponent]
})import { Component, OnInit } from '@angular/core';
class ProductComponent implements OnInit {
...
constructor(private metaService: MetaService) {}
ngOnInit() {
this.product = //HTTP GET for product in catalogue
this.metaService.setTitle('Product page for '+this.product.name);
this.metaService.setTag('og:image',this.product.imageURL);
}
}While Google executes Javascript and extracts meta tags set by ng2-meta, many bots (like Facebook and Twitter) do not execute Javascript. Consider defining fallback meta tags in your HTML for such bots. The fallback content is overridden by ng2-meta in Javascript-enabled environments.
<html>
<head>
<meta name="title" content="Website Name">
<meta name="og:title" content="Website Name">
<meta name="description" content="General description of your site">
<meta name="og:description" content="General description of your site">
<meta name="og:image" content="http://example.com/fallback-image.png">
</head>
</html>If you wish to contribute to this repo, please check out the open issues.
If you notice a bug that has not already been reported or would like to make a feature request, please create a new issue. This helps to start a discussion with the community and avoid duplication of effort before you make any changes.
MIT © Vinay Gopinath