Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / rcml/src / createHeadingElement

Function: createHeadingElement()

createHeadingElement(options): RcmlHeading

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

Build an <rc-heading> element. Semantically a heading rather than body text, but structurally identical to createTextElement — both carry a ProseMirror content doc and accept the same CSS-style attrs.

Parameters ​

options ​

HeadingElementOptions

Attribute map + content (RFM markdown string or pre-built content Json from createInlineContent / createTextContent).

Returns ​

RcmlHeading

A typed RcmlHeading node.

Throws ​

When attrs are unknown / have invalid values, or content fails to parse / validate.

Example ​

ts
createHeadingElement({
  attrs: { align: 'center', color: '#1a1a1a', 'font-size': '28px' },
  content: 'Welcome',
})