API Reference

Home > @davidlj95/ngx-meta

ngx-meta package

Classes

Class	Description
[NgxMetaCoreModule](./ngx-meta.ngxmetacoremodule.md)	Adds core providers of `ngx-meta` to the application. Must use [NgxMetaCoreModule.forRoot()](./ngx-meta.ngxmetacoremodule.forroot.md) method. For standalone apps, use [provideNgxMetaCore()](./ngx-meta.providengxmetacore.md) instead
[NgxMetaJsonLdModule](./ngx-meta.ngxmetajsonldmodule.md)	Adds [JSON-LD module](https://ngx-meta.dev/built-in-modules/json-ld/) metadata managers For standalone apps, use [provideNgxMetaJsonLd()](./ngx-meta.providengxmetajsonld.md) instead
[NgxMetaMetadataLoaderModule](./ngx-meta.ngxmetametadataloadermodule.md)	Allows to load metadata modules after library has been initialized For standalone apps, use [provideNgxMetaMetadataLoader()](./ngx-meta.providengxmetametadataloader.md) instead
[NgxMetaMetaService](./ngx-meta.ngxmetametaservice.md)	Upserts (or removes) `` elements in the current page using Angular's [Meta](https://angular.dev/api/platform-browser/Meta) under the hood.
[NgxMetaOpenGraphModule](./ngx-meta.ngxmetaopengraphmodule.md)	Adds [Open Graph module](https://ngx-meta.dev/built-in-modules/open-graph/) basic & optional metadata managers For standalone apps, use [provideNgxMetaOpenGraph()](./ngx-meta.providengxmetaopengraph.md) instead
[NgxMetaOpenGraphProfileModule](./ngx-meta.ngxmetaopengraphprofilemodule.md)	Adds [Open Graph module](https://ngx-meta.dev/built-in-modules/open-graph/) profile metadata managers For standalone apps, use [provideNgxMetaOpenGraphProfile()](./ngx-meta.providengxmetaopengraphprofile.md) instead
[NgxMetaRoutingModule](./ngx-meta.ngxmetaroutingmodule.md)	Allows to manage metadata of a page by specifying it in its Angular's [Route.data](https://angular.dev/api/router/Route#:~:text=a%20synchronous%20context.-,data,-Data) For standalone apps, use [provideNgxMetaRouting()](./ngx-meta.providengxmetarouting.md) instead
[NgxMetaService](./ngx-meta.ngxmetaservice.md)	Manages the metadata values of the current page
[NgxMetaStandardModule](./ngx-meta.ngxmetastandardmodule.md)	Adds [standard module](https://ngx-meta.dev/built-in-modules/standard/) metadata managers For standalone apps, use [provideNgxMetaStandard()](./ngx-meta.providengxmetastandard.md) instead
[NgxMetaTwitterCardModule](./ngx-meta.ngxmetatwittercardmodule.md)	Adds [Twitter Cards module](https://ngx-meta.dev/built-in-modules/twitter-cards/) metadata managers For standalone apps, use [provideNgxMetaTwitterCard()](./ngx-meta.providengxmetatwittercard.md) instead

Abstract Classes

Abstract Class	Description
[NgxMetaMetadataManager](./ngx-meta.ngxmetametadatamanager.md)	Abstract class every metadata manager must implement. Used as [injection token](https://angular.dev/guide/di/dependency-injection-providers#using-an-injectiontoken-object) to provide metadata managers the library will take into account. Can be created with [makeMetadataManagerProviderFromSetterFactory()](./ngx-meta.makemetadatamanagerproviderfromsetterfactory.md)

Functions

Function	Description
[makeComposedKeyValMetaDefinition(names, options)](./ngx-meta.makecomposedkeyvalmetadefinition.md)	Creates a key / value meta definition (see [makeKeyValMetaDefinition()](./ngx-meta.makekeyvalmetadefinition.md)) where the key is composed by several parts.
[makeKeyValMetaDefinition(keyName, options)](./ngx-meta.makekeyvalmetadefinition.md)	Creates a [NgxMetaMetaDefinition](./ngx-meta.ngxmetametadefinition.md) for its use with [NgxMetaMetaService](./ngx-meta.ngxmetametaservice.md) by understanding `` elements as key / value pair elements. Read the API reference docs for more info.
[makeMetadataManagerProviderFromSetterFactory(setterFactory, opts)](./ngx-meta.makemetadatamanagerproviderfromsetterfactory.md)	Creates an Angular's [Factory provider](https://angular.dev/guide/di/dependency-injection-providers#factory-providers-usefactory) that provides an [NgxMetaMetadataManager](./ngx-meta.ngxmetametadatamanager.md)
[provideNgxMetaCore(features)](./ngx-meta.providengxmetacore.md)	Adds core services of the library to the application. For module-based apps, use [NgxMetaCoreModule.forRoot()](./ngx-meta.ngxmetacoremodule.forroot.md) instead Allows specifying some default metadata values. Keep reading.
[provideNgxMetaJsonLd()](./ngx-meta.providengxmetajsonld.md)	Adds [JSON-LD module](https://ngx-meta.dev/built-in-modules/json-ld/) metadata managers For module-based apps, use [NgxMetaJsonLdModule](./ngx-meta.ngxmetajsonldmodule.md) instead
[provideNgxMetaMetadataLoader()](./ngx-meta.providengxmetametadataloader.md)	Allows to load metadata modules after library has been initialized For module-based apps, use [NgxMetaMetadataLoaderModule](./ngx-meta.ngxmetametadataloadermodule.md) instead
[provideNgxMetaOpenGraph()](./ngx-meta.providengxmetaopengraph.md)	Adds [Open Graph module](https://ngx-meta.dev/built-in-modules/open-graph/) basic & optional metadata managers For module-based apps, use [NgxMetaOpenGraphModule](./ngx-meta.ngxmetaopengraphmodule.md) instead
[provideNgxMetaOpenGraphProfile()](./ngx-meta.providengxmetaopengraphprofile.md)	Adds [Open Graph module](https://ngx-meta.dev/built-in-modules/open-graph/) profile metadata managers For module-based apps, use [NgxMetaOpenGraphProfileModule](./ngx-meta.ngxmetaopengraphprofilemodule.md) instead
[provideNgxMetaRouting()](./ngx-meta.providengxmetarouting.md)	Allows to manage metadata of a page by specifying it in its Angular's [Route.data](https://angular.dev/api/router/Route#:~:text=a%20synchronous%20context.-,data,-Data) For module-based apps, use [NgxMetaRoutingModule](./ngx-meta.ngxmetaroutingmodule.md) instead
[provideNgxMetaStandard()](./ngx-meta.providengxmetastandard.md)	Adds [standard module](https://ngx-meta.dev/built-in-modules/standard/) metadata managers For module-based apps, use [NgxMetaStandardModule](./ngx-meta.ngxmetastandardmodule.md) instead
[provideNgxMetaTwitterCard()](./ngx-meta.providengxmetatwittercard.md)	Adds [Twitter Cards module](https://ngx-meta.dev/built-in-modules/twitter-cards/) metadata managers For module-based apps, use [NgxMetaTwitterCardModule](./ngx-meta.ngxmetatwittercardmodule.md) instead
[withNgxMetaDefaults(defaults)](./ngx-meta.withngxmetadefaults.md)	Allows to configure default metadata values. Use it as part of [provideNgxMetaCore()](./ngx-meta.providengxmetacore.md) For module-based apps, check out [NgxMetaCoreModule.forRoot()](./ngx-meta.ngxmetacoremodule.forroot.md)

Interfaces

Interface	Description
[GlobalMetadata](./ngx-meta.globalmetadata.md)	Specifies metadata that will be used by more than one module
[GlobalMetadataImage](./ngx-meta.globalmetadataimage.md)	Specifies image metadata (will be used for link previews / social cards) to be used for more than one module. Like: - [OpenGraph.image](./ngx-meta.opengraph.image.md) (needs standard module) - [TwitterCard.image](./ngx-meta.twittercard.image.md) (needs Twitter Cards module) Open Graph allows for more attributes for the image. Specify [OpenGraph.image](./ngx-meta.opengraph.image.md) if you want to customize those too.
[JsonLdMetadata](./ngx-meta.jsonldmetadata.md)	Utility type to provide specific [JSON-LD module](https://ngx-meta.dev/built-in-modules/json-ld/) metadata
[MetadataResolverOptions](./ngx-meta.metadataresolveroptions.md)	See [NgxMetaMetadataManager.resolverOptions](./ngx-meta.ngxmetametadatamanager.resolveroptions.md)
[NgxMetaMetaDefinition](./ngx-meta.ngxmetametadefinition.md)	Models a `` element which [NgxMetaMetaService](./ngx-meta.ngxmetametaservice.md) can upsert with a given value (or remove if value is not provided or `null`) Can be created with [makeKeyValMetaDefinition()](./ngx-meta.makekeyvalmetadefinition.md) and [makeComposedKeyValMetaDefinition()](./ngx-meta.makecomposedkeyvalmetadefinition.md) factory functions.
[NgxMetaRouteData](./ngx-meta.ngxmetaroutedata.md)	Utility type to ensure metadata values are set properly inside an Angular's [Route.data](https://angular.dev/api/router/Route#:~:text=a%20synchronous%20context.-,data,-Data) You can also provide specific metadata module types to ensure type safety of the metadata values. Open the API to see an example.
[OpenGraph](./ngx-meta.opengraph.md)	[Open Graph module](https://ngx-meta.dev/built-in-modules/open-graph/) metadata values that can be set
[OpenGraphImage](./ngx-meta.opengraphimage.md)	See [OpenGraph.image](./ngx-meta.opengraph.image.md)
[OpenGraphMetadata](./ngx-meta.opengraphmetadata.md)	Utility type to provide specific [Open Graph module](https://ngx-meta.dev/built-in-modules/open-graph/) metadata
[OpenGraphProfile](./ngx-meta.opengraphprofile.md)	Open Graph profile metadata for this page See [OpenGraph.profile](./ngx-meta.opengraph.profile.md)
[Standard](./ngx-meta.standard.md)	[Standard module](https://ngx-meta.dev/built-in-modules/standard/) metadata values that can be set
[StandardMetadata](./ngx-meta.standardmetadata.md)	Utility type to provide specific [standard module](https://ngx-meta.dev/built-in-modules/standard/) metadata
[TwitterCard](./ngx-meta.twittercard.md)	[Twitter Cards module](https://ngx-meta.dev/built-in-modules/twitter-cards/) metadata values that can be set
[TwitterCardCreatorId](./ngx-meta.twittercardcreatorid.md)	See [TwitterCard.creator](./ngx-meta.twittercard.creator.md)
[TwitterCardCreatorUsername](./ngx-meta.twittercardcreatorusername.md)	See [TwitterCard.creator](./ngx-meta.twittercard.creator.md)
[TwitterCardImage](./ngx-meta.twittercardimage.md)	See [TwitterCard.image](./ngx-meta.twittercard.image.md)
[TwitterCardMetadata](./ngx-meta.twittercardmetadata.md)	Utility type to provide specific [Twitter Cards module](https://ngx-meta.dev/built-in-modules/twitter-cards/) metadata
[TwitterCardSiteId](./ngx-meta.twittercardsiteid.md)	See [TwitterCard.site](./ngx-meta.twittercard.site.md)
[TwitterCardSiteUsername](./ngx-meta.twittercardsiteusername.md)	See [TwitterCard.site](./ngx-meta.twittercard.site.md)

Variables

Variable	Description
[JSON\_LD\_METADATA\_PROVIDER](./ngx-meta.json_ld_metadata_provider.md)	Manages the [JsonLdMetadata.jsonLd](./ngx-meta.jsonldmetadata.jsonld.md) metadata
[OPEN\_GRAPH\_DESCRIPTION\_METADATA\_PROVIDER](./ngx-meta.open_graph_description_metadata_provider.md)	Manages the [OpenGraph.description](./ngx-meta.opengraph.description.md) metadata
[OPEN\_GRAPH\_IMAGE\_METADATA\_PROVIDER](./ngx-meta.open_graph_image_metadata_provider.md)	Manages the [OpenGraph.image](./ngx-meta.opengraph.image.md) metadata
[OPEN\_GRAPH\_LOCALE\_METADATA\_PROVIDER](./ngx-meta.open_graph_locale_metadata_provider.md)	Manages the [OpenGraph.locale](./ngx-meta.opengraph.locale.md) metadata
[OPEN\_GRAPH\_PROFILE\_FIRST\_NAME\_METADATA\_PROVIDER](./ngx-meta.open_graph_profile_first_name_metadata_provider.md)	Manages the [OpenGraphProfile.firstName](./ngx-meta.opengraphprofile.firstname.md) metadata
[OPEN\_GRAPH\_PROFILE\_GENDER\_FEMALE](./ngx-meta.open_graph_profile_gender_female.md)	See [OpenGraphProfileGender](./ngx-meta.opengraphprofilegender.md)
[OPEN\_GRAPH\_PROFILE\_GENDER\_MALE](./ngx-meta.open_graph_profile_gender_male.md)	See [OpenGraphProfileGender](./ngx-meta.opengraphprofilegender.md)
[OPEN\_GRAPH\_PROFILE\_GENDER\_METADATA\_PROVIDER](./ngx-meta.open_graph_profile_gender_metadata_provider.md)	Manages the [OpenGraphProfile.gender](./ngx-meta.opengraphprofile.gender.md) metadata
[OPEN\_GRAPH\_PROFILE\_LAST\_NAME\_METADATA\_PROVIDER](./ngx-meta.open_graph_profile_last_name_metadata_provider.md)	Manages the [OpenGraphProfile.lastName](./ngx-meta.opengraphprofile.lastname.md) metadata
[OPEN\_GRAPH\_PROFILE\_USERNAME\_METADATA\_PROVIDER](./ngx-meta.open_graph_profile_username_metadata_provider.md)	Manages the [OpenGraphProfile.username](./ngx-meta.opengraphprofile.username.md) metadata
[OPEN\_GRAPH\_SITE\_NAME\_METADATA\_PROVIDER](./ngx-meta.open_graph_site_name_metadata_provider.md)	Manages the [OpenGraph.siteName](./ngx-meta.opengraph.sitename.md) metadata
[OPEN\_GRAPH\_TITLE\_METADATA\_PROVIDER](./ngx-meta.open_graph_title_metadata_provider.md)	Manages the [OpenGraph.title](./ngx-meta.opengraph.title.md) metadata
[OPEN\_GRAPH\_TYPE\_ARTICLE](./ngx-meta.open_graph_type_article.md)	See [OpenGraphType](./ngx-meta.opengraphtype.md)
[OPEN\_GRAPH\_TYPE\_BOOK](./ngx-meta.open_graph_type_book.md)	See [OpenGraphType](./ngx-meta.opengraphtype.md)
[OPEN\_GRAPH\_TYPE\_METADATA\_PROVIDER](./ngx-meta.open_graph_type_metadata_provider.md)	Manages the [OpenGraph.type](./ngx-meta.opengraph.type.md) metadata
[OPEN\_GRAPH\_TYPE\_MUSIC\_ALBUM](./ngx-meta.open_graph_type_music_album.md)	See [OpenGraphType](./ngx-meta.opengraphtype.md)
[OPEN\_GRAPH\_TYPE\_MUSIC\_PLAYLIST](./ngx-meta.open_graph_type_music_playlist.md)	See [OpenGraphType](./ngx-meta.opengraphtype.md)
[OPEN\_GRAPH\_TYPE\_MUSIC\_RADIO\_STATION](./ngx-meta.open_graph_type_music_radio_station.md)	See [OpenGraphType](./ngx-meta.opengraphtype.md)
[OPEN\_GRAPH\_TYPE\_MUSIC\_SONG](./ngx-meta.open_graph_type_music_song.md)	See [OpenGraphType](./ngx-meta.opengraphtype.md)
[OPEN\_GRAPH\_TYPE\_PROFILE](./ngx-meta.open_graph_type_profile.md)	See [OpenGraphType](./ngx-meta.opengraphtype.md)
[OPEN\_GRAPH\_TYPE\_VIDEO\_EPISODE](./ngx-meta.open_graph_type_video_episode.md)	See [OpenGraphType](./ngx-meta.opengraphtype.md)
[OPEN\_GRAPH\_TYPE\_VIDEO\_MOVIE](./ngx-meta.open_graph_type_video_movie.md)	See [OpenGraphType](./ngx-meta.opengraphtype.md)
[OPEN\_GRAPH\_TYPE\_VIDEO\_OTHER](./ngx-meta.open_graph_type_video_other.md)	See [OpenGraphType](./ngx-meta.opengraphtype.md)
[OPEN\_GRAPH\_TYPE\_VIDEO\_TV\_SHOW](./ngx-meta.open_graph_type_video_tv_show.md)	See [OpenGraphType](./ngx-meta.opengraphtype.md)
[OPEN\_GRAPH\_TYPE\_WEBSITE](./ngx-meta.open_graph_type_website.md)	See [OpenGraphType](./ngx-meta.opengraphtype.md)
[OPEN\_GRAPH\_URL\_METADATA\_PROVIDER](./ngx-meta.open_graph_url_metadata_provider.md)	Manages the [OpenGraph.url](./ngx-meta.opengraph.url.md) metadata
[STANDARD\_APPLICATION\_NAME\_METADATA\_PROVIDER](./ngx-meta.standard_application_name_metadata_provider.md)	Manages the [Standard.applicationName](./ngx-meta.standard.applicationname.md) metadata
[STANDARD\_AUTHOR\_METADATA\_PROVIDER](./ngx-meta.standard_author_metadata_provider.md)	Manages the [Standard.author](./ngx-meta.standard.author.md) metadata
[STANDARD\_CANONICAL\_URL\_METADATA\_PROVIDER](./ngx-meta.standard_canonical_url_metadata_provider.md)	Manages the [Standard.canonicalUrl](./ngx-meta.standard.canonicalurl.md) metadata
[STANDARD\_DESCRIPTION\_METADATA\_PROVIDER](./ngx-meta.standard_description_metadata_provider.md)	Manages the [Standard.description](./ngx-meta.standard.description.md) metadata
[STANDARD\_GENERATOR\_METADATA\_PROVIDER](./ngx-meta.standard_generator_metadata_provider.md)	Manages the [Standard.generator](./ngx-meta.standard.generator.md) metadata
[STANDARD\_KEYWORDS\_METADATA\_PROVIDER](./ngx-meta.standard_keywords_metadata_provider.md)	Manages the [Standard.keywords](./ngx-meta.standard.keywords.md) metadata
[STANDARD\_LOCALE\_METADATA\_PROVIDER](./ngx-meta.standard_locale_metadata_provider.md)	Manages the [Standard.locale](./ngx-meta.standard.locale.md) metadata
[STANDARD\_TITLE\_METADATA\_PROVIDER](./ngx-meta.standard_title_metadata_provider.md)	Manages the [Standard.title](./ngx-meta.standard.title.md) metadata
[TWITTER\_CARD\_CARD\_METADATA\_PROVIDER](./ngx-meta.twitter_card_card_metadata_provider.md)	Manages the [TwitterCard.card](./ngx-meta.twittercard.card.md) metadata
[TWITTER\_CARD\_CREATOR\_METADATA\_PROVIDER](./ngx-meta.twitter_card_creator_metadata_provider.md)	Manages the [TwitterCard.creator](./ngx-meta.twittercard.creator.md) metadata
[TWITTER\_CARD\_DESCRIPTION\_METADATA\_PROVIDER](./ngx-meta.twitter_card_description_metadata_provider.md)	Manages the [TwitterCard.description](./ngx-meta.twittercard.description.md) metadata
[TWITTER\_CARD\_IMAGE\_METADATA\_PROVIDER](./ngx-meta.twitter_card_image_metadata_provider.md)	Manages the [TwitterCard.image](./ngx-meta.twittercard.image.md) metadata
[TWITTER\_CARD\_SITE\_METADATA\_PROVIDER](./ngx-meta.twitter_card_site_metadata_provider.md)	Manages the [TwitterCard.site](./ngx-meta.twittercard.site.md) metadata
[TWITTER\_CARD\_TITLE\_METADATA\_PROVIDER](./ngx-meta.twitter_card_title_metadata_provider.md)	Manages the [TwitterCard.title](./ngx-meta.twittercard.title.md) metadata
[TWITTER\_CARD\_TYPE\_APP](./ngx-meta.twitter_card_type_app.md)	See [TwitterCardType](./ngx-meta.twittercardtype.md)
[TWITTER\_CARD\_TYPE\_PLAYER](./ngx-meta.twitter_card_type_player.md)	See [TwitterCardType](./ngx-meta.twittercardtype.md)
[TWITTER\_CARD\_TYPE\_SUMMARY\_LARGE\_IMAGE](./ngx-meta.twitter_card_type_summary_large_image.md)	See [TwitterCardType](./ngx-meta.twittercardtype.md)
[TWITTER\_CARD\_TYPE\_SUMMARY](./ngx-meta.twitter_card_type_summary.md)	See [TwitterCardType](./ngx-meta.twittercardtype.md)

Type Aliases

Type Alias	Description
[MetadataSetter](./ngx-meta.metadatasetter.md)	See [NgxMetaMetadataManager.set](./ngx-meta.ngxmetametadatamanager.set.md)
[MetadataSetterFactory](./ngx-meta.metadatasetterfactory.md)	Utility type for a function that returns a [MetadataSetter](./ngx-meta.metadatasetter.md) provided some dependencies (which should be able to be injectable)
[MetadataValues](./ngx-meta.metadatavalues.md)	Defines the metadata values to use for a page. Broadly speaking, it's just a JSON object
[NgxMetaMetaContent](./ngx-meta.ngxmetametacontent.md)	Content to be set for a specific `` element in the page Can be `undefined` or `null`. In that case, the element will be removed. See [NgxMetaMetaService](./ngx-meta.ngxmetametaservice.md)
[OpenGraphProfileGender](./ngx-meta.opengraphprofilegender.md)	Genders for [OpenGraphProfile.gender](./ngx-meta.opengraphprofile.gender.md) property
[OpenGraphType](./ngx-meta.opengraphtype.md)	Types for [OpenGraph.type](./ngx-meta.opengraph.type.md) property
[TwitterCardCreator](./ngx-meta.twittercardcreator.md)	See [TwitterCard.creator](./ngx-meta.twittercard.creator.md)
[TwitterCardSite](./ngx-meta.twittercardsite.md)	See [TwitterCard.site](./ngx-meta.twittercard.site.md)
[TwitterCardType](./ngx-meta.twittercardtype.md)	Card types for [TwitterCard.card](./ngx-meta.twittercard.card.md) property