Class HeadManager

A fluent head builder. Every method returns this for chaining; toContext produces the final HeadContext.

Index

Constructors

Constructors

constructor

new HeadManager(initial?: HeadContext): HeadManager
Create a HeadManager, optionally seeded from an existing context.
Parameters
- initial: HeadContext = {}
  An initial head context to extend.
Returns HeadManager

Methods

alternate

alternate(href: string, attrs?: Record<string, unknown>): this
Set an alternate link (e.g. hreflang or RSS feed).
Parameters
- href: string
  The alternate URL.
- attrs: Record<string, unknown> = {}
  Extra attributes (e.g. { hreflang: 'fr' }, { type: 'application/rss+xml' }).
Returns this

base

base(href: string, target?: string): this
Set the <base> element.
Parameters
- href: string
  The base href.
- Optionaltarget: string
  The base target.
Returns this

bodyAttributes

bodyAttributes(attributes: Record<string, string>): this
Set attributes on the <body> element.
Parameters
- attributes: Record<string, string>
  Attribute map.
Returns this

canonical

canonical(href: string): this
Set the canonical URL (<link rel="canonical">).
Parameters
- href: string
  The canonical URL.
Returns this

charset

charset(value?: string): this
Set the document character set (<meta charset>).
Parameters
- value: string = 'utf-8'
  The charset (default utf-8).
Returns this

description

description(value: string): this
Set the meta description (and the og:description fallback source).
Parameters
- value: string
  The description text.
Returns this

htmlAttributes

htmlAttributes(attributes: Record<string, string>): this
Set attributes on the <html> element.
Parameters
- attributes: Record<string, string>
  Attribute map (e.g. { lang: 'en' }).
Returns this

jsonLd

jsonLd(data: Record<string, unknown>): this
Add a JSON-LD structured-data block (<script type="application/ld+json">).
Parameters
- data: Record<string, unknown>
  The JSON-LD object.
Returns this

link

link(descriptor: LinkDescriptor): this
Add a link descriptor (deduped by rel+href).
Parameters
- descriptor: LinkDescriptor
  The link descriptor.
Returns this

merge

merge(other: HeadContext | HeadManager): this
Merge another head context (or manager) into this one. Later values win; metas/links are deduped. Enables hierarchical heads (layout head + page head).
Parameters
- other: HeadContext | HeadManager
  The head context or manager to merge in.
Returns this

meta

meta(descriptor: Record<string, unknown> | MetaDescriptor): this
Add or replace a raw meta descriptor (deduped by name/property/charset).
Parameters
- descriptor: Record<string, unknown> | MetaDescriptor
  The meta descriptor.
Returns this

og

og(options: OpenGraphOptions): this
Add Open Graph meta tags. Falls back to the current title/description when omitted.
Parameters
- options: OpenGraphOptions
  Open Graph options.
Returns this

preload

preload(
    href: string,
    as?: string,
    rel?: "preload" | "prefetch" | "modulepreload",
): this
Add a preload/prefetch/modulepreload link.
Parameters
- href: string
  The resource URL.
- Optionalas: string
  The as attribute (e.g. script, style, font, image).
- rel: "preload" | "prefetch" | "modulepreload" = 'preload'
  The relationship (default preload).
Returns this

robots

robots(options: RobotsOptions): this
Set robots directives (<meta name="robots">).
Parameters
- options: RobotsOptions
  Robots directives.
Returns this

script

script(descriptor: ScriptDescriptor): this
Add a script descriptor (external via src, or inline via content).
Parameters
- descriptor: ScriptDescriptor
  The script descriptor.
Returns this

style

style(css: string, attrs?: Record<string, unknown>): this
Add an inline style block.
Parameters
- css: string
  The CSS text.
- attrs: Record<string, unknown> = {}
  Extra attributes (e.g. media).
Returns this

stylesheet

stylesheet(href: string, attrs?: Record<string, unknown>): this
Add a stylesheet link.
Parameters
- href: string
  The stylesheet URL.
- attrs: Record<string, unknown> = {}
  Extra attributes (e.g. media).
Returns this

themeColor

themeColor(value: string): this
Set the theme color meta.
Parameters
- value: string
  A CSS color.
Returns this

title

title(value: string): this
Set the document title.
Parameters
- value: string
  The title text.
Returns this

titleTemplate

titleTemplate(template: string): this
Set a title template, e.g. '%s — Stone.js' where %s is replaced by the title.
Parameters
- template: string
  The template string containing %s.
Returns this

toContext

toContext(): HeadContext

Produce the final head context. The title template (if any) is applied to the title.

Returns HeadContext
The resolved HeadContext.

twitter

twitter(options: TwitterOptions): this
Add Twitter card meta tags. Falls back to the current title/description when omitted.
Parameters
- options: TwitterOptions
  Twitter card options.
Returns this

viewport

viewport(value?: string): this
Set the viewport meta (default mobile-friendly value).
Parameters
- value: string = 'width=device-width, initial-scale=1'
  The viewport content.
Returns this