https://github.com/avivharuzi/ngx-seo
Update SEO title and meta tags easily in Angular apps
https://github.com/avivharuzi/ngx-seo
angular seo typescript
Last synced: 3 months ago
JSON representation
Update SEO title and meta tags easily in Angular apps
- Host: GitHub
- URL: https://github.com/avivharuzi/ngx-seo
- Owner: avivharuzi
- License: mit
- Created: 2020-04-18T17:15:18.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-09-23T20:13:04.000Z (about 2 years ago)
- Last Synced: 2025-07-19T05:38:29.928Z (3 months ago)
- Topics: angular, seo, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@avivharuzi/ngx-seo
- Size: 2.6 MB
- Stars: 14
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-angular - ngx-seo - Update SEO title and meta tags easily in Angular apps. (Table of contents / Angular)
- fucking-awesome-angular - ngx-seo - Update SEO title and meta tags easily in Angular apps. (Table of contents / Angular)
- fucking-awesome-angular - ngx-seo - Update SEO title and meta tags easily in Angular apps. (Table of contents / Angular)
README
# ngx-seo
Update SEO title and meta tags easily in Angular apps.
I created this library because other libraries are not fit enough to my requirements.
  
## Environment Support
- Angular 6+
- Server-side Rendering
## Compatibility
Versions compatibility list:
| @avivharuzi/ngx-seo | Angular |
| ------------------- | ------------ |
| 16.x.x | 16.x.x |
| 15.x.x | 15.x.x |
| 14.x.x | 14.x.x |
| 13.x.x | 13.x.x |
| 12.x.x | 12.x.x |
| 11.x.x | 11.x.x |
| 10.x.x | 10.x.x |
| 1.x.x | 6.xx - 9.x.x |
## Installation
```sh
npm i @avivharuzi/ngx-seo
```
OR
```sh
yarn install @avivharuzi/ngx-seo
```
## Usage
### Import NgxSeoModule
Import `NgxSeoModule` into `AppModule` imports.
```ts
import { NgxSeoModule } from '@avivharuzi/ngx-seo';
imports: [
// ...
NgxSeoModule.forRoot(),
],
```
### Update Title and Meta Tags from Routes Data
Declare SEO data for each route recommended to use `NgxSeo` interface to prevent problems.
```ts
...
import { NgxSeo } from '@avivharuzi/ngx-seo';
...
const SEO_HOME: NgxSeo = {
title: 'home page',
meta: {
description: 'home page description',
},
};
const SEO_ABOUT: NgxSeo = {
title: 'about page',
meta: {
description: 'about page description',
},
};
const routes: Routes = [
{ path: '', component: HomeComponent, data: { seo: SEO_HOME } },
{ path: 'about', component: AboutComponent, data: { seo: SEO_ABOUT } },
];
```
You can also specify custom meta tags by providing array of MetaDefinition.
```ts
const SEO_SPECIAL: NgxSeo = {
meta: {
customTags: {
mySpecial: {
name: 'mySpecial',
content: 'mySpecial content :P',
},
},
},
};
const routes: Routes = [
{ path: 'special', component: SpecialComponent, data: { seo: SEO_SPECIAL } },
];
```
### Update Title and Meta Tags Dynamically
You can also to use the service `NgxSeoService` to dynamically update title or meta tags.
```ts
...
export class MoiveDetailComponent implements OnInit {
movie: Movie;
constructor(
private movieService: MovieService,
private ngxSeoService: NgxSeoService,
) {}
ngOnInit(): void {
this.movieService.getDetails(1).subscribe(movie => {
this.movie = movie;
this.ngxSeoService.setSeo({
title: movie.title,
meta: {
description: movie.description,
},
});
});
}
}
```
## API
### NgxSeoModule
#### NgxSeoModule.forRoot(config: NgxSeoConfig)
```ts
...
NgxSeoModule.forRoot({
changeTitle: (title) => title,
preserve: false,
listenToRouteEvents: true,
})
...
```
### NgxSeoService
#### NgxSeoService.setSeo(seo: NgxSeo): void
Update SEO title and meta tags.
#### NgxSeoService.setTitle(title: string): void
Update SEO title.
#### NgxSeoService.setMeta(meta: NgxSeoMeta): void
Update SEO meta tags.
#### NgxSeoService.setMetaKeywords(metaKeywords: string | string[]): void
Update meta tag keywords.
#### NgxSeoService.setMetaDescription(metaDescription: string): void
Update meta tag description.
#### NgxSeoService.setMetaType(metaType: string): void
Update meta tag type.
#### NgxSeoService.setMetaCard(metaCard: string): void
Update meta tag card.
#### NgxSeoService.setMetaImage(metaImage: string): void
Update meta tag image.
#### NgxSeoService.setMetaUrl(metaUrl: string): void
Update meta tag url.
#### NgxSeoService.setMetaAuthor(metaAuthor: string): void
Update meta tag author.
#### NgxSeoService.setMetaSiteName(metaSiteName: string): void
Update meta tag site name.
#### NgxSeoService.setMetaCanonical(metaCanonical: string): void
Update meta tag canonical.
#### NgxSeoService.setMetaCustomTags(customTags: MetaDefinition[]): void
Update custom meta tags.
#### NgxSeoService.removeMeta(): void
Will remove all meta tags from HTML document.
# License
[MIT](LICENSE)