Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / rcml/src / createHeadElement

Function: createHeadElement()

createHeadElement(options): RcmlHead

Defined in: rcml/src/email/create-rcml-element.ts:913

Build an <rc-head> — the document's metadata container. Holds any mix of <rc-brand-style>, <rc-attributes> default-override blocks, <rc-preview> preheader text, <rc-class> named-attribute groups, and <rc-plain-text> fallback bodies.

Parameters ​

options ​

HeadElementOptions

options.children is the list of head children. An empty list is valid (the renderer applies all defaults).

Returns ​

RcmlHead

A typed RcmlHead node.

Throws ​

When any child is not a valid head child.

Example ​

ts
createHeadElement({
  children: [
    createBrandStyleElement({ attrs: { id: '99999' } }),
    createPreviewElement({ content: 'See inside for 20% off' }),
  ],
})