Skip to main content

Abstract Class: MetaManager

Defined in: packages/core/src/meta/MetaManager.ts:25

The Meta manager is a utility for managing various page attributes related to the SEO (search engine optimization) and social network integration.

The Meta manager is used to manage the following:

  • page title, set using the contents of the <title> element
  • page links, linking related documents and meta-information, added to the using <link> elements
  • page meta information:
    • the generic named meta information added to the page via <meta>} elements with the nameattribute, for example thekeywords`.
    • specialized meta information added to the page via <meta> elements with the property attribute, for example the OG meta tags (og:type, og:image, etc.).

Extended by​

Constructors​

Constructor​

new MetaManager(): MetaManager

Returns​

MetaManager

Methods​

clearMetaAttributes()​

clearMetaAttributes(): void

Defined in: packages/core/src/meta/MetaManager.ts:195

Resets the stored meta names, properties and links.

Returns​

void

getLink(relation): MetaManagerRecord<"href">

Defined in: packages/core/src/meta/MetaManager.ts:169

Return the reference to the specified related linked document. The method returns an empty string for missing meta information (to make the returned value React-friendly).

Parameters​

relation​

string

The relation of the link target to the current page.

Returns​

MetaManagerRecord<"href">

The reference to the location of the related document, e.g. a URL.

getLinks(): string[]

Defined in: packages/core/src/meta/MetaManager.ts:177

Returns the relations of the currently set related documents linked to the current page.

Returns​

string[]

getLinksIterator()​

getLinksIterator(): never[] | IterableIterator<[string, MetaManagerRecord<"href">], any, any>

Defined in: packages/core/src/meta/MetaManager.ts:186

Return [key, value] pairs of currently set links.

Returns​

never[] | IterableIterator<[string, MetaManagerRecord<"href">], any, any>

[key, value] pairs of currently set links.

getMetaName()​

getMetaName(name): MetaManagerRecord<"content">

Defined in: packages/core/src/meta/MetaManager.ts:69

Returns the value of the specified named meta information property. The method returns an empty string for missing meta information (to make the returned value React-friendly).

Parameters​

name​

string

The name of the named meta information property.

Returns​

MetaManagerRecord<"content">

The value of the generic meta information, or an empty string.

getMetaNames()​

getMetaNames(): string[]

Defined in: packages/core/src/meta/MetaManager.ts:80

Returns the names of the currently specified named meta information properties.

Returns​

string[]

The names of the currently specified named meta information properties.

getMetaNamesIterator()​

getMetaNamesIterator(): never[] | IterableIterator<[string, MetaManagerRecord<"content">], any, any>

Defined in: packages/core/src/meta/MetaManager.ts:89

Return [key, value] pairs of named meta information.

Returns​

never[] | IterableIterator<[string, MetaManagerRecord<"content">], any, any>

[key, value] pairs of named meta information.

getMetaProperties()​

getMetaProperties(): string[]

Defined in: packages/core/src/meta/MetaManager.ts:131

Returns the names of the currently specified specialized meta information properties.

Returns​

string[]

The names of the currently specified specialized meta information properties.

getMetaPropertiesIterator()​

getMetaPropertiesIterator(): never[] | IterableIterator<[string, MetaManagerRecord<"content">], any, any>

Defined in: packages/core/src/meta/MetaManager.ts:140

Return [key, value] pairs of meta information properties.

Returns​

never[] | IterableIterator<[string, MetaManagerRecord<"content">], any, any>

[key, value] pairs of meta information properties.

getMetaProperty()​

getMetaProperty(property): MetaManagerRecord<"content">

Defined in: packages/core/src/meta/MetaManager.ts:120

Returns the value of the specified specialized meta information property. The method returns an empty string for missing meta information (to make the returned value React-friendly).

Parameters​

property​

string

Returns​

MetaManagerRecord<"content">

The value of the specified meta information, or an empty string.

getTitle()​

getTitle(): string

Defined in: packages/core/src/meta/MetaManager.ts:45

Returns the page title. The method returns an empty string if no page title has been set yet.

Note that the page title is cached internally by the meta manager and may therefore differ from the current document title if it has been modified by a 3rd party code.

Returns​

string

The current page title.

setLink(relation, href, attr?): this

Defined in: packages/core/src/meta/MetaManager.ts:155

Sets the specified specialized link information.

Parameters​

relation​

string

The relation of the link target to the current page.

href​

MetaValue

The reference to the location of the related document, e.g. a URL.

attr?​

MetaAttributes

Returns​

this

Parram​

attr Additional optional link attributes.

setMetaName()​

setMetaName(name, content, attr?): this

Defined in: packages/core/src/meta/MetaManager.ts:57

Set the specified named meta information property.

Parameters​

name​

string

Meta information property name, for example keywords.

content​

MetaValue

The meta information content.

attr?​

MetaAttributes

Returns​

this

Parram​

attr Additional optional meta attributes.

setMetaProperty()​

setMetaProperty(property, content, attr?): this

Defined in: packages/core/src/meta/MetaManager.ts:102

Sets the specified specialized meta information property.

Parameters​

property​

string

The value of the meta information property.

content​

MetaValue

attr?​

MetaAttributes

Returns​

this

Parram​

attr Additional optional meta attributes.

setTitle()​

setTitle(title): this

Defined in: packages/core/src/meta/MetaManager.ts:31

Sets the page title.

Parameters​

title​

string

The new page title.

Returns​

this