Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / rcml/src / createGroupElement

Function: createGroupElement()

createGroupElement(options): RcmlGroup

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

Build an <rc-group> — a column-only pass-through container used for advanced layout composition (keeps columns adjacent without introducing section-level backgrounds).

Parameters ​

options ​

GroupElementOptions

options.children is the list of <rc-column> children.

Returns ​

RcmlGroup

A typed RcmlGroup node.

Throws ​

When any child is not an <rc-column>.

Example ​

ts
createGroupElement({
  children: [
    createColumnElement({ children: [...] }),
    createColumnElement({ children: [...] }),
  ],
})