Skip to content

Ngx meta.globalmetadata

Home > @davidlj95/ngx-meta > GlobalMetadata

GlobalMetadata interface

Specifies metadata that will be used by more than one module.

Signature:

export interface GlobalMetadata 

Properties

Property Modifiers Type Description
applicationName? readonly string | null

(Optional) Sets application name for:

- Standard.applicationName (needs standard module)

- OpenGraph.siteName (needs Open Graph module)

canonicalUrl? readonly URL | AngularRouterUrl | string | null

(Optional) Sets canonical URL for:

- Standard.canonicalUrl (needs standard module)

- OpenGraph.url (needs Open Graph module)

If URL resolution feature is enabled, you may use a relative URL here. It will be resolved and the absolute URL will be used instead.

You can also use the special value ANGULAR_ROUTER_URL to use the current Angular router's URL as the relative URL to be resolved into an absolute one.

description? readonly string | null

(Optional) Sets description for:

- Standard.description (needs standard module)

- OpenGraph.description (needs Open Graph module)

- TwitterCard.description (needs Twitter Cards module)

image? readonly GlobalMetadataImage | null

(Optional) Specifies image metadata (will be used for link previews / social cards) to be used for more than one module. Like:

- OpenGraph.image (needs standard module)

- TwitterCard.image (needs Twitter Cards module)

Open Graph allows for more attributes for the image. Specify OpenGraph.image if you want to customize those too.

locale? readonly string | null

(Optional) Sets localization of this page.

Value must be a valid language tag complying with BCP 47. For instance: "es" or "es-ES"

For:

- Standard.locale (needs standard module)

- OpenGraph.locale (needs Open Graph module)

title? readonly string

(Optional) Sets title for:

- Standard.title (needs standard module)

- OpenGraph.title (needs Open Graph module)

- TwitterCard.title (needs Twitter Cards module)