> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fetchski-attract.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List blog posts

> Retrieve a paginated list of blog posts.

```ts TypeScript wrap theme={"dark"}
import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const blogList = await site.blogPosts().listBlogs();
```

```json 200 wrap theme={"dark"}
{
  "results": [
    {
      "title": "Example title",
      "_author": [
        {}
      ],
      "_category": [
        {}
      ],
      "publishedAt": "2026-10-24",
      "slug": "example-slug",
      "visibility": "public",
      "scheduledPublish": "Example scheduled publish",
      "scheduledUnpublish": "Example scheduled unpublish",
      "excerpt": "Example excerpt",
      "featuredImage": {
        "metaType": "area",
        "_id": "clx8m2k4p0000a1b2c3d4e5f6",
        "items": [
          {
            "type": "@apostrophecms/image",
            "_id": "clx8m2k4p0000a1b2c3d4e5f6",
            "metaType": "widget",
            "_image": [],
            "caption": "Example caption",
            "linkTo": "none",
            "_apostrophecms-any-page-type": [],
            "linkHref": "https://acme.example/example",
            "linkHrefTitle": "Example link href title",
            "linkTitle": "Example link title",
            "linkTarget": [],
            "sectionCss": {}
          }
        ]
      },
      "main": {
        "metaType": "area",
        "_id": "clx8m2k4p0000a1b2c3d4e5f6",
        "items": [
          {}
        ]
      },
      "afterContent": {
        "metaType": "area",
        "_id": "clx8m2k4p0000a1b2c3d4e5f6",
        "items": [
          {}
        ]
      },
      "postFontOverrides": [],
      "seoTitle": "Example seo title",
      "seoDescription": "Example seo description",
      "seoImage": {
        "metaType": "area",
        "_id": "clx8m2k4p0000a1b2c3d4e5f6",
        "items": [
          {
            "type": "@apostrophecms/image",
            "_id": "clx8m2k4p0000a1b2c3d4e5f6",
            "metaType": "widget",
            "_image": [],
            "caption": "Example caption",
            "linkTo": "none",
            "_apostrophecms-any-page-type": [],
            "linkHref": "https://acme.example/example",
            "linkHrefTitle": "Example link href title",
            "linkTitle": "Example link title",
            "linkTarget": [],
            "sectionCss": {}
          }
        ]
      },
      "archived": false,
      "_id": "clx8m2k4p0000a1b2c3d4e5f6",
      "type": "Example type",
      "createdAt": "2026-10-24T09:30:00.000Z",
      "updatedAt": "2026-10-24T09:30:00.000Z",
      "_url": "https://acme.example/example",
      "_parentUrl": "https://acme.example/example",
      "_parentSlug": "example-slug",
      "_parent": {},
      "aposShareKey": "k3v9x2m7q1z8w4p6"
    }
  ],
  "pages": 1,
  "currentPage": 1
}
```

## In your app

A function makes the call on the client it is given, so your code passes the real one and a test passes a fake.

**1. Add the function**

```ts src/attract/list-blogs.ts theme={"dark"}
import type { SiteClient } from '@fetchski/attract-cms-sdk';

export async function listBlogs(site: SiteClient) {
  return site.blogPosts().listBlogs();
}
```

**2. Call it**

A script makes the client once and calls the function:

```ts scripts/list-blogs.ts theme={"dark"}
import { createSiteClient } from '@fetchski/attract-cms-sdk';
import { listBlogs } from '../src/attract/list-blogs.ts';

const site = createSiteClient();
console.log(await listBlogs(site));
```

```bash Terminal theme={"dark"}
node --env-file=.env scripts/list-blogs.ts
```

A route handler, a job or a queue worker calls it the same way.

> [accordion] Optional parameters
>
> One object, e.g. `listBlogs({ page })`; leave out the optional fields.
>
> **page** `number | null | undefined`
>
> **Optional.** Leave it out and the site uses `1`. Page number for pagination (1-based)
>
> **perPage** `number | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. Documents per page. Each content type has its own default (core’s is 50; a type may set another). There is no upper limit: a large value answers the whole list at once, which is slow on a big one. At least 1.
>
> **search** `string | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. Matches documents by their text. Ignored for the public and API keys on a type whose public fields leave some out (a search would match the hidden ones).
>
> **aposMode** `AposMode | null | undefined`
>
> **Optional.** Leave it out and the site uses `"published"`. `published` (the default) or `draft`. Drafts need a credential that may see them: an API key with the type’s write scope (`content:<type>:write`), or a signed-in editor. The public and a key with only the read scope get 403. One of `draft`, `published`.
>
> **aposLocale** `string | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. The locale to read or write, e.g. `en` (default: the site’s default locale).
>
> **renderAreas** `boolean | null | undefined`
>
> **Optional.** Leave it out and the site uses `false`. true: each area’s widgets come back rendered as HTML (`_rendered`), beside their data.
>
> **slug** `string | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. Only the document with exactly this slug: a list of one, or an empty list when none has it. Use it to find a document by the name in its URL.

A `BlogList`. A page of Blog documents. Read its properties (`blogList.results`): each says whether the site always sends it. The example answer is the site’s wire JSON: some keys differ from the property names (`_id` → `id`, `_author` → `author`, `_category` → `category` …).

**Always sent.** A list of `Blog`. This page’s documents; empty past the last page.

**Blog**

Blog content type

**title** `string`

**Always sent.** Its title: the name it goes by in every list, and the heading of its page where it has one.

**publishedAt** `Date`

**Always sent.** The post’s publication date (`YYYY-MM-DD`, e.g. `2026-10-21`): the date it shows, and its place in the blog list, newest first. Format: an ISO 8601 date (`YYYY-MM-DD`).

**id** `string`

**Always sent.** The document’s id. On a type with drafts it ends in its locale and mode (`…:en:published`, `…:en:draft`): the part before the first colon is its `aposDocId`, shared by both copies. The `{_id}` the type’s routes take.

**type** `string`

**Always sent.** The document type’s name: always this type’s.

**author** `readonly Readonly\<Record\<string, unknown\>\>[] | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Credited author. Pick from the Authors collection — their profile photo shows alongside the post. The related `author` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.

**category** `readonly Readonly\<Record\<string, unknown\>\>[] | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The post’s category. Manage the list (and each badge color) under Blog Categories. The related `blog-category` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.

**slug** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).

**visibility** `Visibility | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Select whether this content is public or private. One of `public`, `loginRequired`; a newer site may send others, so keep a fallback.

**scheduledPublish** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`.

**scheduledUnpublish** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`.

**excerpt** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Short teaser shown on the blog index and homepage. 1–2 sentences.

**featuredImage** `ImageArea`

**Sometimes sent:** `undefined` when the site leaves it out. An `ImageArea`. Widgets, top to bottom: send `{ "items": [ … ] }`, one object per widget with its `type`. Writing it replaces the whole area.

**ImageArea**

**metaType** `AfterContentAreaMetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `area`. One of `area`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The area’s id, set by the site: leave it out when you write one.

**items** `readonly ImageWidget[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `ImageWidget`. The widgets, top to bottom. Each is an object with its `type` and that widget’s own fields; `_id` and `metaType` may be left out (the site sets them). At most 1 items.

**ImageWidget**

A `@apostrophecms/image` widget: its `type` and its own fields. A field left out takes its default.

**type** `ImageWidgetType`

**Always sent.** The widget’s type: always `@apostrophecms/image`. One of `@apostrophecms/image`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**image** `readonly Readonly\<Record\<string, unknown\>\>[]`

**Sometimes sent:** `undefined` when the site leaves it out. The related `@apostrophecms/image` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.

**caption** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Caption.

**linkTo** `LinkTo | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Link To... One of `none`, `@apostrophecms/any-page-type`, `_url`; a newer site may send others, so keep a fallback.

**apostrophecmsAnyPageType** `readonly Readonly\<Record\<string, unknown\>\>[]`

**Sometimes sent:** `undefined` when the site leaves it out. The related `@apostrophecms/any-page-type` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.

**linkHref** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. apostrophe:linkHrefHelp When set, a URL; empty or null when not.

**linkHrefTitle** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Link Title.

**linkTitle** `string`

**Sometimes sent:** `undefined` when the site leaves it out. If empty, the title of the related document will be used.

**linkTarget** `readonly LinkTarget[] | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Link Target. Each one of `_blank`.

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot.

**CustomCSS**

**slots** `Readonly\<Record\<string, string\>\>`

**Sometimes sent:** `undefined` when the site leaves it out. The CSS typed into each part slot, by slot name.

**css** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The compiled CSS (read only: rebuilt from `slots`).

**mark** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The site’s check mark for `css` (read only).

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**main** `BlogMainArea`

**Sometimes sent:** `undefined` when the site leaves it out. A `BlogMainArea`. Widgets, top to bottom: send `{ "items": [ … ] }`, one object per widget with its `type`. Writing it replaces the whole area. A new document starts with `@apostrophecms/rich-text`.

**BlogMainArea**

**metaType** `AfterContentAreaMetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `area`. One of `area`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The area’s id, set by the site: leave it out when you write one.

**items** `readonly BlogMainAreaItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `BlogMainAreaItem`. The widgets, top to bottom. Each is an object with its `type` and that widget’s own fields; `_id` and `metaType` may be left out (the site sets them).

**BlogMainAreaItem**

A widget in an area that takes `@apostrophecms/rich-text`, `@apostrophecms/image`, `@apostrophecms/video`, `@apostrophecms/layout`, `intro`, `feature`, `stats`, `steps`, `pricing`, `media-text`, `device-mock`, `faq`: the one its `type` names.

**RichTextWidget**

A `@apostrophecms/rich-text` widget: its `type` and its own fields. A field left out takes its default.

**type** `RichTextWidgetType`

**Always sent.** The widget’s type: always `@apostrophecms/rich-text`. One of `@apostrophecms/rich-text`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**content** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The text as HTML, e.g. `<h2>Our story</h2><p>It began with <strong>one</strong> idea.</p>`. The site keeps the tags and styles this area’s editor offers (paragraphs, headings, bold, italic, links, lists…) and removes the rest.

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**ImageWidget**

A `@apostrophecms/image` widget: its `type` and its own fields. A field left out takes its default.

**type** `ImageWidgetType`

**Always sent.** The widget’s type: always `@apostrophecms/image`. One of `@apostrophecms/image`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**image** `readonly Readonly\<Record\<string, unknown\>\>[]`

**Sometimes sent:** `undefined` when the site leaves it out. The related `@apostrophecms/image` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.

**caption** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Caption.

**linkTo** `LinkTo | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Link To... One of `none`, `@apostrophecms/any-page-type`, `_url`; a newer site may send others, so keep a fallback.

**apostrophecmsAnyPageType** `readonly Readonly\<Record\<string, unknown\>\>[]`

**Sometimes sent:** `undefined` when the site leaves it out. The related `@apostrophecms/any-page-type` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.

**linkHref** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. apostrophe:linkHrefHelp When set, a URL; empty or null when not.

**linkHrefTitle** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Link Title.

**linkTitle** `string`

**Sometimes sent:** `undefined` when the site leaves it out. If empty, the title of the related document will be used.

**linkTarget** `readonly LinkTarget[] | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Link Target. Each one of `_blank`.

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**VideoWidget**

A `@apostrophecms/video` widget: its `type` and its own fields. A field left out takes its default.

**type** `VideoWidgetType`

**Always sent.** The widget’s type: always `@apostrophecms/video`. One of `@apostrophecms/video`; a newer site may send others, so keep a fallback.

**video** `Readonly\<Record\<string, unknown\>\>`

**Always sent.** Enter the URL for a media source you wish to embed (e.g., YouTube, Vimeo, or other hosted video URL).

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**LayoutWidget**

A `@apostrophecms/layout` widget: its `type` and its own fields. A field left out takes its default.

**type** `LayoutWidgetType`

**Always sent.** The widget’s type: always `@apostrophecms/layout`. One of `@apostrophecms/layout`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**columns** `LayoutColumnArea`

**Sometimes sent:** `undefined` when the site leaves it out. A `LayoutColumnArea`. Widgets, top to bottom: send `{ "items": [ … ] }`, one object per widget with its `type`. Writing it replaces the whole area.

**LayoutColumnArea**

**metaType** `AfterContentAreaMetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `area`. One of `area`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The area’s id, set by the site: leave it out when you write one.

**items** `readonly LayoutColumnWidget[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `LayoutColumnWidget`. The widgets, top to bottom. Each is an object with its `type` and that widget’s own fields; `_id` and `metaType` may be left out (the site sets them).

**LayoutColumnWidget**

A `@apostrophecms/layout-column` widget: its `type` and its own fields. A field left out takes its default.

**type** `LayoutColumnWidgetType`

**Always sent.** The widget’s type: always `@apostrophecms/layout-column`. One of `@apostrophecms/layout-column`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**colstart** `number | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Colstart.

**colspan** `number | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Colspan.

**rowstart** `number | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Rowstart.

**rowspan** `number | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Rowspan.

**order** `number | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Order.

**content** `LayoutColumnContentArea`

**Sometimes sent:** `undefined` when the site leaves it out. A `LayoutColumnContentArea`. Widgets, top to bottom: send `{ "items": [ … ] }`, one object per widget with its `type`. Writing it replaces the whole area. Its fields are listed under the first `LayoutColumnContentArea` above.

**showTablet** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Visible on tablet.

**showMobile** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Visible on mobile.

**justify** `Justify | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Horizontal alignment. One of `stretch`, `start`, `end`, `center`; a newer site may send others, so keep a fallback.

**align** `Align | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Vertical alignment. One of `stretch`, `start`, `end`, `center`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**IntroWidget**

A `intro` widget: its `type` and its own fields. A field left out takes its default.

**type** `IntroWidgetType`

**Always sent.** The widget’s type: always `intro`. One of `intro`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**introEyebrow** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Small label shown above the title.

**introEyebrowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Overrides the eyebrow + its dash. Leave empty to use the secondary (mint) color.

**introEyebrowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the mint default.

**introEyebrowWeight** `IntroEyebrowWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**introEyebrowSize** `IntroEyebrowSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**introHeadline** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Headline.

**introHeadlineColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Overrides the headline color. Leave empty to track the theme’s text color.

**introHeadlineColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the theme default.

**introHeadlineWeight** `IntroHeadlineWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Headline weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**introBody** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Body copy.

**introBodyColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Overrides the body text color. Leave empty for the muted default.

**introBodyColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the muted default.

**introBodyWeight** `IntroBodyWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Body weight. One of `normal`, `medium`, `semibold`, `bold`; a newer site may send others, so keep a fallback.

**introPhotoPlacement** `IntroPhotoPlacement | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the optional photo sits. Left/right place it beside the text; Full background fills the whole section behind the text (with a readability overlay). One of `none`, `left`, `right`, `background`; a newer site may send others, so keep a fallback.

**introImage** `ImageArea`

**Sometimes sent:** `undefined` when the site leaves it out. An `ImageArea`. Widgets, top to bottom: send `{ "items": [ … ] }`, one object per widget with its `type`. Writing it replaces the whole area. Its fields are listed under the first `ImageArea` above.

**introPhotoCorners** `IntroPhotoCorners | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Photo corners. One of `rounded`, `squared`; a newer site may send others, so keep a fallback.

**introPhotoFrame** `IntroPhotoFrame | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Border draws a frame around the photo; Offset adds a refined offset accent frame behind it. One of `none`, `border`, `offset`; a newer site may send others, so keep a fallback.

**introPhotoFrameColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Border / offset-frame color. Leave empty to use the site accent color.

**introPhotoTilt** `IntroPhotoTilt | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A slight rotation for a more playful look. One of `none`, `left`, `right`; a newer site may send others, so keep a fallback.

**introPhotoHover** `IntroPhotoHover | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Photo hover effect. One of `none`, `lift`, `zoom`, `tilt`, `glow`, `lift-glow`, `zoom-glow`; a newer site may send others, so keep a fallback.

**introOverlayColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Scrim behind the text over a full-background photo. Leave empty to use the dark surface color.

**introOverlayColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme overlay, then the light surface color.

**introOverlayOpacity** `number | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Overlay opacity (%). 0 to 100.

**introBg** `IntroBg | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The section’s full-width background band in dark mode. Transparent lets the page background show through. The palette options track the site colors; choose “Custom color…” for a specific color. One of `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**introBgCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (dark theme)” is set to Custom color.

**introBgLight** `IntroBgLight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. “Match dark theme” reuses the dark-theme choice; otherwise set the light-mode band independently. One of `inherit`, `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**introBgLightCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (light theme)” is set to Custom color.

**introFontOverrides** `readonly IntroWidgetIntroFontOverridesItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `IntroWidgetIntroFontOverridesItem`. Optional. Set part of this section in a different typeface. Leave empty to follow the site’s fonts (Site design → Typography). At most 4 items.

**IntroWidgetIntroFontOverridesItem**

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**target** `Target | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which text this typeface replaces. Rows apply in order, so a broad row (Everything) followed by a narrow one (Headings) gives the section a base face plus an exception. One of `all`, `heading`, `body`, `eyebrow`, `button`, `code`; a newer site may send others, so keep a fallback.

**source** `Source | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the typeface comes from. The first option costs nothing extra — those faces are already loaded. The others load an additional font on pages that use this section. One of `slot`, `curated`, `cdn`, `upload`; a newer site may send others, so keep a fallback.

**slot** `Slot | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Set in Site design → Typography. Following the site’s own faces keeps a section on-brand and adds no download. One of `display`, `body`, `accent`; a newer site may send others, so keep a fallback.

**curated** `Curated | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Vetted families from Bunny Fonts and Fontshare, with their available weights already verified. One of `archivo`, `bricolage-grotesque`, `clash-display`, `courier-prime`, `dm-mono`, `dm-sans`, `fira-code`, `fraunces`, `general-sans`, `ibm-plex-mono`, `ibm-plex-sans`, `inconsolata`, `inter`, `jetbrains-mono`, `karla`, `lora`, `manrope`, `nunito-sans`, `outfit`, `playfair-display`, `public-sans`, `red-hat-mono`, `satoshi`, `sentient`, `sora`, `source-code-pro`, `source-sans-3`, `source-serif-4`, `space-grotesk`, `space-mono`, `spline-sans-mono`, `supreme`, `switzer`, `syne`, `ubuntu-mono`, `unbounded`, `victor-mono`, `work-sans`, `zodiak`; a newer site may send others, so keep a fallback.

**cdnProvider** `CdnProvider | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where to browse for the family. Pick one, then follow the link below to find the exact name. One of `bunny`, `fontshare`; a newer site may send others, so keep a fallback.

**cdnFamily** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Exactly as the provider’s catalog spells it, e.g. "Space Grotesk" or "Clash Display". A name the provider doesn’t have loads nothing and this row is ignored.

**cdnWeights** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 500, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold) — but a family that ships only ONE weight (Acme, for instance) loads nothing at all unless that weight is among these, so set it explicitly if the typeface doesn’t appear.

**uploads** `readonly IntroWidgetIntroFontOverridesItemUploadsItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `IntroWidgetIntroFontOverridesItemUploadsItem`. One file per weight/style of the SAME typeface. woff2 strongly recommended (smallest, universally supported); woff/ttf/otf also accepted. At most 4 items.

**IntroWidgetIntroFontOverridesItemUploadsItem**

**file** `Readonly\<Record\<string, unknown\>\>`

**Always sent.** File attachment reference.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**weight** `Weight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Weight. One of `100`, `200`, `300`, `400`, `500`, `600`, `700`, `800`, `900`; a newer site may send others, so keep a fallback.

**style** `Style | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Style. One of `normal`, `italic`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**fallback** `Fallback | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Generic system font shown while this typeface loads (and if it fails). Curated picks set this automatically. One of `sans`, `serif`, `mono`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**FeatureWidget**

A `feature` widget: its `type` and its own fields. A field left out takes its default.

**type** `FeatureWidgetType`

**Always sent.** The widget’s type: always `feature`. One of `feature`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**featureColumns** `FeatureColumns | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Auto fits as many as comfortably fit and works for any number of cards. Or lock a maximum per row. One of `auto`, `2`, `3`, `4`; a newer site may send others, so keep a fallback.

**featureGap** `FeatureGap | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Gap between cards. One of `tight`, `normal`, `roomy`; a newer site may send others, so keep a fallback.

**featureCardSize** `FeatureCardSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Scales padding, icon, title, and the index numeral together. One of `small`, `medium`, `large`; a newer site may send others, so keep a fallback.

**featureCardStyle** `FeatureCardStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The card treatment. Poster (the default) frames the card with an accent keyline; Raised is a quiet lit card; Luxe a frosted glass panel; Spine adds a color rail; Tint an accent wash; Ticket/Bracket/Forge/Press/Inlay are the graphic showstoppers. One of `raised`, `luxe`, `outline`, `plain`, `poster`, `edge`, `tint`, `ticket`, `bracket`, `forge`, `press`, `inlay`; a newer site may send others, so keep a fallback.

**featureCardStyleRadius** `FeatureCardStyleRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner rounding for each card. Default keeps the widget’s own tuned corners — except Forge, which defaults to tight machined corners matching its engraved frame. One of `default`, `square`, `slight`, `rounded`, `large`; a newer site may send others, so keep a fallback.

**featureCardStyleAccentColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Colors the Spine rail, Bracket marks, Forge corner/frame and Press margin rule. Leave empty to use the brand accent.

**featureCardStyleAccentColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**featureCardStyleForgeScope** `FeatureCardStyleForgeScope | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the Forge plate wears its color: a single corner mark (the machinist’s datum, default) or the whole engraved frame. One of `corner`, `frame`; a newer site may send others, so keep a fallback.

**featureCardStyleForgeWeight** `FeatureCardStyleForgeWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Thickness of the Forge corner mark / colored frame. One of `fine`, `medium`, `bold`; a newer site may send others, so keep a fallback.

**featureCardHover** `FeatureCardHover | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. How a card reacts on hover. Pop is the lift + hard offset shadow; Glow is a soft accent halo. One of `none`, `lift`, `pop`, `glow`, `border`; a newer site may send others, so keep a fallback.

**featureCardHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Border / shadow / glow color on hover. Leave empty to use the site accent color.

**featureCardHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the accent.

**featureNumbering** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. A big outlined numeral on each card (01, 02, …). Great for step-by-step sequences; turn off when the cards aren’t ordered.

**featureNumberFill** `FeatureNumberFill | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Same treatment as the hero ghost text: all numbers solid, outlined and filling on hover, or always outlined. One of `solid`, `hover`, `outline`; a newer site may send others, so keep a fallback.

**featureNumberColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Tints the numeral fill + outline. Leave empty to track the theme’s text color.

**featureNumberColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the theme default.

**featureTitleColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Overrides the card title color. Leave empty to track the theme’s text color.

**featureTitleColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the theme default.

**featureTitleWeight** `FeatureTitleWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Title weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**featureTextColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Overrides the card text color. Leave empty for the muted default.

**featureTextColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the muted default.

**featureTextWeight** `FeatureTextWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Text weight. One of `normal`, `medium`, `semibold`, `bold`; a newer site may send others, so keep a fallback.

**featureCards** `readonly FeatureWidgetFeatureCardsItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `FeatureWidgetFeatureCardsItem`. Feature cards.

**FeatureWidgetFeatureCardsItem**

**cardTitle** `string`

**Always sent.** Title.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**icon** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.

**iconFamily** `IconFamily | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon family. One of `classic-regular`, `duotone-regular`, `brands`, `jelly`, `jelly-duo`, `whiteboard`; a newer site may send others, so keep a fallback.

**iconColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the design’s own color rhythm.

**iconAnimation** `IconAnimation | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon animation. One of `none`, `fa-beat`, `fa-bounce`, `fa-fade`, `fa-beat-fade`, `fa-flip`, `fa-shake`, `fa-spin`; a newer site may send others, so keep a fallback.

**iconSize** `IconSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Relative to the component’s base icon size. One of `default`, `sm`, `lg`, `xl`, `2xl`, `2x`, `3x`, `4x`, `5x`; a newer site may send others, so keep a fallback.

**cardText** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Text.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**featureBg** `FeatureBg | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The section’s full-width background band in dark mode. Transparent lets the page background show through. The palette options track the site colors; choose “Custom color…” for a specific color. One of `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**featureBgCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (dark theme)” is set to Custom color.

**featureBgLight** `FeatureBgLight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. “Match dark theme” reuses the dark-theme choice; otherwise set the light-mode band independently. One of `inherit`, `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**featureBgLightCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (light theme)” is set to Custom color.

**featureFontOverrides** `readonly FeatureWidgetFeatureFontOverridesItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `FeatureWidgetFeatureFontOverridesItem`. Optional. Set part of this section in a different typeface. Leave empty to follow the site’s fonts (Site design → Typography). At most 4 items.

**FeatureWidgetFeatureFontOverridesItem**

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**target** `Target | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which text this typeface replaces. Rows apply in order, so a broad row (Everything) followed by a narrow one (Headings) gives the section a base face plus an exception. One of `all`, `heading`, `body`, `eyebrow`, `button`, `code`; a newer site may send others, so keep a fallback.

**source** `Source | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the typeface comes from. The first option costs nothing extra — those faces are already loaded. The others load an additional font on pages that use this section. One of `slot`, `curated`, `cdn`, `upload`; a newer site may send others, so keep a fallback.

**slot** `Slot | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Set in Site design → Typography. Following the site’s own faces keeps a section on-brand and adds no download. One of `display`, `body`, `accent`; a newer site may send others, so keep a fallback.

**curated** `Curated | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Vetted families from Bunny Fonts and Fontshare, with their available weights already verified. One of `archivo`, `bricolage-grotesque`, `clash-display`, `courier-prime`, `dm-mono`, `dm-sans`, `fira-code`, `fraunces`, `general-sans`, `ibm-plex-mono`, `ibm-plex-sans`, `inconsolata`, `inter`, `jetbrains-mono`, `karla`, `lora`, `manrope`, `nunito-sans`, `outfit`, `playfair-display`, `public-sans`, `red-hat-mono`, `satoshi`, `sentient`, `sora`, `source-code-pro`, `source-sans-3`, `source-serif-4`, `space-grotesk`, `space-mono`, `spline-sans-mono`, `supreme`, `switzer`, `syne`, `ubuntu-mono`, `unbounded`, `victor-mono`, `work-sans`, `zodiak`; a newer site may send others, so keep a fallback.

**cdnProvider** `CdnProvider | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where to browse for the family. Pick one, then follow the link below to find the exact name. One of `bunny`, `fontshare`; a newer site may send others, so keep a fallback.

**cdnFamily** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Exactly as the provider’s catalog spells it, e.g. "Space Grotesk" or "Clash Display". A name the provider doesn’t have loads nothing and this row is ignored.

**cdnWeights** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 500, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold) — but a family that ships only ONE weight (Acme, for instance) loads nothing at all unless that weight is among these, so set it explicitly if the typeface doesn’t appear.

**uploads** `readonly FeatureWidgetFeatureFontOverridesItemUploadsItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `FeatureWidgetFeatureFontOverridesItemUploadsItem`. One file per weight/style of the SAME typeface. woff2 strongly recommended (smallest, universally supported); woff/ttf/otf also accepted. At most 4 items.

**FeatureWidgetFeatureFontOverridesItemUploadsItem**

**file** `Readonly\<Record\<string, unknown\>\>`

**Always sent.** File attachment reference.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**weight** `Weight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Weight. One of `100`, `200`, `300`, `400`, `500`, `600`, `700`, `800`, `900`; a newer site may send others, so keep a fallback.

**style** `Style | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Style. One of `normal`, `italic`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**fallback** `Fallback | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Generic system font shown while this typeface loads (and if it fails). Curated picks set this automatically. One of `sans`, `serif`, `mono`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**StatsWidget**

A `stats` widget: its `type` and its own fields. A field left out takes its default.

**type** `StatsWidgetType`

**Always sent.** The widget’s type: always `stats`. One of `stats`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**statsEyebrowEnabled** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. A small label above the heading (e.g. "By the numbers").

**statsEyebrow** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Eyebrow.

**statsEyebrowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the secondary (mint) color.

**statsEyebrowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**statsEyebrowWeight** `StatsEyebrowWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**statsEyebrowSize** `StatsEyebrowSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**statsHeading** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional. Leave empty to show just the numbers.

**statsHeadingColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to track the theme text color.

**statsHeadingColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**statsHeadingWeight** `StatsHeadingWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Heading weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**statsColumns** `StatsColumns | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Auto fits as many as comfortably fit and works for any number of stats. Or lock a maximum per row. One of `auto`, `2`, `3`, `4`; a newer site may send others, so keep a fallback.

**statsGap** `StatsGap | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Gap between stats. One of `tight`, `normal`, `roomy`; a newer site may send others, so keep a fallback.

**statsSize** `StatsSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The baseline scale for the whole stat (value / icon / label / description stay proportional). Fine-tune any single element with its own size control below. One of `small`, `medium`, `large`; a newer site may send others, so keep a fallback.

**statsAlign** `StatsAlign | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Alignment. One of `center`, `left`; a newer site may send others, so keep a fallback.

**statsDividers** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. A hairline rule between each stat — the classic "by the numbers" rail.

**statsCountUp** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Numbers tick up from zero when the band scrolls into view. Non-numeric values and reduced-motion visitors simply show the final value.

**statsIconSize** `StatsIconSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Size of the icon above each number, independent of the overall stat size. One of `auto`, `sm`, `md`, `lg`, `xl`, `xxl`; a newer site may send others, so keep a fallback.

**statsIconGap** `StatsIconGap | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Space between the icon and the number below it. One of `tight`, `normal`, `roomy`; a newer site may send others, so keep a fallback.

**statsValueSize** `StatsValueSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Value size. One of `auto`, `xs`, `sm`, `md`, `lg`, `xl`; a newer site may send others, so keep a fallback.

**statsValueWeight** `StatsValueWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Value weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**statsValueColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The big numeral. Optional — leave empty to use the site accent color.

**statsValueColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the accent.

**statsLabelSize** `StatsLabelSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Label size. One of `auto`, `xs`, `sm`, `md`, `lg`, `xl`; a newer site may send others, so keep a fallback.

**statsLabelWeight** `StatsLabelWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Label weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**statsLabelColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to track the theme text color.

**statsLabelColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**statsDescriptionSize** `StatsDescriptionSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Description size. One of `auto`, `xs`, `sm`, `md`, `lg`, `xl`; a newer site may send others, so keep a fallback.

**statsDescriptionWeight** `StatsDescriptionWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Description weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**statsDescriptionColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the muted text color.

**statsDescriptionColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**stats** `readonly StatsWidgetStatsItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `StatsWidgetStatsItem`. Stats.

**StatsWidgetStatsItem**

**value** `string`

**Always sent.** The number, e.g. 500, 4.9, 12 — symbols go in the prefix/suffix so the count-up animates the number alone.

**label** `string`

**Always sent.** Label.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**icon** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional Font Awesome icon shown above the number (e.g. star, bolt, chart-line). Leave empty for no icon.

**iconFamily** `IconFamily | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon family. One of `classic-regular`, `duotone-regular`, `brands`, `jelly`, `jelly-duo`, `whiteboard`; a newer site may send others, so keep a fallback.

**iconColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the design’s own color rhythm.

**valuePrefix** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional, shown before the number (e.g. \$, \~, >). Kept out of the count-up.

**valueSuffix** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional, shown after the number (e.g. +, %, k, yrs, ★).

**description** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional small text under the label.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**statsBg** `StatsBg | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The section’s full-width background band in dark mode. Transparent lets the page background show through. The palette options track the site colors; choose “Custom color…” for a specific color. One of `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**statsBgCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (dark theme)” is set to Custom color.

**statsBgLight** `StatsBgLight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. “Match dark theme” reuses the dark-theme choice; otherwise set the light-mode band independently. One of `inherit`, `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**statsBgLightCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (light theme)” is set to Custom color.

**statsFontOverrides** `readonly StatsWidgetStatsFontOverridesItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `StatsWidgetStatsFontOverridesItem`. Optional. Set part of this section in a different typeface. Leave empty to follow the site’s fonts (Site design → Typography). At most 4 items.

**StatsWidgetStatsFontOverridesItem**

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**target** `Target | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which text this typeface replaces. Rows apply in order, so a broad row (Everything) followed by a narrow one (Headings) gives the section a base face plus an exception. One of `all`, `heading`, `body`, `eyebrow`, `button`, `code`; a newer site may send others, so keep a fallback.

**source** `Source | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the typeface comes from. The first option costs nothing extra — those faces are already loaded. The others load an additional font on pages that use this section. One of `slot`, `curated`, `cdn`, `upload`; a newer site may send others, so keep a fallback.

**slot** `Slot | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Set in Site design → Typography. Following the site’s own faces keeps a section on-brand and adds no download. One of `display`, `body`, `accent`; a newer site may send others, so keep a fallback.

**curated** `Curated | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Vetted families from Bunny Fonts and Fontshare, with their available weights already verified. One of `archivo`, `bricolage-grotesque`, `clash-display`, `courier-prime`, `dm-mono`, `dm-sans`, `fira-code`, `fraunces`, `general-sans`, `ibm-plex-mono`, `ibm-plex-sans`, `inconsolata`, `inter`, `jetbrains-mono`, `karla`, `lora`, `manrope`, `nunito-sans`, `outfit`, `playfair-display`, `public-sans`, `red-hat-mono`, `satoshi`, `sentient`, `sora`, `source-code-pro`, `source-sans-3`, `source-serif-4`, `space-grotesk`, `space-mono`, `spline-sans-mono`, `supreme`, `switzer`, `syne`, `ubuntu-mono`, `unbounded`, `victor-mono`, `work-sans`, `zodiak`; a newer site may send others, so keep a fallback.

**cdnProvider** `CdnProvider | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where to browse for the family. Pick one, then follow the link below to find the exact name. One of `bunny`, `fontshare`; a newer site may send others, so keep a fallback.

**cdnFamily** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Exactly as the provider’s catalog spells it, e.g. "Space Grotesk" or "Clash Display". A name the provider doesn’t have loads nothing and this row is ignored.

**cdnWeights** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 500, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold) — but a family that ships only ONE weight (Acme, for instance) loads nothing at all unless that weight is among these, so set it explicitly if the typeface doesn’t appear.

**uploads** `readonly StatsWidgetStatsFontOverridesItemUploadsItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `StatsWidgetStatsFontOverridesItemUploadsItem`. One file per weight/style of the SAME typeface. woff2 strongly recommended (smallest, universally supported); woff/ttf/otf also accepted. At most 4 items.

**StatsWidgetStatsFontOverridesItemUploadsItem**

**file** `Readonly\<Record\<string, unknown\>\>`

**Always sent.** File attachment reference.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**weight** `Weight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Weight. One of `100`, `200`, `300`, `400`, `500`, `600`, `700`, `800`, `900`; a newer site may send others, so keep a fallback.

**style** `Style | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Style. One of `normal`, `italic`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**fallback** `Fallback | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Generic system font shown while this typeface loads (and if it fails). Curated picks set this automatically. One of `sans`, `serif`, `mono`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**statsCtaLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The visible button text. Leave empty to hide the button.

**statsCtaUrl** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Where the button goes — a path (/blog) or full URL.

**statsCtaNewTab** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Opens the link in a new browser tab (adds rel="noopener noreferrer").

**statsCtaVariant** `StatsCtaVariant | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fills with the color; Outline / Soft / Text link use it for the border + text. One of `solid`, `outline`, `soft`, `link`; a newer site may send others, so keep a fallback.

**statsCtaSize** `StatsCtaSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Button size. One of `small`, `normal`, `large`; a newer site may send others, so keep a fallback.

**statsCtaRadius** `StatsCtaRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner radius. One of `pill`, `rounded`, `slight`, `square`; a newer site may send others, so keep a fallback.

**statsCtaColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fill, or the border + text for the other styles. Defaults to the brand accent; CLEAR it for a transparent, outline-only button.

**statsCtaColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color. (Brand tokens already flip per theme.)

**statsCtaTextColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The text/icon color. Clear it to derive from the button color (readable on solid fills).

**statsCtaTextColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme label color.

**statsCtaHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Drives the hover treatment. Leave empty to derive it from the button color.

**statsCtaHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme hover color.

**statsCtaStyle** `StatsCtaStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The hover treatment: a soft shadow, a colored offset shadow, a glow, a fill sweep, or a thicker border. One of `none`, `single`, `dual`, `glow`, `sweep`, `thicken`; a newer site may send others, so keep a fallback.

**statsCtaShadowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. The offset-shadow or glow color on hover. Leave empty to use the site secondary color.

**statsCtaShadowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme shadow color.

**statsCtaAnimation** `StatsCtaAnimation | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Hover motion. One of `lift`, `scale`, `lift-scale`, `none`; a newer site may send others, so keep a fallback.

**statsCtaIcon** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.

**statsCtaIconFamily** `StatsCtaIconFamily | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon family. One of `classic-regular`, `duotone-regular`, `brands`, `jelly`, `jelly-duo`, `whiteboard`; a newer site may send others, so keep a fallback.

**statsCtaIconPosition** `StatsCtaIconPosition | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which side of the label the icon sits on (when an icon name is set). One of `before`, `after`; a newer site may send others, so keep a fallback.

**statsCtaIconNudge** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. The icon slides toward its side on hover (e.g. an arrow edges outward).

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**StepsWidget**

A `steps` widget: its `type` and its own fields. A field left out takes its default.

**type** `StepsWidgetType`

**Always sent.** The widget’s type: always `steps`. One of `steps`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**stepsEyebrowEnabled** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. A small label above the heading (e.g. "How it works").

**stepsEyebrow** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Eyebrow.

**stepsEyebrowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the secondary (mint) color.

**stepsEyebrowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**stepsEyebrowWeight** `StepsEyebrowWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**stepsEyebrowSize** `StepsEyebrowSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**stepsHeading** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional. Leave empty to show just the steps.

**stepsHeadingColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to track the theme text color.

**stepsHeadingColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**stepsHeadingWeight** `StepsHeadingWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Heading weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**stepsHeadingSize** `StepsHeadingSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Heading size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**stepsIntro** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional short sentence under the heading.

**stepsIntroColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the muted text color.

**stepsIntroColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**stepsIntroWeight** `StepsIntroWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Intro weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**stepsIntroSize** `StepsIntroSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Intro size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**stepsLayout** `StepsLayout | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Horizontal lays the steps across a row (marker on top); Vertical stacks them as a classic timeline (marker on the left). One of `horizontal`, `vertical`; a newer site may send others, so keep a fallback.

**stepsColumns** `StepsColumns | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Horizontal only. Auto fits as many as comfortably fit and works for any number of steps. Or lock a maximum per row. One of `auto`, `2`, `3`, `4`; a newer site may send others, so keep a fallback.

**stepsGap** `StepsGap | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Gap between steps. One of `tight`, `normal`, `roomy`; a newer site may send others, so keep a fallback.

**stepsAlign** `StepsAlign | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Horizontal only — aligns the section header and each step’s text. (Vertical is always left-aligned beside its marker.) One of `center`, `left`; a newer site may send others, so keep a fallback.

**stepsConnector** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. A line linking the step markers into a timeline (down the markers when vertical, across them when horizontal).

**stepsCardStyle** `StepsCardStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Plain keeps the connector-linked timeline (just marker + text, no card). Every other style boxes each step — Raised is a quiet lit card, Luxe a frosted glass panel, Outline a plaque frame, Spine adds a color rail, Tint an accent wash; Ticket/Bracket/Forge/Press/Inlay are the graphic showstoppers. One of `raised`, `luxe`, `outline`, `plain`, `poster`, `edge`, `tint`, `ticket`, `bracket`, `forge`, `press`, `inlay`; a newer site may send others, so keep a fallback.

**stepsCardStyleRadius** `StepsCardStyleRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner rounding for each card. Default keeps the widget’s own tuned corners — except Forge, which defaults to tight machined corners matching its engraved frame. One of `default`, `square`, `slight`, `rounded`, `large`; a newer site may send others, so keep a fallback.

**stepsCardStyleAccentColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Colors the Spine rail, Bracket marks, Forge corner/frame and Press margin rule. Leave empty to use the brand accent.

**stepsCardStyleAccentColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**stepsCardStyleForgeScope** `StepsCardStyleForgeScope | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the Forge plate wears its color: a single corner mark (the machinist’s datum, default) or the whole engraved frame. One of `corner`, `frame`; a newer site may send others, so keep a fallback.

**stepsCardStyleForgeWeight** `StepsCardStyleForgeWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Thickness of the Forge corner mark / colored frame. One of `fine`, `medium`, `bold`; a newer site may send others, so keep a fallback.

**stepsCardHover** `StepsCardHover | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. What a boxed step does on hover (applies when Step style is not Plain). Lift/Pop/Press/Glow/Outline are instant; Sheen sweeps a light across; Tilt, Magnetic and Spotlight follow the cursor (need site animations on). One of `none`, `lift`, `pop`, `press`, `glow`, `border`, `sheen`, `tilt`, `magnetic`, `spotlight`; a newer site may send others, so keep a fallback.

**stepsMarker** `StepsMarker | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Number auto-counts 1, 2, 3…; Icon shows each step’s icon (falling back to the number when a step has none); None hides the marker badge. One of `number`, `icon`, `none`; a newer site may send others, so keep a fallback.

**stepsMarkerStyle** `StepsMarkerStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Soft is a tinted accent badge; Filled is a solid accent badge; Outline is a bordered badge. One of `soft`, `filled`, `outline`; a newer site may send others, so keep a fallback.

**stepsMarkerShape** `StepsMarkerShape | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Marker shape. One of `circle`, `rounded`, `square`; a newer site may send others, so keep a fallback.

**stepsMarkerSize** `StepsMarkerSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Marker size. One of `small`, `medium`, `large`; a newer site may send others, so keep a fallback.

**stepsAccentColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Color for the marker badge and the connector line. Leave empty to use the site accent color.

**stepsAccentColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme accent.

**stepsTitleSize** `StepsTitleSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Title size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**stepsTitleWeight** `StepsTitleWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Title weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**stepsTitleColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to track the theme text color.

**stepsTitleColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**stepsBodySize** `StepsBodySize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Body size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**stepsBodyWeight** `StepsBodyWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Body weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**stepsBodyColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the muted text color.

**stepsBodyColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**stepsItems** `readonly StepsWidgetStepsItemsItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `StepsWidgetStepsItemsItem`. Each item is one step in the process. They render in this order; the number marker counts automatically.

**StepsWidgetStepsItemsItem**

**title** `string`

**Always sent.** Title.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**icon** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional Font Awesome icon for this step (e.g. calendar-check, circle-check, gear). Shown in the marker when the section marker is set to "Icon"; otherwise the step is numbered.

**iconFamily** `IconFamily | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon family. One of `classic-regular`, `duotone-regular`, `brands`, `jelly`, `jelly-duo`, `whiteboard`; a newer site may send others, so keep a fallback.

**iconColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the design’s own color rhythm.

**number** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Overrides the auto number for this step’s marker, e.g. "01" or "A". Leave empty to auto-count.

**body** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional description under the title.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**stepsBg** `StepsBg | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The section’s full-width background band in dark mode. Transparent lets the page background show through. The palette options track the site colors; choose “Custom color…” for a specific color. One of `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**stepsBgCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (dark theme)” is set to Custom color.

**stepsBgLight** `StepsBgLight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. “Match dark theme” reuses the dark-theme choice; otherwise set the light-mode band independently. One of `inherit`, `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**stepsBgLightCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (light theme)” is set to Custom color.

**stepsFontOverrides** `readonly StepsWidgetStepsFontOverridesItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `StepsWidgetStepsFontOverridesItem`. Optional. Set part of this section in a different typeface. Leave empty to follow the site’s fonts (Site design → Typography). At most 4 items.

**StepsWidgetStepsFontOverridesItem**

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**target** `Target | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which text this typeface replaces. Rows apply in order, so a broad row (Everything) followed by a narrow one (Headings) gives the section a base face plus an exception. One of `all`, `heading`, `body`, `eyebrow`, `button`, `code`; a newer site may send others, so keep a fallback.

**source** `Source | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the typeface comes from. The first option costs nothing extra — those faces are already loaded. The others load an additional font on pages that use this section. One of `slot`, `curated`, `cdn`, `upload`; a newer site may send others, so keep a fallback.

**slot** `Slot | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Set in Site design → Typography. Following the site’s own faces keeps a section on-brand and adds no download. One of `display`, `body`, `accent`; a newer site may send others, so keep a fallback.

**curated** `Curated | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Vetted families from Bunny Fonts and Fontshare, with their available weights already verified. One of `archivo`, `bricolage-grotesque`, `clash-display`, `courier-prime`, `dm-mono`, `dm-sans`, `fira-code`, `fraunces`, `general-sans`, `ibm-plex-mono`, `ibm-plex-sans`, `inconsolata`, `inter`, `jetbrains-mono`, `karla`, `lora`, `manrope`, `nunito-sans`, `outfit`, `playfair-display`, `public-sans`, `red-hat-mono`, `satoshi`, `sentient`, `sora`, `source-code-pro`, `source-sans-3`, `source-serif-4`, `space-grotesk`, `space-mono`, `spline-sans-mono`, `supreme`, `switzer`, `syne`, `ubuntu-mono`, `unbounded`, `victor-mono`, `work-sans`, `zodiak`; a newer site may send others, so keep a fallback.

**cdnProvider** `CdnProvider | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where to browse for the family. Pick one, then follow the link below to find the exact name. One of `bunny`, `fontshare`; a newer site may send others, so keep a fallback.

**cdnFamily** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Exactly as the provider’s catalog spells it, e.g. "Space Grotesk" or "Clash Display". A name the provider doesn’t have loads nothing and this row is ignored.

**cdnWeights** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 500, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold) — but a family that ships only ONE weight (Acme, for instance) loads nothing at all unless that weight is among these, so set it explicitly if the typeface doesn’t appear.

**uploads** `readonly StepsWidgetStepsFontOverridesItemUploadsItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `StepsWidgetStepsFontOverridesItemUploadsItem`. One file per weight/style of the SAME typeface. woff2 strongly recommended (smallest, universally supported); woff/ttf/otf also accepted. At most 4 items.

**StepsWidgetStepsFontOverridesItemUploadsItem**

**file** `Readonly\<Record\<string, unknown\>\>`

**Always sent.** File attachment reference.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**weight** `Weight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Weight. One of `100`, `200`, `300`, `400`, `500`, `600`, `700`, `800`, `900`; a newer site may send others, so keep a fallback.

**style** `Style | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Style. One of `normal`, `italic`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**fallback** `Fallback | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Generic system font shown while this typeface loads (and if it fails). Curated picks set this automatically. One of `sans`, `serif`, `mono`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**stepsCtaLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The visible button text. Leave empty to hide the button.

**stepsCtaUrl** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Where the button goes — a path (/blog) or full URL.

**stepsCtaNewTab** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Opens the link in a new browser tab (adds rel="noopener noreferrer").

**stepsCtaVariant** `StepsCtaVariant | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fills with the color; Outline / Soft / Text link use it for the border + text. One of `solid`, `outline`, `soft`, `link`; a newer site may send others, so keep a fallback.

**stepsCtaSize** `StepsCtaSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Button size. One of `small`, `normal`, `large`; a newer site may send others, so keep a fallback.

**stepsCtaRadius** `StepsCtaRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner radius. One of `pill`, `rounded`, `slight`, `square`; a newer site may send others, so keep a fallback.

**stepsCtaColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fill, or the border + text for the other styles. Defaults to the brand accent; CLEAR it for a transparent, outline-only button.

**stepsCtaColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color. (Brand tokens already flip per theme.)

**stepsCtaTextColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The text/icon color. Clear it to derive from the button color (readable on solid fills).

**stepsCtaTextColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme label color.

**stepsCtaHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Drives the hover treatment. Leave empty to derive it from the button color.

**stepsCtaHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme hover color.

**stepsCtaStyle** `StepsCtaStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The hover treatment: a soft shadow, a colored offset shadow, a glow, a fill sweep, or a thicker border. One of `none`, `single`, `dual`, `glow`, `sweep`, `thicken`; a newer site may send others, so keep a fallback.

**stepsCtaShadowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. The offset-shadow or glow color on hover. Leave empty to use the site secondary color.

**stepsCtaShadowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme shadow color.

**stepsCtaAnimation** `StepsCtaAnimation | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Hover motion. One of `lift`, `scale`, `lift-scale`, `none`; a newer site may send others, so keep a fallback.

**stepsCtaIcon** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.

**stepsCtaIconFamily** `StepsCtaIconFamily | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon family. One of `classic-regular`, `duotone-regular`, `brands`, `jelly`, `jelly-duo`, `whiteboard`; a newer site may send others, so keep a fallback.

**stepsCtaIconPosition** `StepsCtaIconPosition | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which side of the label the icon sits on (when an icon name is set). One of `before`, `after`; a newer site may send others, so keep a fallback.

**stepsCtaIconNudge** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. The icon slides toward its side on hover (e.g. an arrow edges outward).

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**PricingWidget**

A `pricing` widget: its `type` and its own fields. A field left out takes its default.

**type** `PricingWidgetType`

**Always sent.** The widget’s type: always `pricing`. One of `pricing`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**pricingEyebrowEnabled** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. A small label above the heading (e.g. "Pricing").

**pricingEyebrow** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Eyebrow.

**pricingEyebrowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the secondary (mint) color.

**pricingEyebrowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**pricingEyebrowWeight** `PricingEyebrowWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**pricingEyebrowSize** `PricingEyebrowSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**pricingHeading** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional. Leave empty to show just the cards.

**pricingHeadingColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to track the theme text color.

**pricingHeadingColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**pricingHeadingWeight** `PricingHeadingWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Heading weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**pricingHeadingSize** `PricingHeadingSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Heading size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**pricingIntro** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional short sentence under the heading.

**pricingIntroColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the muted text color.

**pricingIntroColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**pricingIntroWeight** `PricingIntroWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Intro weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**pricingIntroSize** `PricingIntroSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Intro size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**pricingColumns** `PricingColumns | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Auto fits as many as comfortably fit and works for any number of cards. Or lock a maximum per row. One of `auto`, `2`, `3`, `4`; a newer site may send others, so keep a fallback.

**pricingGap** `PricingGap | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Gap between cards. One of `tight`, `normal`, `roomy`; a newer site may send others, so keep a fallback.

**pricingCardStyle** `PricingCardStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The base treatment for every tier (a highlighted tier always gets its own bold framed look). Raised is a quiet lit card; Luxe a frosted glass panel; Outline a plaque frame; Spine adds a color rail; Tint an accent wash; Ticket/Bracket/Forge/Press/Inlay are the graphic showstoppers. One of `raised`, `luxe`, `outline`, `plain`, `poster`, `edge`, `tint`, `ticket`, `bracket`, `forge`, `press`, `inlay`; a newer site may send others, so keep a fallback.

**pricingCardStyleRadius** `PricingCardStyleRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner rounding for each card. Default keeps the widget’s own tuned corners — except Forge, which defaults to tight machined corners matching its engraved frame. One of `default`, `square`, `slight`, `rounded`, `large`; a newer site may send others, so keep a fallback.

**pricingCardStyleAccentColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Colors the Spine rail, Bracket marks, Forge corner/frame and Press margin rule. Leave empty to use the brand accent.

**pricingCardStyleAccentColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**pricingCardStyleForgeScope** `PricingCardStyleForgeScope | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the Forge plate wears its color: a single corner mark (the machinist’s datum, default) or the whole engraved frame. One of `corner`, `frame`; a newer site may send others, so keep a fallback.

**pricingCardStyleForgeWeight** `PricingCardStyleForgeWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Thickness of the Forge corner mark / colored frame. One of `fine`, `medium`, `bold`; a newer site may send others, so keep a fallback.

**pricingAlign** `PricingAlign | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Aligns the section header and the text inside each card. One of `center`, `left`; a newer site may send others, so keep a fallback.

**pricingEqualHeight** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Stretch every card to the tallest one and pin each button to the bottom, so the cards line up even with uneven feature lists.

**pricingFeatureMarkers** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. A check (included) or cross (not included) before each feature. Off = a plain list.

**pricingCardHover** `PricingCardHover | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. How a card reacts to the pointer. Rise floats it up on an accent underglow; Selection ring previews the highlighted look + tints the price; Spotlight washes accent light over the price; Checklist lights up the ✓ marks one-by-one; Tilt is a 3-D parallax that only runs when site animations are on. One of `none`, `rise`, `ring`, `spotlight`, `checklist`, `tilt`; a newer site may send others, so keep a fallback.

**pricingHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Border / glow / spotlight / checkmark color on hover. Leave empty to use the highlight accent (then the site accent).

**pricingHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme hover accent.

**pricingEntrance** `PricingEntrance | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. How the cards animate in as they scroll into view. Featured-led makes the highlighted tier settle last with a little emphasis (draws the eye to the recommended plan); Simple stagger fades them in evenly. Only plays when site animations are on (Site design → Motion) — otherwise the cards are simply shown. One of `featured`, `stagger`, `none`; a newer site may send others, so keep a fallback.

**pricingNameSize** `PricingNameSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Size of each card’s name / title. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**pricingPriceSize** `PricingPriceSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Size of the price amount (the period and price note scale with it). One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**pricingDescSize** `PricingDescSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Size of each card’s description blurb. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**pricingFeatureSize** `PricingFeatureSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Size of the feature list text (notes and check marks scale with it). One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**pricingHighlightBadge** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Ribbon text shown on a highlighted tier that doesn’t set its own badge. Each tier can override it (or badge a non-highlighted tier) below. Leave empty for no automatic badge.

**pricingAccentColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Color for the highlighted tier’s border + ring and each tier’s badge. Leave empty to use the site accent color.

**pricingAccentColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme accent.

**pricingTiers** `readonly PricingWidgetPricingTiersItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `PricingWidgetPricingTiersItem`. Each card is one tier / package / service. Toggle “Highlight” on the one you want to stand out.

**PricingWidgetPricingTiersItem**

**name** `string`

**Always sent.** Tier / package / service name — e.g. "Starter", "Studio", "Agency".

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**icon** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.

**iconFamily** `IconFamily | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon family. One of `classic-regular`, `duotone-regular`, `brands`, `jelly`, `jelly-duo`, `whiteboard`; a newer site may send others, so keep a fallback.

**iconColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the design’s own color rhythm.

**iconAnimation** `IconAnimation | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon animation. One of `none`, `fa-beat`, `fa-bounce`, `fa-fade`, `fa-beat-fade`, `fa-flip`, `fa-shake`, `fa-spin`; a newer site may send others, so keep a fallback.

**iconSize** `IconSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Relative to the component’s base icon size. One of `default`, `sm`, `lg`, `xl`, `2xl`, `2x`, `3x`, `4x`, `5x`; a newer site may send others, so keep a fallback.

**iconGap** `IconGap | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Breathing room below the icon, before the card name. One of `none`, `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**badge** `string`

**Sometimes sent:** `undefined` when the site leaves it out. A small ribbon on the card, e.g. "Best value", "Limited spots". Overrides the default highlight badge for this tier; works on any tier, highlighted or not. Empty on a highlighted tier falls back to the section’s "Default highlight badge".

**highlighted** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Emphasize this tier — accent border + ring, a subtle lift, and the Featured button look.

**textAlign** `TextAlign | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. How this card’s text lines up. Normal = the section default (a centered section keeps the feature list left-aligned, as now). Center also centers the feature list; Left / Right align everything that way. One of `normal`, `left`, `center`, `right`; a newer site may send others, so keep a fallback.

**price** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Free text, so it fits any model — "$45", "From $200", "Custom", "Call for quote".

**period** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Shown after the price, e.g. "/ month", "per night", "per session". Leave empty for a flat price.

**priceNote** `string`

**Sometimes sent:** `undefined` when the site leaves it out. A small line under the price, e.g. "per seat", "billed annually", "+ tax".

**description** `string`

**Sometimes sent:** `undefined` when the site leaves it out. A short blurb under the name.

**features** `readonly PricingWidgetPricingTiersItemFeaturesItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `PricingWidgetPricingTiersItemFeaturesItem`. The bullet list of what’s included.

**PricingWidgetPricingTiersItemFeaturesItem**

**text** `string`

**Always sent.** Feature.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**included** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. On = a check mark; off = a crossed-out / muted line (e.g. a feature this tier lacks).

**note** `string`

**Sometimes sent:** `undefined` when the site leaves it out. A small qualifier shown after the feature, e.g. "up to 5", "add-on".

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**ctaLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. This card’s button text. Leave empty to use the shared button label (set in the Pricing · Buttons tab); clear it everywhere to hide the button.

**ctaUrl** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Where the button goes — a path (/contact-us) or full URL. Leave empty to inherit the shared button link.

**ctaNewTab** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Open button in new tab.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**pricingBg** `PricingBg | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The section’s full-width background band in dark mode. Transparent lets the page background show through. The palette options track the site colors; choose “Custom color…” for a specific color. One of `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**pricingBgCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (dark theme)” is set to Custom color.

**pricingBgLight** `PricingBgLight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. “Match dark theme” reuses the dark-theme choice; otherwise set the light-mode band independently. One of `inherit`, `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**pricingBgLightCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (light theme)” is set to Custom color.

**pricingFontOverrides** `readonly PricingWidgetPricingFontOverridesItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `PricingWidgetPricingFontOverridesItem`. Optional. Set part of this section in a different typeface. Leave empty to follow the site’s fonts (Site design → Typography). At most 4 items.

**PricingWidgetPricingFontOverridesItem**

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**target** `Target | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which text this typeface replaces. Rows apply in order, so a broad row (Everything) followed by a narrow one (Headings) gives the section a base face plus an exception. One of `all`, `heading`, `body`, `eyebrow`, `button`, `code`; a newer site may send others, so keep a fallback.

**source** `Source | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the typeface comes from. The first option costs nothing extra — those faces are already loaded. The others load an additional font on pages that use this section. One of `slot`, `curated`, `cdn`, `upload`; a newer site may send others, so keep a fallback.

**slot** `Slot | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Set in Site design → Typography. Following the site’s own faces keeps a section on-brand and adds no download. One of `display`, `body`, `accent`; a newer site may send others, so keep a fallback.

**curated** `Curated | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Vetted families from Bunny Fonts and Fontshare, with their available weights already verified. One of `archivo`, `bricolage-grotesque`, `clash-display`, `courier-prime`, `dm-mono`, `dm-sans`, `fira-code`, `fraunces`, `general-sans`, `ibm-plex-mono`, `ibm-plex-sans`, `inconsolata`, `inter`, `jetbrains-mono`, `karla`, `lora`, `manrope`, `nunito-sans`, `outfit`, `playfair-display`, `public-sans`, `red-hat-mono`, `satoshi`, `sentient`, `sora`, `source-code-pro`, `source-sans-3`, `source-serif-4`, `space-grotesk`, `space-mono`, `spline-sans-mono`, `supreme`, `switzer`, `syne`, `ubuntu-mono`, `unbounded`, `victor-mono`, `work-sans`, `zodiak`; a newer site may send others, so keep a fallback.

**cdnProvider** `CdnProvider | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where to browse for the family. Pick one, then follow the link below to find the exact name. One of `bunny`, `fontshare`; a newer site may send others, so keep a fallback.

**cdnFamily** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Exactly as the provider’s catalog spells it, e.g. "Space Grotesk" or "Clash Display". A name the provider doesn’t have loads nothing and this row is ignored.

**cdnWeights** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 500, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold) — but a family that ships only ONE weight (Acme, for instance) loads nothing at all unless that weight is among these, so set it explicitly if the typeface doesn’t appear.

**uploads** `readonly PricingWidgetPricingFontOverridesItemUploadsItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `PricingWidgetPricingFontOverridesItemUploadsItem`. One file per weight/style of the SAME typeface. woff2 strongly recommended (smallest, universally supported); woff/ttf/otf also accepted. At most 4 items.

**PricingWidgetPricingFontOverridesItemUploadsItem**

**file** `Readonly\<Record\<string, unknown\>\>`

**Always sent.** File attachment reference.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**weight** `Weight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Weight. One of `100`, `200`, `300`, `400`, `500`, `600`, `700`, `800`, `900`; a newer site may send others, so keep a fallback.

**style** `Style | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Style. One of `normal`, `italic`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**fallback** `Fallback | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Generic system font shown while this typeface loads (and if it fails). Curated picks set this automatically. One of `sans`, `serif`, `mono`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**pricingFeaturedCtaLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The visible button text. Leave empty to hide the button.

**pricingFeaturedCtaUrl** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Where the button goes — a path (/blog) or full URL.

**pricingFeaturedCtaNewTab** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Opens the link in a new browser tab (adds rel="noopener noreferrer").

**pricingFeaturedCtaVariant** `PricingFeaturedCtaVariant | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fills with the color; Outline / Soft / Text link use it for the border + text. One of `solid`, `outline`, `soft`, `link`; a newer site may send others, so keep a fallback.

**pricingFeaturedCtaSize** `PricingFeaturedCtaSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Button size. One of `small`, `normal`, `large`; a newer site may send others, so keep a fallback.

**pricingFeaturedCtaRadius** `PricingFeaturedCtaRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner radius. One of `pill`, `rounded`, `slight`, `square`; a newer site may send others, so keep a fallback.

**pricingFeaturedCtaColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fill, or the border + text for the other styles. Defaults to the brand accent; CLEAR it for a transparent, outline-only button.

**pricingFeaturedCtaColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color. (Brand tokens already flip per theme.)

**pricingFeaturedCtaTextColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The text/icon color. Clear it to derive from the button color (readable on solid fills).

**pricingFeaturedCtaTextColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme label color.

**pricingFeaturedCtaHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Drives the hover treatment. Leave empty to derive it from the button color.

**pricingFeaturedCtaHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme hover color.

**pricingFeaturedCtaStyle** `PricingFeaturedCtaStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The hover treatment: a soft shadow, a colored offset shadow, a glow, a fill sweep, or a thicker border. One of `none`, `single`, `dual`, `glow`, `sweep`, `thicken`; a newer site may send others, so keep a fallback.

**pricingFeaturedCtaShadowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. The offset-shadow or glow color on hover. Leave empty to use the site secondary color.

**pricingFeaturedCtaShadowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme shadow color.

**pricingFeaturedCtaAnimation** `PricingFeaturedCtaAnimation | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Hover motion. One of `lift`, `scale`, `lift-scale`, `none`; a newer site may send others, so keep a fallback.

**pricingFeaturedCtaIcon** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.

**pricingFeaturedCtaIconFamily** `PricingFeaturedCtaIconFamily | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon family. One of `classic-regular`, `duotone-regular`, `brands`, `jelly`, `jelly-duo`, `whiteboard`; a newer site may send others, so keep a fallback.

**pricingFeaturedCtaIconPosition** `PricingFeaturedCtaIconPosition | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which side of the label the icon sits on (when an icon name is set). One of `before`, `after`; a newer site may send others, so keep a fallback.

**pricingFeaturedCtaIconNudge** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. The icon slides toward its side on hover (e.g. an arrow edges outward).

**pricingCtaLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The visible button text. Leave empty to hide the button.

**pricingCtaUrl** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Where the button goes — a path (/blog) or full URL.

**pricingCtaNewTab** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Opens the link in a new browser tab (adds rel="noopener noreferrer").

**pricingCtaVariant** `PricingCtaVariant | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fills with the color; Outline / Soft / Text link use it for the border + text. One of `solid`, `outline`, `soft`, `link`; a newer site may send others, so keep a fallback.

**pricingCtaSize** `PricingCtaSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Button size. One of `small`, `normal`, `large`; a newer site may send others, so keep a fallback.

**pricingCtaRadius** `PricingCtaRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner radius. One of `pill`, `rounded`, `slight`, `square`; a newer site may send others, so keep a fallback.

**pricingCtaColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fill, or the border + text for the other styles. Defaults to the brand accent; CLEAR it for a transparent, outline-only button.

**pricingCtaColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color. (Brand tokens already flip per theme.)

**pricingCtaTextColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The text/icon color. Clear it to derive from the button color (readable on solid fills).

**pricingCtaTextColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme label color.

**pricingCtaHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Drives the hover treatment. Leave empty to derive it from the button color.

**pricingCtaHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme hover color.

**pricingCtaStyle** `PricingCtaStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The hover treatment: a soft shadow, a colored offset shadow, a glow, a fill sweep, or a thicker border. One of `none`, `single`, `dual`, `glow`, `sweep`, `thicken`; a newer site may send others, so keep a fallback.

**pricingCtaShadowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. The offset-shadow or glow color on hover. Leave empty to use the site secondary color.

**pricingCtaShadowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme shadow color.

**pricingCtaAnimation** `PricingCtaAnimation | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Hover motion. One of `lift`, `scale`, `lift-scale`, `none`; a newer site may send others, so keep a fallback.

**pricingCtaIcon** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.

**pricingCtaIconFamily** `PricingCtaIconFamily | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon family. One of `classic-regular`, `duotone-regular`, `brands`, `jelly`, `jelly-duo`, `whiteboard`; a newer site may send others, so keep a fallback.

**pricingCtaIconPosition** `PricingCtaIconPosition | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which side of the label the icon sits on (when an icon name is set). One of `before`, `after`; a newer site may send others, so keep a fallback.

**pricingCtaIconNudge** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. The icon slides toward its side on hover (e.g. an arrow edges outward).

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**MediaTextWidget**

A `media-text` widget: its `type` and its own fields. A field left out takes its default.

**type** `MediaTextWidgetType`

**Always sent.** The widget’s type: always `media-text`. One of `media-text`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**mediaTextEyebrowEnabled** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. A small label above the section heading (e.g. "Why us").

**mediaTextEyebrow** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Eyebrow.

**mediaTextEyebrowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the secondary (mint) color.

**mediaTextEyebrowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**mediaTextEyebrowWeight** `MediaTextEyebrowWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**mediaTextEyebrowSize** `MediaTextEyebrowSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**mediaTextHeading** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional section heading above the blocks. Leave empty to show just the blocks.

**mediaTextHeadingColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to track the theme text color.

**mediaTextHeadingColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**mediaTextHeadingWeight** `MediaTextHeadingWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Heading weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**mediaTextHeadingSize** `MediaTextHeadingSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Heading size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**mediaTextIntro** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional short sentence under the heading.

**mediaTextIntroColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the muted text color.

**mediaTextIntroColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**mediaTextIntroWeight** `MediaTextIntroWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Intro weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**mediaTextIntroSize** `MediaTextIntroSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Intro size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**mediaTextAlign** `MediaTextAlign | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Aligns the section header and the text inside each block. (Side-by-side rows usually read best left-aligned.) One of `left`, `center`; a newer site may send others, so keep a fallback.

**mediaTextRatio** `MediaTextRatio | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. For media-left / media-right rows: how the two columns share the width. One of `balanced`, `media`, `text`; a newer site may send others, so keep a fallback.

**mediaTextVAlign** `MediaTextVAlign | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. For media-left / media-right rows: how the text lines up against the media. One of `center`, `top`; a newer site may send others, so keep a fallback.

**mediaTextMediaRatio** `MediaTextMediaRatio | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Aspect ratio of the media frame. Auto keeps an image at its natural shape (videos and embeds always use a ratio). One of `auto`, `landscape`, `standard`, `square`, `portrait`, `wide`; a newer site may send others, so keep a fallback.

**mediaTextMediaRadius** `MediaTextMediaRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Media corners. One of `large`, `rounded`, `slight`, `square`; a newer site may send others, so keep a fallback.

**mediaTextGap** `MediaTextGap | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Gap between blocks. One of `tight`, `normal`, `roomy`; a newer site may send others, so keep a fallback.

**mediaTextDividers** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. A hairline rule between blocks.

**mediaTextBlockEyebrowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Each block’s eyebrow color. Leave empty to use the secondary (mint) color.

**mediaTextBlockEyebrowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**mediaTextBlockEyebrowWeight** `MediaTextBlockEyebrowWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Block eyebrow weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**mediaTextBlockHeadingColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to track the theme text color.

**mediaTextBlockHeadingColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**mediaTextBlockHeadingWeight** `MediaTextBlockHeadingWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Block heading weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**mediaTextBlockHeadingSize** `MediaTextBlockHeadingSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Block heading size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**mediaTextBodyColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the muted text color.

**mediaTextBodyColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**mediaTextBodyWeight** `MediaTextBodyWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Block body weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**mediaTextBodySize** `MediaTextBodySize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Block body size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**mediaTextBlocks** `readonly MediaTextWidgetMediaTextBlocksItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `MediaTextWidgetMediaTextBlocksItem`. Each block is one media + text row. They render top to bottom in this order; alternate “Media left” / “Media right” for a classic zig-zag.

**MediaTextWidgetMediaTextBlocksItem**

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**layout** `Layout | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Media left / right place the media beside the text; Stacked puts media above the text; Full-bleed runs the media edge-to-edge with the text below. One of `media-left`, `media-right`, `stacked`, `full`; a newer site may send others, so keep a fallback.

**mediaType** `MediaTextWidgetMediaTextBlocksItemMediaType | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Pick where the media comes from. “None” makes this a text-only block. One of `image`, `video`, `embed`, `none`; a newer site may send others, so keep a fallback.

**image** `readonly Readonly\<Record\<string, unknown\>\>[]`

**Sometimes sent:** `undefined` when the site leaves it out. Pick an image from the Images library. The related `@apostrophecms/image` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.

**imageAlt** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Describe the image for screen readers and SEO. Leave empty to use the library image’s own alt text. Set to a single space for a purely decorative image.

**video** `readonly Readonly\<Record\<string, unknown\>\>[]`

**Sometimes sent:** `undefined` when the site leaves it out. Pick a clip from the Videos library (⌘K → Videos). The related `video` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.

**videoAutoplay** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Play automatically as a muted, looping background clip (a pause button is shown, and reduced-motion visitors get the poster image). Off = a normal video with play controls.

**embedUrl** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Paste a YouTube or Vimeo link, e.g. [https://youtu.be/…](https://youtu.be/…) or [https://vimeo.com/…](https://vimeo.com/…).

**eyebrow** `string`

**Sometimes sent:** `undefined` when the site leaves it out. A small label above the block heading.

**heading** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The block’s headline.

**body** `string`

**Sometimes sent:** `undefined` when the site leaves it out. A paragraph or two. Leave a blank line between paragraphs.

**ctaLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. This block’s button text. Leave empty (with no link) to hide the button.

**ctaUrl** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Where the button goes — a path (/about-us) or full URL.

**ctaNewTab** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Open button in new tab.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**mediaTextBg** `MediaTextBg | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The section’s full-width background band in dark mode. Transparent lets the page background show through. The palette options track the site colors; choose “Custom color…” for a specific color. One of `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**mediaTextBgCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (dark theme)” is set to Custom color.

**mediaTextBgLight** `MediaTextBgLight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. “Match dark theme” reuses the dark-theme choice; otherwise set the light-mode band independently. One of `inherit`, `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**mediaTextBgLightCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (light theme)” is set to Custom color.

**mediaTextFontOverrides** `readonly MediaTextWidgetMediaTextFontOverridesItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `MediaTextWidgetMediaTextFontOverridesItem`. Optional. Set part of this section in a different typeface. Leave empty to follow the site’s fonts (Site design → Typography). At most 4 items.

**MediaTextWidgetMediaTextFontOverridesItem**

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**target** `Target | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which text this typeface replaces. Rows apply in order, so a broad row (Everything) followed by a narrow one (Headings) gives the section a base face plus an exception. One of `all`, `heading`, `body`, `eyebrow`, `button`, `code`; a newer site may send others, so keep a fallback.

**source** `Source | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the typeface comes from. The first option costs nothing extra — those faces are already loaded. The others load an additional font on pages that use this section. One of `slot`, `curated`, `cdn`, `upload`; a newer site may send others, so keep a fallback.

**slot** `Slot | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Set in Site design → Typography. Following the site’s own faces keeps a section on-brand and adds no download. One of `display`, `body`, `accent`; a newer site may send others, so keep a fallback.

**curated** `Curated | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Vetted families from Bunny Fonts and Fontshare, with their available weights already verified. One of `archivo`, `bricolage-grotesque`, `clash-display`, `courier-prime`, `dm-mono`, `dm-sans`, `fira-code`, `fraunces`, `general-sans`, `ibm-plex-mono`, `ibm-plex-sans`, `inconsolata`, `inter`, `jetbrains-mono`, `karla`, `lora`, `manrope`, `nunito-sans`, `outfit`, `playfair-display`, `public-sans`, `red-hat-mono`, `satoshi`, `sentient`, `sora`, `source-code-pro`, `source-sans-3`, `source-serif-4`, `space-grotesk`, `space-mono`, `spline-sans-mono`, `supreme`, `switzer`, `syne`, `ubuntu-mono`, `unbounded`, `victor-mono`, `work-sans`, `zodiak`; a newer site may send others, so keep a fallback.

**cdnProvider** `CdnProvider | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where to browse for the family. Pick one, then follow the link below to find the exact name. One of `bunny`, `fontshare`; a newer site may send others, so keep a fallback.

**cdnFamily** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Exactly as the provider’s catalog spells it, e.g. "Space Grotesk" or "Clash Display". A name the provider doesn’t have loads nothing and this row is ignored.

**cdnWeights** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 500, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold) — but a family that ships only ONE weight (Acme, for instance) loads nothing at all unless that weight is among these, so set it explicitly if the typeface doesn’t appear.

**uploads** `readonly MediaTextWidgetMediaTextFontOverridesItemUploadsItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `MediaTextWidgetMediaTextFontOverridesItemUploadsItem`. One file per weight/style of the SAME typeface. woff2 strongly recommended (smallest, universally supported); woff/ttf/otf also accepted. At most 4 items.

**MediaTextWidgetMediaTextFontOverridesItemUploadsItem**

**file** `Readonly\<Record\<string, unknown\>\>`

**Always sent.** File attachment reference.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**weight** `Weight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Weight. One of `100`, `200`, `300`, `400`, `500`, `600`, `700`, `800`, `900`; a newer site may send others, so keep a fallback.

**style** `Style | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Style. One of `normal`, `italic`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**fallback** `Fallback | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Generic system font shown while this typeface loads (and if it fails). Curated picks set this automatically. One of `sans`, `serif`, `mono`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**mediaTextCtaVariant** `MediaTextCtaVariant | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fills with the color; Outline / Soft / Text link use it for the border + text. One of `solid`, `outline`, `soft`, `link`; a newer site may send others, so keep a fallback.

**mediaTextCtaSize** `MediaTextCtaSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Button size. One of `small`, `normal`, `large`; a newer site may send others, so keep a fallback.

**mediaTextCtaRadius** `MediaTextCtaRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner radius. One of `pill`, `rounded`, `slight`, `square`; a newer site may send others, so keep a fallback.

**mediaTextCtaColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fill, or the border + text for the other styles. Defaults to the brand accent; CLEAR it for a transparent, outline-only button.

**mediaTextCtaColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color. (Brand tokens already flip per theme.)

**mediaTextCtaTextColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The text/icon color. Clear it to derive from the button color (readable on solid fills).

**mediaTextCtaTextColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme label color.

**mediaTextCtaHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Drives the hover treatment. Leave empty to derive it from the button color.

**mediaTextCtaHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme hover color.

**mediaTextCtaStyle** `MediaTextCtaStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The hover treatment: a soft shadow, a colored offset shadow, a glow, a fill sweep, or a thicker border. One of `none`, `single`, `dual`, `glow`, `sweep`, `thicken`; a newer site may send others, so keep a fallback.

**mediaTextCtaShadowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. The offset-shadow or glow color on hover. Leave empty to use the site secondary color.

**mediaTextCtaShadowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme shadow color.

**mediaTextCtaAnimation** `MediaTextCtaAnimation | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Hover motion. One of `lift`, `scale`, `lift-scale`, `none`; a newer site may send others, so keep a fallback.

**mediaTextCtaIcon** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.

**mediaTextCtaIconFamily** `MediaTextCtaIconFamily | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon family. One of `classic-regular`, `duotone-regular`, `brands`, `jelly`, `jelly-duo`, `whiteboard`; a newer site may send others, so keep a fallback.

**mediaTextCtaIconPosition** `MediaTextCtaIconPosition | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which side of the label the icon sits on (when an icon name is set). One of `before`, `after`; a newer site may send others, so keep a fallback.

**mediaTextCtaIconNudge** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. The icon slides toward its side on hover (e.g. an arrow edges outward).

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**DeviceMockWidget**

A `device-mock` widget: its `type` and its own fields. A field left out takes its default.

**type** `DeviceMockWidgetType`

**Always sent.** The widget’s type: always `device-mock`. One of `device-mock`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**deviceMockArrangement** `DeviceMockArrangement | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which devices to show. Duo overlaps a phone on the corner of a desktop browser; Trio adds a TV behind them (on narrow screens Trio drops the TV and shows as a Duo). Each device used gets its own screen tab. One of `duo`, `trio`, `desktop`, `phone`, `tv`; a newer site may send others, so keep a fallback.

**deviceMockTextPlacement** `DeviceMockTextPlacement | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the eyebrow / heading / intro / button sit. Left or right puts the text in a column beside the devices (stacked above them on narrow screens); None shows the devices only. One of `above`, `left`, `right`, `none`; a newer site may send others, so keep a fallback.

**deviceMockSize** `DeviceMockSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. How large the devices render within the section. One of `compact`, `normal`, `large`; a newer site may send others, so keep a fallback.

**deviceMockBrowserRatio** `DeviceMockBrowserRatio | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The browser window’s content area. Match your desktop captures. One of `16:10`, `16:9`; a newer site may send others, so keep a fallback.

**deviceMockBrowserUrl** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The address shown in the browser toolbar — decoration only, not a link.

**deviceMockPhoneStatusBar** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Adds a time / signal / battery bar across the top of the phone screen. Leave off for native phone screenshots — they already include the real status bar.

**deviceMockPhoneTime** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Status bar time.

**deviceMockMotionPause** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Adds a small, unobtrusive pause/play control so visitors can stop the auto-playing background motion (WCAG 2.2.2). Only appears when a moving background is set.

**deviceMockEyebrowEnabled** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. A small label above the heading (e.g. "Product tour").

**deviceMockEyebrow** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Small label shown above the title.

**deviceMockEyebrowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Overrides the eyebrow + its dash. Leave empty to use the secondary (mint) color.

**deviceMockEyebrowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the mint default.

**deviceMockEyebrowWeight** `DeviceMockEyebrowWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**deviceMockEyebrowSize** `DeviceMockEyebrowSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**deviceMockHeading** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional. Leave empty to show just the devices.

**deviceMockHeadingColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to track the theme text color.

**deviceMockHeadingColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**deviceMockHeadingWeight** `DeviceMockHeadingWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Heading weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**deviceMockHeadingSize** `DeviceMockHeadingSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Heading size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**deviceMockIntro** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional short paragraph under the heading.

**deviceMockIntroColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the muted text color.

**deviceMockIntroColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**deviceMockIntroWeight** `DeviceMockIntroWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Intro weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**deviceMockIntroSize** `DeviceMockIntroSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Intro size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**deviceMockCaption** `string`

**Sometimes sent:** `undefined` when the site leaves it out. A short line shown under the devices.

**deviceMockTvMediaType** `DeviceMockTvMediaType | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A still screenshot, or a short looping screen recording. One of `image`, `video`; a newer site may send others, so keep a fallback.

**deviceMockTvImage** `readonly Readonly\<Record\<string, unknown\>\>[]`

**Sometimes sent:** `undefined` when the site leaves it out. Use a native-resolution 16:9 capture of the screen with NO device frame (the frame is drawn for you) — e.g. 1920 × 1080 or 3840 × 2160. The related `@apostrophecms/image` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.

**deviceMockTvImageAlt** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Required once a screenshot is picked. Describe what the screen shows for visitors who can’t see it — e.g. “Dashboard with a weekly activity chart and a list of recent orders”. Skip the device itself (“a phone showing…”); the frame is decorative.

**deviceMockTvVideo** `readonly Readonly\<Record\<string, unknown\>\>[]`

**Sometimes sent:** `undefined` when the site leaves it out. Pick a clip from the Videos library (⌘K → Videos). It plays as a short, muted, looping screen recording — keep it SHORT (about 5–15 seconds) and SMALL (under about 10 MB; an H.264 MP4 without an audio track is ideal), and give the Videos item a poster image: visitors see the poster first, and reduced-motion visitors only ever see the poster. Use a native-resolution 16:9 capture of the screen with NO device frame (the frame is drawn for you) — e.g. 1920 × 1080 or 3840 × 2160. The related `video` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.

**deviceMockTvVideoAlt** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Recommended. A short description of what the recording shows, read to screen-reader users — e.g. “Creating a new project in three clicks”. Leave empty only if the surrounding text already says it.

**deviceMockTvFit** `DeviceMockTvFit | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Fill crops the media to fill the whole screen (best for native captures). Fit shows the whole image or video, leaving bars if its shape differs from the screen. One of `cover`, `contain`; a newer site may send others, so keep a fallback.

**deviceMockTvAnchor** `DeviceMockTvAnchor | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which part stays visible when the media is cropped. Top keeps an app’s header in view — right for most screenshots. One of `top`, `center`, `bottom`; a newer site may send others, so keep a fallback.

**deviceMockDesktopMediaType** `DeviceMockDesktopMediaType | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A still screenshot, or a short looping screen recording. One of `image`, `video`; a newer site may send others, so keep a fallback.

**deviceMockDesktopImage** `readonly Readonly\<Record\<string, unknown\>\>[]`

**Sometimes sent:** `undefined` when the site leaves it out. Use a native-resolution capture of the page content only — no browser toolbar and no device frame (both are drawn for you). 16:10 (e.g. 2880 × 1800) or 16:9 (e.g. 2560 × 1440), matching the “Desktop screen shape” setting. The related `@apostrophecms/image` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.

**deviceMockDesktopImageAlt** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Required once a screenshot is picked. Describe what the screen shows for visitors who can’t see it — e.g. “Dashboard with a weekly activity chart and a list of recent orders”. Skip the device itself (“a phone showing…”); the frame is decorative.

**deviceMockDesktopVideo** `readonly Readonly\<Record\<string, unknown\>\>[]`

**Sometimes sent:** `undefined` when the site leaves it out. Pick a clip from the Videos library (⌘K → Videos). It plays as a short, muted, looping screen recording — keep it SHORT (about 5–15 seconds) and SMALL (under about 10 MB; an H.264 MP4 without an audio track is ideal), and give the Videos item a poster image: visitors see the poster first, and reduced-motion visitors only ever see the poster. Use a native-resolution capture of the page content only — no browser toolbar and no device frame (both are drawn for you). 16:10 (e.g. 2880 × 1800) or 16:9 (e.g. 2560 × 1440), matching the “Desktop screen shape” setting. The related `video` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.

**deviceMockDesktopVideoAlt** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Recommended. A short description of what the recording shows, read to screen-reader users — e.g. “Creating a new project in three clicks”. Leave empty only if the surrounding text already says it.

**deviceMockDesktopFit** `DeviceMockDesktopFit | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Fill crops the media to fill the whole screen (best for native captures). Fit shows the whole image or video, leaving bars if its shape differs from the screen. One of `cover`, `contain`; a newer site may send others, so keep a fallback.

**deviceMockDesktopAnchor** `DeviceMockDesktopAnchor | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which part stays visible when the media is cropped. Top keeps an app’s header in view — right for most screenshots. One of `top`, `center`, `bottom`; a newer site may send others, so keep a fallback.

**deviceMockPhoneMediaType** `DeviceMockPhoneMediaType | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A still screenshot, or a short looping screen recording. One of `image`, `video`; a newer site may send others, so keep a fallback.

**deviceMockPhoneImage** `readonly Readonly\<Record\<string, unknown\>\>[]`

**Sometimes sent:** `undefined` when the site leaves it out. Use a native-resolution portrait screenshot with NO device frame (the frame is drawn for you) — e.g. 1179 × 2556 or 1290 × 2796 (about 9:19.5). The related `@apostrophecms/image` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.

**deviceMockPhoneImageAlt** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Required once a screenshot is picked. Describe what the screen shows for visitors who can’t see it — e.g. “Dashboard with a weekly activity chart and a list of recent orders”. Skip the device itself (“a phone showing…”); the frame is decorative.

**deviceMockPhoneVideo** `readonly Readonly\<Record\<string, unknown\>\>[]`

**Sometimes sent:** `undefined` when the site leaves it out. Pick a clip from the Videos library (⌘K → Videos). It plays as a short, muted, looping screen recording — keep it SHORT (about 5–15 seconds) and SMALL (under about 10 MB; an H.264 MP4 without an audio track is ideal), and give the Videos item a poster image: visitors see the poster first, and reduced-motion visitors only ever see the poster. Use a native-resolution portrait screenshot with NO device frame (the frame is drawn for you) — e.g. 1179 × 2556 or 1290 × 2796 (about 9:19.5). The related `video` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.

**deviceMockPhoneVideoAlt** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Recommended. A short description of what the recording shows, read to screen-reader users — e.g. “Creating a new project in three clicks”. Leave empty only if the surrounding text already says it.

**deviceMockPhoneFit** `DeviceMockPhoneFit | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Fill crops the media to fill the whole screen (best for native captures). Fit shows the whole image or video, leaving bars if its shape differs from the screen. One of `cover`, `contain`; a newer site may send others, so keep a fallback.

**deviceMockPhoneAnchor** `DeviceMockPhoneAnchor | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which part stays visible when the media is cropped. Top keeps an app’s header in view — right for most screenshots. One of `top`, `center`, `bottom`; a newer site may send others, so keep a fallback.

**deviceMockBg** `DeviceMockBg | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The section’s full-width background band in dark mode. Transparent lets the page background show through. The palette options track the site colors; choose “Custom color…” for a specific color. One of `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**deviceMockBgCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (dark theme)” is set to Custom color.

**deviceMockBgLight** `DeviceMockBgLight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. “Match dark theme” reuses the dark-theme choice; otherwise set the light-mode band independently. One of `inherit`, `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**deviceMockBgLightCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (light theme)” is set to Custom color.

**deviceMockFontOverrides** `readonly DeviceMockWidgetDeviceMockFontOverridesItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `DeviceMockWidgetDeviceMockFontOverridesItem`. Optional. Set part of this section in a different typeface. Leave empty to follow the site’s fonts (Site design → Typography). At most 4 items.

**DeviceMockWidgetDeviceMockFontOverridesItem**

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**target** `Target | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which text this typeface replaces. Rows apply in order, so a broad row (Everything) followed by a narrow one (Headings) gives the section a base face plus an exception. One of `all`, `heading`, `body`, `eyebrow`, `button`, `code`; a newer site may send others, so keep a fallback.

**source** `Source | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the typeface comes from. The first option costs nothing extra — those faces are already loaded. The others load an additional font on pages that use this section. One of `slot`, `curated`, `cdn`, `upload`; a newer site may send others, so keep a fallback.

**slot** `Slot | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Set in Site design → Typography. Following the site’s own faces keeps a section on-brand and adds no download. One of `display`, `body`, `accent`; a newer site may send others, so keep a fallback.

**curated** `Curated | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Vetted families from Bunny Fonts and Fontshare, with their available weights already verified. One of `archivo`, `bricolage-grotesque`, `clash-display`, `courier-prime`, `dm-mono`, `dm-sans`, `fira-code`, `fraunces`, `general-sans`, `ibm-plex-mono`, `ibm-plex-sans`, `inconsolata`, `inter`, `jetbrains-mono`, `karla`, `lora`, `manrope`, `nunito-sans`, `outfit`, `playfair-display`, `public-sans`, `red-hat-mono`, `satoshi`, `sentient`, `sora`, `source-code-pro`, `source-sans-3`, `source-serif-4`, `space-grotesk`, `space-mono`, `spline-sans-mono`, `supreme`, `switzer`, `syne`, `ubuntu-mono`, `unbounded`, `victor-mono`, `work-sans`, `zodiak`; a newer site may send others, so keep a fallback.

**cdnProvider** `CdnProvider | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where to browse for the family. Pick one, then follow the link below to find the exact name. One of `bunny`, `fontshare`; a newer site may send others, so keep a fallback.

**cdnFamily** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Exactly as the provider’s catalog spells it, e.g. "Space Grotesk" or "Clash Display". A name the provider doesn’t have loads nothing and this row is ignored.

**cdnWeights** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 500, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold) — but a family that ships only ONE weight (Acme, for instance) loads nothing at all unless that weight is among these, so set it explicitly if the typeface doesn’t appear.

**uploads** `readonly DeviceMockWidgetDeviceMockFontOverridesItemUploadsItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `DeviceMockWidgetDeviceMockFontOverridesItemUploadsItem`. One file per weight/style of the SAME typeface. woff2 strongly recommended (smallest, universally supported); woff/ttf/otf also accepted. At most 4 items.

**DeviceMockWidgetDeviceMockFontOverridesItemUploadsItem**

**file** `Readonly\<Record\<string, unknown\>\>`

**Always sent.** File attachment reference.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**weight** `Weight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Weight. One of `100`, `200`, `300`, `400`, `500`, `600`, `700`, `800`, `900`; a newer site may send others, so keep a fallback.

**style** `Style | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Style. One of `normal`, `italic`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**fallback** `Fallback | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Generic system font shown while this typeface loads (and if it fails). Curated picks set this automatically. One of `sans`, `serif`, `mono`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**deviceMockCtaLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The visible button text. Leave empty to hide the button.

**deviceMockCtaUrl** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Where the button goes — a path (/blog) or full URL.

**deviceMockCtaNewTab** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Opens the link in a new browser tab (adds rel="noopener noreferrer").

**deviceMockCtaVariant** `DeviceMockCtaVariant | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fills with the color; Outline / Soft / Text link use it for the border + text. One of `solid`, `outline`, `soft`, `link`; a newer site may send others, so keep a fallback.

**deviceMockCtaSize** `DeviceMockCtaSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Button size. One of `small`, `normal`, `large`; a newer site may send others, so keep a fallback.

**deviceMockCtaRadius** `DeviceMockCtaRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner radius. One of `pill`, `rounded`, `slight`, `square`; a newer site may send others, so keep a fallback.

**deviceMockCtaColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fill, or the border + text for the other styles. Defaults to the brand accent; CLEAR it for a transparent, outline-only button.

**deviceMockCtaColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color. (Brand tokens already flip per theme.)

**deviceMockCtaTextColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The text/icon color. Clear it to derive from the button color (readable on solid fills).

**deviceMockCtaTextColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme label color.

**deviceMockCtaHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Drives the hover treatment. Leave empty to derive it from the button color.

**deviceMockCtaHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme hover color.

**deviceMockCtaStyle** `DeviceMockCtaStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The hover treatment: a soft shadow, a colored offset shadow, a glow, a fill sweep, or a thicker border. One of `none`, `single`, `dual`, `glow`, `sweep`, `thicken`; a newer site may send others, so keep a fallback.

**deviceMockCtaShadowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. The offset-shadow or glow color on hover. Leave empty to use the site secondary color.

**deviceMockCtaShadowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme shadow color.

**deviceMockCtaAnimation** `DeviceMockCtaAnimation | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Hover motion. One of `lift`, `scale`, `lift-scale`, `none`; a newer site may send others, so keep a fallback.

**deviceMockCtaIcon** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.

**deviceMockCtaIconFamily** `DeviceMockCtaIconFamily | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon family. One of `classic-regular`, `duotone-regular`, `brands`, `jelly`, `jelly-duo`, `whiteboard`; a newer site may send others, so keep a fallback.

**deviceMockCtaIconPosition** `DeviceMockCtaIconPosition | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which side of the label the icon sits on (when an icon name is set). One of `before`, `after`; a newer site may send others, so keep a fallback.

**deviceMockCtaIconNudge** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. The icon slides toward its side on hover (e.g. an arrow edges outward).

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**FaqWidget**

A `faq` widget: its `type` and its own fields. A field left out takes its default.

**type** `FaqWidgetType`

**Always sent.** The widget’s type: always `faq`. One of `faq`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**faqEyebrow** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Small label shown above the title.

**faqEyebrowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Overrides the eyebrow + its dash. Leave empty to use the secondary (mint) color.

**faqEyebrowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the mint default.

**faqEyebrowWeight** `FaqEyebrowWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**faqEyebrowSize** `FaqEyebrowSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**faqHeading** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional. Leave empty to show just the questions.

**faqHeadingColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to track the theme text color.

**faqHeadingColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**faqHeadingWeight** `FaqHeadingWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Heading weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**faqIntro** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional short sentence under the heading.

**faqIntroColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the muted text color.

**faqIntroColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**faqIntroWeight** `FaqIntroWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Intro weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**faqIntroSize** `FaqIntroSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Intro size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**faqAlign** `FaqAlign | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The Split layout always sets its header column left. One of `center`, `left`; a newer site may send others, so keep a fallback.

**faqFeaturedOnly** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Show only questions you have flagged “Featured” in the FAQs manager — e.g. a short top-questions block on the home page, linking out to the full FAQ page.

**faqCount** `number | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The most questions to show, in the manager’s sort order. Raise it for a full FAQ page. 1 to 50.

**faqCategories** `readonly Readonly\<Record\<string, unknown\>\>[]`

**Sometimes sent:** `undefined` when the site leaves it out. Optional filter. Leave empty to show questions from every category. Manage the list under FAQ Categories. The related `faq-category` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document; a document the site can’t find is left out.

**faqGroupBy** `FaqGroupBy | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. By category renders a subheading per FAQ category, in the order picked in the category filter (or, with no filter, the FAQ Categories sort order); questions without a category are listed last. One of `none`, `category`; a newer site may send others, so keep a fallback.

**faqLayout** `FaqLayout | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Accordion: a single centered column of collapsing questions — the classic FAQ. Split: the header (and button) sit in a left column with the accordion beside them. Two columns: the accordion flows across two columns. Open panels: every answer visible in a card grid — no collapsing. One of `accordion`, `split`, `columns`, `panels`; a newer site may send others, so keep a fallback.

**faqPanelColumns** `FaqPanelColumns | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. How many open panels sit per row (they stack on small screens). One of `1`, `2`, `3`; a newer site may send others, so keep a fallback.

**faqOpenMode** `FaqOpenMode | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. One at a time closes the previous answer when a new one opens; Independent lets visitors hold several open. One of `single`, `multiple`; a newer site may send others, so keep a fallback.

**faqFirstOpen** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Starts the section with the first answer expanded so the block never reads as an empty list of rows.

**faqMarker** `FaqMarker | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The disclosure marker on each question. Plus rotates into a close mark; Chevron flips. One of `plus`, `chevron`; a newer site may send others, so keep a fallback.

**faqGap** `FaqGap | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Space between questions. One of `tight`, `normal`, `roomy`; a newer site may send others, so keep a fallback.

**faqSchema** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Adds this section’s questions to the page’s schema.org FAQPage markup so search engines can read them (all FAQ sections on a page share one FAQPage block). Costs nothing when on; turn off only to exclude these questions.

**faqCardStyle** `FaqCardStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The question-row treatment. Plain (the default) is the classic divided list — hairlines between questions. Any other style turns each question into a card: Raised is a quiet lit card, Outline a framed row, Luxe frosted glass; Ticket/Bracket/Inlay are the graphic showstoppers. One of `raised`, `luxe`, `outline`, `plain`, `poster`, `edge`, `tint`, `ticket`, `bracket`, `forge`, `press`, `inlay`; a newer site may send others, so keep a fallback.

**faqCardStyleRadius** `FaqCardStyleRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner rounding for each card. Default keeps the widget’s own tuned corners — except Forge, which defaults to tight machined corners matching its engraved frame. One of `default`, `square`, `slight`, `rounded`, `large`; a newer site may send others, so keep a fallback.

**faqCardStyleAccentColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Colors the Spine rail, Bracket marks, Forge corner/frame and Press margin rule. Leave empty to use the brand accent.

**faqCardStyleAccentColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**faqCardStyleForgeScope** `FaqCardStyleForgeScope | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the Forge plate wears its color: a single corner mark (the machinist’s datum, default) or the whole engraved frame. One of `corner`, `frame`; a newer site may send others, so keep a fallback.

**faqCardStyleForgeWeight** `FaqCardStyleForgeWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Thickness of the Forge corner mark / colored frame. One of `fine`, `medium`, `bold`; a newer site may send others, so keep a fallback.

**faqCardHover** `FaqCardHover | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. What a question row does on hover. None (the default) keeps the accordion calm — the open/close motion is the interaction. The card effects (Lift/Glow/…) suit the card styles; the cursor-tracked ones need site animations on. One of `none`, `lift`, `pop`, `press`, `glow`, `border`, `sheen`, `tilt`, `magnetic`, `spotlight`; a newer site may send others, so keep a fallback.

**faqAccentColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — colors the toggle icon and the open question’s highlight. Leave empty to use the brand accent.

**faqAccentColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**faqQuestionSize** `FaqQuestionSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Question size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**faqQuestionWeight** `FaqQuestionWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Question weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**faqQuestionColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to track the theme text color.

**faqQuestionColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**faqAnswerSize** `FaqAnswerSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Answer size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**faqAnswerWeight** `FaqAnswerWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Answer weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**faqAnswerColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the muted text color.

**faqAnswerColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**faqGroupHeadingWeight** `FaqGroupHeadingWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Category heading weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**faqGroupHeadingColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to track the theme text color.

**faqGroupHeadingColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**faqBg** `FaqBg | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The section’s full-width background band in dark mode. Transparent lets the page background show through. The palette options track the site colors; choose “Custom color…” for a specific color. One of `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**faqBgCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (dark theme)” is set to Custom color.

**faqBgLight** `FaqBgLight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. “Match dark theme” reuses the dark-theme choice; otherwise set the light-mode band independently. One of `inherit`, `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**faqBgLightCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (light theme)” is set to Custom color.

**faqFontOverrides** `readonly FaqWidgetFaqFontOverridesItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `FaqWidgetFaqFontOverridesItem`. Optional. Set part of this section in a different typeface. Leave empty to follow the site’s fonts (Site design → Typography). At most 4 items.

**FaqWidgetFaqFontOverridesItem**

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**target** `Target | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which text this typeface replaces. Rows apply in order, so a broad row (Everything) followed by a narrow one (Headings) gives the section a base face plus an exception. One of `all`, `heading`, `body`, `eyebrow`, `button`, `code`; a newer site may send others, so keep a fallback.

**source** `Source | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the typeface comes from. The first option costs nothing extra — those faces are already loaded. The others load an additional font on pages that use this section. One of `slot`, `curated`, `cdn`, `upload`; a newer site may send others, so keep a fallback.

**slot** `Slot | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Set in Site design → Typography. Following the site’s own faces keeps a section on-brand and adds no download. One of `display`, `body`, `accent`; a newer site may send others, so keep a fallback.

**curated** `Curated | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Vetted families from Bunny Fonts and Fontshare, with their available weights already verified. One of `archivo`, `bricolage-grotesque`, `clash-display`, `courier-prime`, `dm-mono`, `dm-sans`, `fira-code`, `fraunces`, `general-sans`, `ibm-plex-mono`, `ibm-plex-sans`, `inconsolata`, `inter`, `jetbrains-mono`, `karla`, `lora`, `manrope`, `nunito-sans`, `outfit`, `playfair-display`, `public-sans`, `red-hat-mono`, `satoshi`, `sentient`, `sora`, `source-code-pro`, `source-sans-3`, `source-serif-4`, `space-grotesk`, `space-mono`, `spline-sans-mono`, `supreme`, `switzer`, `syne`, `ubuntu-mono`, `unbounded`, `victor-mono`, `work-sans`, `zodiak`; a newer site may send others, so keep a fallback.

**cdnProvider** `CdnProvider | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where to browse for the family. Pick one, then follow the link below to find the exact name. One of `bunny`, `fontshare`; a newer site may send others, so keep a fallback.

**cdnFamily** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Exactly as the provider’s catalog spells it, e.g. "Space Grotesk" or "Clash Display". A name the provider doesn’t have loads nothing and this row is ignored.

**cdnWeights** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 500, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold) — but a family that ships only ONE weight (Acme, for instance) loads nothing at all unless that weight is among these, so set it explicitly if the typeface doesn’t appear.

**uploads** `readonly FaqWidgetFaqFontOverridesItemUploadsItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `FaqWidgetFaqFontOverridesItemUploadsItem`. One file per weight/style of the SAME typeface. woff2 strongly recommended (smallest, universally supported); woff/ttf/otf also accepted. At most 4 items.

**FaqWidgetFaqFontOverridesItemUploadsItem**

**file** `Readonly\<Record\<string, unknown\>\>`

**Always sent.** File attachment reference.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**weight** `Weight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Weight. One of `100`, `200`, `300`, `400`, `500`, `600`, `700`, `800`, `900`; a newer site may send others, so keep a fallback.

**style** `Style | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Style. One of `normal`, `italic`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**fallback** `Fallback | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Generic system font shown while this typeface loads (and if it fails). Curated picks set this automatically. One of `sans`, `serif`, `mono`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**faqCtaLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The visible button text. Leave empty to hide the button.

**faqCtaUrl** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Where the button goes — a path (/blog) or full URL.

**faqCtaNewTab** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Opens the link in a new browser tab (adds rel="noopener noreferrer").

**faqCtaVariant** `FaqCtaVariant | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fills with the color; Outline / Soft / Text link use it for the border + text. One of `solid`, `outline`, `soft`, `link`; a newer site may send others, so keep a fallback.

**faqCtaSize** `FaqCtaSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Button size. One of `small`, `normal`, `large`; a newer site may send others, so keep a fallback.

**faqCtaRadius** `FaqCtaRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner radius. One of `pill`, `rounded`, `slight`, `square`; a newer site may send others, so keep a fallback.

**faqCtaColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fill, or the border + text for the other styles. Defaults to the brand accent; CLEAR it for a transparent, outline-only button.

**faqCtaColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color. (Brand tokens already flip per theme.)

**faqCtaTextColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The text/icon color. Clear it to derive from the button color (readable on solid fills).

**faqCtaTextColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme label color.

**faqCtaHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Drives the hover treatment. Leave empty to derive it from the button color.

**faqCtaHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme hover color.

**faqCtaStyle** `FaqCtaStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The hover treatment: a soft shadow, a colored offset shadow, a glow, a fill sweep, or a thicker border. One of `none`, `single`, `dual`, `glow`, `sweep`, `thicken`; a newer site may send others, so keep a fallback.

**faqCtaShadowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. The offset-shadow or glow color on hover. Leave empty to use the site secondary color.

**faqCtaShadowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme shadow color.

**faqCtaAnimation** `FaqCtaAnimation | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Hover motion. One of `lift`, `scale`, `lift-scale`, `none`; a newer site may send others, so keep a fallback.

**faqCtaIcon** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.

**faqCtaIconFamily** `FaqCtaIconFamily | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon family. One of `classic-regular`, `duotone-regular`, `brands`, `jelly`, `jelly-duo`, `whiteboard`; a newer site may send others, so keep a fallback.

**faqCtaIconPosition** `FaqCtaIconPosition | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which side of the label the icon sits on (when an icon name is set). One of `before`, `after`; a newer site may send others, so keep a fallback.

**faqCtaIconNudge** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. The icon slides toward its side on hover (e.g. an arrow edges outward).

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**afterContent** `AfterContentArea`

**Sometimes sent:** `undefined` when the site leaves it out. An `AfterContentArea`. Widgets, top to bottom: send `{ "items": [ … ] }`, one object per widget with its `type`. Writing it replaces the whole area.

**AfterContentArea**

**metaType** `AfterContentAreaMetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `area`. One of `area`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The area’s id, set by the site: leave it out when you write one.

**items** `readonly AfterContentAreaItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `AfterContentAreaItem`. The widgets, top to bottom. Each is an object with its `type` and that widget’s own fields; `_id` and `metaType` may be left out (the site sets them).

**AfterContentAreaItem**

A widget in an area that takes `@apostrophecms/layout`, `intro`, `feature`, `stats`, `logos`, `steps`, `media-text`, `device-mock`, `team`, `faq`, `service-map`, `blog-preview`, `cookie-declaration`, `@apostrophecms/rich-text`, `pricing`, `newsletter`, `sms-signup`, `form-render`, `final-cta`: the one its `type` names.

**LayoutWidget**

A `@apostrophecms/layout` widget: its `type` and its own fields. A field left out takes its default.

**type** `LayoutWidgetType`

**Always sent.** The widget’s type: always `@apostrophecms/layout`. One of `@apostrophecms/layout`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**columns** `LayoutColumnArea`

**Sometimes sent:** `undefined` when the site leaves it out. A `LayoutColumnArea`. Widgets, top to bottom: send `{ "items": [ … ] }`, one object per widget with its `type`. Writing it replaces the whole area. Its fields are listed under the first `LayoutColumnArea` above.

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**IntroWidget**

A `intro` widget: its `type` and its own fields. A field left out takes its default.

**type** `IntroWidgetType`

**Always sent.** The widget’s type: always `intro`. One of `intro`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**introEyebrow** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Small label shown above the title.

**introEyebrowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Overrides the eyebrow + its dash. Leave empty to use the secondary (mint) color.

**introEyebrowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the mint default.

**introEyebrowWeight** `IntroEyebrowWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**introEyebrowSize** `IntroEyebrowSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**introHeadline** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Headline.

**introHeadlineColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Overrides the headline color. Leave empty to track the theme’s text color.

**introHeadlineColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the theme default.

**introHeadlineWeight** `IntroHeadlineWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Headline weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**introBody** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Body copy.

**introBodyColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Overrides the body text color. Leave empty for the muted default.

**introBodyColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the muted default.

**introBodyWeight** `IntroBodyWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Body weight. One of `normal`, `medium`, `semibold`, `bold`; a newer site may send others, so keep a fallback.

**introPhotoPlacement** `IntroPhotoPlacement | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the optional photo sits. Left/right place it beside the text; Full background fills the whole section behind the text (with a readability overlay). One of `none`, `left`, `right`, `background`; a newer site may send others, so keep a fallback.

**introImage** `ImageArea`

**Sometimes sent:** `undefined` when the site leaves it out. An `ImageArea`. Widgets, top to bottom: send `{ "items": [ … ] }`, one object per widget with its `type`. Writing it replaces the whole area. Its fields are listed under the first `ImageArea` above.

**introPhotoCorners** `IntroPhotoCorners | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Photo corners. One of `rounded`, `squared`; a newer site may send others, so keep a fallback.

**introPhotoFrame** `IntroPhotoFrame | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Border draws a frame around the photo; Offset adds a refined offset accent frame behind it. One of `none`, `border`, `offset`; a newer site may send others, so keep a fallback.

**introPhotoFrameColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Border / offset-frame color. Leave empty to use the site accent color.

**introPhotoTilt** `IntroPhotoTilt | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A slight rotation for a more playful look. One of `none`, `left`, `right`; a newer site may send others, so keep a fallback.

**introPhotoHover** `IntroPhotoHover | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Photo hover effect. One of `none`, `lift`, `zoom`, `tilt`, `glow`, `lift-glow`, `zoom-glow`; a newer site may send others, so keep a fallback.

**introOverlayColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Scrim behind the text over a full-background photo. Leave empty to use the dark surface color.

**introOverlayColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme overlay, then the light surface color.

**introOverlayOpacity** `number | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Overlay opacity (%). 0 to 100.

**introBg** `IntroBg | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The section’s full-width background band in dark mode. Transparent lets the page background show through. The palette options track the site colors; choose “Custom color…” for a specific color. One of `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**introBgCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (dark theme)” is set to Custom color.

**introBgLight** `IntroBgLight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. “Match dark theme” reuses the dark-theme choice; otherwise set the light-mode band independently. One of `inherit`, `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**introBgLightCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (light theme)” is set to Custom color.

**introFontOverrides** `readonly IntroWidgetIntroFontOverridesItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `IntroWidgetIntroFontOverridesItem`. Optional. Set part of this section in a different typeface. Leave empty to follow the site’s fonts (Site design → Typography). At most 4 items. Its fields are listed under the first `IntroWidgetIntroFontOverridesItem` above.

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**FeatureWidget**

A `feature` widget: its `type` and its own fields. A field left out takes its default.

**type** `FeatureWidgetType`

**Always sent.** The widget’s type: always `feature`. One of `feature`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**featureColumns** `FeatureColumns | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Auto fits as many as comfortably fit and works for any number of cards. Or lock a maximum per row. One of `auto`, `2`, `3`, `4`; a newer site may send others, so keep a fallback.

**featureGap** `FeatureGap | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Gap between cards. One of `tight`, `normal`, `roomy`; a newer site may send others, so keep a fallback.

**featureCardSize** `FeatureCardSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Scales padding, icon, title, and the index numeral together. One of `small`, `medium`, `large`; a newer site may send others, so keep a fallback.

**featureCardStyle** `FeatureCardStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The card treatment. Poster (the default) frames the card with an accent keyline; Raised is a quiet lit card; Luxe a frosted glass panel; Spine adds a color rail; Tint an accent wash; Ticket/Bracket/Forge/Press/Inlay are the graphic showstoppers. One of `raised`, `luxe`, `outline`, `plain`, `poster`, `edge`, `tint`, `ticket`, `bracket`, `forge`, `press`, `inlay`; a newer site may send others, so keep a fallback.

**featureCardStyleRadius** `FeatureCardStyleRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner rounding for each card. Default keeps the widget’s own tuned corners — except Forge, which defaults to tight machined corners matching its engraved frame. One of `default`, `square`, `slight`, `rounded`, `large`; a newer site may send others, so keep a fallback.

**featureCardStyleAccentColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Colors the Spine rail, Bracket marks, Forge corner/frame and Press margin rule. Leave empty to use the brand accent.

**featureCardStyleAccentColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**featureCardStyleForgeScope** `FeatureCardStyleForgeScope | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the Forge plate wears its color: a single corner mark (the machinist’s datum, default) or the whole engraved frame. One of `corner`, `frame`; a newer site may send others, so keep a fallback.

**featureCardStyleForgeWeight** `FeatureCardStyleForgeWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Thickness of the Forge corner mark / colored frame. One of `fine`, `medium`, `bold`; a newer site may send others, so keep a fallback.

**featureCardHover** `FeatureCardHover | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. How a card reacts on hover. Pop is the lift + hard offset shadow; Glow is a soft accent halo. One of `none`, `lift`, `pop`, `glow`, `border`; a newer site may send others, so keep a fallback.

**featureCardHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Border / shadow / glow color on hover. Leave empty to use the site accent color.

**featureCardHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the accent.

**featureNumbering** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. A big outlined numeral on each card (01, 02, …). Great for step-by-step sequences; turn off when the cards aren’t ordered.

**featureNumberFill** `FeatureNumberFill | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Same treatment as the hero ghost text: all numbers solid, outlined and filling on hover, or always outlined. One of `solid`, `hover`, `outline`; a newer site may send others, so keep a fallback.

**featureNumberColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Tints the numeral fill + outline. Leave empty to track the theme’s text color.

**featureNumberColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the theme default.

**featureTitleColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Overrides the card title color. Leave empty to track the theme’s text color.

**featureTitleColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the theme default.

**featureTitleWeight** `FeatureTitleWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Title weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**featureTextColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Overrides the card text color. Leave empty for the muted default.

**featureTextColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the muted default.

**featureTextWeight** `FeatureTextWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Text weight. One of `normal`, `medium`, `semibold`, `bold`; a newer site may send others, so keep a fallback.

**featureCards** `readonly FeatureWidgetFeatureCardsItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `FeatureWidgetFeatureCardsItem`. Feature cards. Its fields are listed under the first `FeatureWidgetFeatureCardsItem` above.

**featureBg** `FeatureBg | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The section’s full-width background band in dark mode. Transparent lets the page background show through. The palette options track the site colors; choose “Custom color…” for a specific color. One of `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**featureBgCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (dark theme)” is set to Custom color.

**featureBgLight** `FeatureBgLight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. “Match dark theme” reuses the dark-theme choice; otherwise set the light-mode band independently. One of `inherit`, `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**featureBgLightCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (light theme)” is set to Custom color.

**featureFontOverrides** `readonly FeatureWidgetFeatureFontOverridesItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `FeatureWidgetFeatureFontOverridesItem`. Optional. Set part of this section in a different typeface. Leave empty to follow the site’s fonts (Site design → Typography). At most 4 items. Its fields are listed under the first `FeatureWidgetFeatureFontOverridesItem` above.

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**StatsWidget**

A `stats` widget: its `type` and its own fields. A field left out takes its default.

**type** `StatsWidgetType`

**Always sent.** The widget’s type: always `stats`. One of `stats`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**statsEyebrowEnabled** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. A small label above the heading (e.g. "By the numbers").

**statsEyebrow** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Eyebrow.

**statsEyebrowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the secondary (mint) color.

**statsEyebrowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**statsEyebrowWeight** `StatsEyebrowWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**statsEyebrowSize** `StatsEyebrowSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**statsHeading** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional. Leave empty to show just the numbers.

**statsHeadingColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to track the theme text color.

**statsHeadingColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**statsHeadingWeight** `StatsHeadingWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Heading weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**statsColumns** `StatsColumns | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Auto fits as many as comfortably fit and works for any number of stats. Or lock a maximum per row. One of `auto`, `2`, `3`, `4`; a newer site may send others, so keep a fallback.

**statsGap** `StatsGap | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Gap between stats. One of `tight`, `normal`, `roomy`; a newer site may send others, so keep a fallback.

**statsSize** `StatsSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The baseline scale for the whole stat (value / icon / label / description stay proportional). Fine-tune any single element with its own size control below. One of `small`, `medium`, `large`; a newer site may send others, so keep a fallback.

**statsAlign** `StatsAlign | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Alignment. One of `center`, `left`; a newer site may send others, so keep a fallback.

**statsDividers** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. A hairline rule between each stat — the classic "by the numbers" rail.

**statsCountUp** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Numbers tick up from zero when the band scrolls into view. Non-numeric values and reduced-motion visitors simply show the final value.

**statsIconSize** `StatsIconSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Size of the icon above each number, independent of the overall stat size. One of `auto`, `sm`, `md`, `lg`, `xl`, `xxl`; a newer site may send others, so keep a fallback.

**statsIconGap** `StatsIconGap | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Space between the icon and the number below it. One of `tight`, `normal`, `roomy`; a newer site may send others, so keep a fallback.

**statsValueSize** `StatsValueSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Value size. One of `auto`, `xs`, `sm`, `md`, `lg`, `xl`; a newer site may send others, so keep a fallback.

**statsValueWeight** `StatsValueWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Value weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**statsValueColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The big numeral. Optional — leave empty to use the site accent color.

**statsValueColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the accent.

**statsLabelSize** `StatsLabelSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Label size. One of `auto`, `xs`, `sm`, `md`, `lg`, `xl`; a newer site may send others, so keep a fallback.

**statsLabelWeight** `StatsLabelWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Label weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**statsLabelColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to track the theme text color.

**statsLabelColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**statsDescriptionSize** `StatsDescriptionSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Description size. One of `auto`, `xs`, `sm`, `md`, `lg`, `xl`; a newer site may send others, so keep a fallback.

**statsDescriptionWeight** `StatsDescriptionWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Description weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**statsDescriptionColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the muted text color.

**statsDescriptionColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**stats** `readonly StatsWidgetStatsItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `StatsWidgetStatsItem`. Stats. Its fields are listed under the first `StatsWidgetStatsItem` above.

**statsBg** `StatsBg | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The section’s full-width background band in dark mode. Transparent lets the page background show through. The palette options track the site colors; choose “Custom color…” for a specific color. One of `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**statsBgCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (dark theme)” is set to Custom color.

**statsBgLight** `StatsBgLight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. “Match dark theme” reuses the dark-theme choice; otherwise set the light-mode band independently. One of `inherit`, `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**statsBgLightCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (light theme)” is set to Custom color.

**statsFontOverrides** `readonly StatsWidgetStatsFontOverridesItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `StatsWidgetStatsFontOverridesItem`. Optional. Set part of this section in a different typeface. Leave empty to follow the site’s fonts (Site design → Typography). At most 4 items. Its fields are listed under the first `StatsWidgetStatsFontOverridesItem` above.

**statsCtaLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The visible button text. Leave empty to hide the button.

**statsCtaUrl** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Where the button goes — a path (/blog) or full URL.

**statsCtaNewTab** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Opens the link in a new browser tab (adds rel="noopener noreferrer").

**statsCtaVariant** `StatsCtaVariant | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fills with the color; Outline / Soft / Text link use it for the border + text. One of `solid`, `outline`, `soft`, `link`; a newer site may send others, so keep a fallback.

**statsCtaSize** `StatsCtaSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Button size. One of `small`, `normal`, `large`; a newer site may send others, so keep a fallback.

**statsCtaRadius** `StatsCtaRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner radius. One of `pill`, `rounded`, `slight`, `square`; a newer site may send others, so keep a fallback.

**statsCtaColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fill, or the border + text for the other styles. Defaults to the brand accent; CLEAR it for a transparent, outline-only button.

**statsCtaColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color. (Brand tokens already flip per theme.)

**statsCtaTextColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The text/icon color. Clear it to derive from the button color (readable on solid fills).

**statsCtaTextColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme label color.

**statsCtaHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Drives the hover treatment. Leave empty to derive it from the button color.

**statsCtaHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme hover color.

**statsCtaStyle** `StatsCtaStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The hover treatment: a soft shadow, a colored offset shadow, a glow, a fill sweep, or a thicker border. One of `none`, `single`, `dual`, `glow`, `sweep`, `thicken`; a newer site may send others, so keep a fallback.

**statsCtaShadowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. The offset-shadow or glow color on hover. Leave empty to use the site secondary color.

**statsCtaShadowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme shadow color.

**statsCtaAnimation** `StatsCtaAnimation | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Hover motion. One of `lift`, `scale`, `lift-scale`, `none`; a newer site may send others, so keep a fallback.

**statsCtaIcon** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.

**statsCtaIconFamily** `StatsCtaIconFamily | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon family. One of `classic-regular`, `duotone-regular`, `brands`, `jelly`, `jelly-duo`, `whiteboard`; a newer site may send others, so keep a fallback.

**statsCtaIconPosition** `StatsCtaIconPosition | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which side of the label the icon sits on (when an icon name is set). One of `before`, `after`; a newer site may send others, so keep a fallback.

**statsCtaIconNudge** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. The icon slides toward its side on hover (e.g. an arrow edges outward).

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**LogosWidget**

A `logos` widget: its `type` and its own fields. A field left out takes its default.

**type** `LogosWidgetType`

**Always sent.** The widget’s type: always `logos`. One of `logos`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**logosEyebrowEnabled** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. A small label above the heading (e.g. "Trusted by").

**logosEyebrow** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Eyebrow.

**logosEyebrowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the secondary (mint) color.

**logosEyebrowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**logosEyebrowWeight** `LogosEyebrowWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**logosEyebrowSize** `LogosEyebrowSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**logosHeading** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional. Leave empty to show just the logos.

**logosHeadingColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to track the theme text color.

**logosHeadingColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**logosHeadingWeight** `LogosHeadingWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Heading weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**logosIntro** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional short sentence under the heading.

**logosIntroColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the muted text color.

**logosIntroColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**logosIntroWeight** `LogosIntroWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Intro weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**logosDisplay** `LogosDisplay | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A slow scrolling ribbon (marquee) or a calm static grid. One of `marquee`, `grid`; a newer site may send others, so keep a fallback.

**logosSpeed** `LogosSpeed | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Marquee speed. One of `slow`, `normal`, `fast`; a newer site may send others, so keep a fallback.

**logosDirection** `LogosDirection | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Marquee direction. One of `left`, `right`; a newer site may send others, so keep a fallback.

**logosMotionPause** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Adds a small, unobtrusive pause/play control so visitors can stop the auto-playing background motion (WCAG 2.2.2). Only appears when a moving background is set.

**logosColumns** `LogosColumns | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Auto fits as many as comfortably fit and works for any number of logos. Or lock a maximum per row. One of `auto`, `3`, `4`, `5`, `6`; a newer site may send others, so keep a fallback.

**logosGap** `LogosGap | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Gap between logos. One of `tight`, `normal`, `roomy`; a newer site may send others, so keep a fallback.

**logosSize** `LogosSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The height each logo is scaled to (width follows the logo’s aspect ratio). One of `small`, `medium`, `large`; a newer site may send others, so keep a fallback.

**logosAlign** `LogosAlign | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Aligns the eyebrow / heading / intro (and the grid when there are few logos). One of `center`, `left`; a newer site may send others, so keep a fallback.

**logosTile** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Sets every logo on a raised, bordered card. Off = logos sit straight on the background.

**logosGrayscale** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Mutes the logos to grayscale and dims them, returning to full color on hover — the classic logo-wall look.

**logos** `readonly LogosWidgetLogosItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `LogosWidgetLogosItem`. Logos.

**LogosWidgetLogosItem**

**image** `readonly Readonly\<Record\<string, unknown\>\>[]`

**Always sent.** Pick a logo from the Images library. A transparent PNG or an SVG works best. The related `@apostrophecms/image` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.

**name** `string`

**Always sent.** Company / partner / certification name — used as the image alt text and the link title.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**linkUrl** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Make this logo a link, e.g. to the partner’s site. Opens in a new tab for external URLs.

**invertDark** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. For dark / black logos that would vanish on the dark theme — flips them to light. Leave off for full-color or white logos.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**logosBg** `LogosBg | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The section’s full-width background band in dark mode. Transparent lets the page background show through. The palette options track the site colors; choose “Custom color…” for a specific color. One of `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**logosBgCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (dark theme)” is set to Custom color.

**logosBgLight** `LogosBgLight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. “Match dark theme” reuses the dark-theme choice; otherwise set the light-mode band independently. One of `inherit`, `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**logosBgLightCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (light theme)” is set to Custom color.

**logosFontOverrides** `readonly LogosWidgetLogosFontOverridesItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `LogosWidgetLogosFontOverridesItem`. Optional. Set part of this section in a different typeface. Leave empty to follow the site’s fonts (Site design → Typography). At most 4 items.

**LogosWidgetLogosFontOverridesItem**

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**target** `Target | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which text this typeface replaces. Rows apply in order, so a broad row (Everything) followed by a narrow one (Headings) gives the section a base face plus an exception. One of `all`, `heading`, `body`, `eyebrow`, `button`, `code`; a newer site may send others, so keep a fallback.

**source** `Source | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the typeface comes from. The first option costs nothing extra — those faces are already loaded. The others load an additional font on pages that use this section. One of `slot`, `curated`, `cdn`, `upload`; a newer site may send others, so keep a fallback.

**slot** `Slot | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Set in Site design → Typography. Following the site’s own faces keeps a section on-brand and adds no download. One of `display`, `body`, `accent`; a newer site may send others, so keep a fallback.

**curated** `Curated | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Vetted families from Bunny Fonts and Fontshare, with their available weights already verified. One of `archivo`, `bricolage-grotesque`, `clash-display`, `courier-prime`, `dm-mono`, `dm-sans`, `fira-code`, `fraunces`, `general-sans`, `ibm-plex-mono`, `ibm-plex-sans`, `inconsolata`, `inter`, `jetbrains-mono`, `karla`, `lora`, `manrope`, `nunito-sans`, `outfit`, `playfair-display`, `public-sans`, `red-hat-mono`, `satoshi`, `sentient`, `sora`, `source-code-pro`, `source-sans-3`, `source-serif-4`, `space-grotesk`, `space-mono`, `spline-sans-mono`, `supreme`, `switzer`, `syne`, `ubuntu-mono`, `unbounded`, `victor-mono`, `work-sans`, `zodiak`; a newer site may send others, so keep a fallback.

**cdnProvider** `CdnProvider | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where to browse for the family. Pick one, then follow the link below to find the exact name. One of `bunny`, `fontshare`; a newer site may send others, so keep a fallback.

**cdnFamily** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Exactly as the provider’s catalog spells it, e.g. "Space Grotesk" or "Clash Display". A name the provider doesn’t have loads nothing and this row is ignored.

**cdnWeights** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 500, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold) — but a family that ships only ONE weight (Acme, for instance) loads nothing at all unless that weight is among these, so set it explicitly if the typeface doesn’t appear.

**uploads** `readonly LogosWidgetLogosFontOverridesItemUploadsItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `LogosWidgetLogosFontOverridesItemUploadsItem`. One file per weight/style of the SAME typeface. woff2 strongly recommended (smallest, universally supported); woff/ttf/otf also accepted. At most 4 items.

**LogosWidgetLogosFontOverridesItemUploadsItem**

**file** `Readonly\<Record\<string, unknown\>\>`

**Always sent.** File attachment reference.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**weight** `Weight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Weight. One of `100`, `200`, `300`, `400`, `500`, `600`, `700`, `800`, `900`; a newer site may send others, so keep a fallback.

**style** `Style | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Style. One of `normal`, `italic`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**fallback** `Fallback | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Generic system font shown while this typeface loads (and if it fails). Curated picks set this automatically. One of `sans`, `serif`, `mono`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**logosCtaLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The visible button text. Leave empty to hide the button.

**logosCtaUrl** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Where the button goes — a path (/blog) or full URL.

**logosCtaNewTab** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Opens the link in a new browser tab (adds rel="noopener noreferrer").

**logosCtaVariant** `LogosCtaVariant | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fills with the color; Outline / Soft / Text link use it for the border + text. One of `solid`, `outline`, `soft`, `link`; a newer site may send others, so keep a fallback.

**logosCtaSize** `LogosCtaSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Button size. One of `small`, `normal`, `large`; a newer site may send others, so keep a fallback.

**logosCtaRadius** `LogosCtaRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner radius. One of `pill`, `rounded`, `slight`, `square`; a newer site may send others, so keep a fallback.

**logosCtaColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fill, or the border + text for the other styles. Defaults to the brand accent; CLEAR it for a transparent, outline-only button.

**logosCtaColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color. (Brand tokens already flip per theme.)

**logosCtaTextColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The text/icon color. Clear it to derive from the button color (readable on solid fills).

**logosCtaTextColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme label color.

**logosCtaHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Drives the hover treatment. Leave empty to derive it from the button color.

**logosCtaHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme hover color.

**logosCtaStyle** `LogosCtaStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The hover treatment: a soft shadow, a colored offset shadow, a glow, a fill sweep, or a thicker border. One of `none`, `single`, `dual`, `glow`, `sweep`, `thicken`; a newer site may send others, so keep a fallback.

**logosCtaShadowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. The offset-shadow or glow color on hover. Leave empty to use the site secondary color.

**logosCtaShadowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme shadow color.

**logosCtaAnimation** `LogosCtaAnimation | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Hover motion. One of `lift`, `scale`, `lift-scale`, `none`; a newer site may send others, so keep a fallback.

**logosCtaIcon** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.

**logosCtaIconFamily** `LogosCtaIconFamily | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon family. One of `classic-regular`, `duotone-regular`, `brands`, `jelly`, `jelly-duo`, `whiteboard`; a newer site may send others, so keep a fallback.

**logosCtaIconPosition** `LogosCtaIconPosition | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which side of the label the icon sits on (when an icon name is set). One of `before`, `after`; a newer site may send others, so keep a fallback.

**logosCtaIconNudge** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. The icon slides toward its side on hover (e.g. an arrow edges outward).

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**StepsWidget**

A `steps` widget: its `type` and its own fields. A field left out takes its default.

**type** `StepsWidgetType`

**Always sent.** The widget’s type: always `steps`. One of `steps`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**stepsEyebrowEnabled** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. A small label above the heading (e.g. "How it works").

**stepsEyebrow** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Eyebrow.

**stepsEyebrowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the secondary (mint) color.

**stepsEyebrowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**stepsEyebrowWeight** `StepsEyebrowWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**stepsEyebrowSize** `StepsEyebrowSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**stepsHeading** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional. Leave empty to show just the steps.

**stepsHeadingColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to track the theme text color.

**stepsHeadingColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**stepsHeadingWeight** `StepsHeadingWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Heading weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**stepsHeadingSize** `StepsHeadingSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Heading size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**stepsIntro** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional short sentence under the heading.

**stepsIntroColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the muted text color.

**stepsIntroColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**stepsIntroWeight** `StepsIntroWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Intro weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**stepsIntroSize** `StepsIntroSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Intro size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**stepsLayout** `StepsLayout | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Horizontal lays the steps across a row (marker on top); Vertical stacks them as a classic timeline (marker on the left). One of `horizontal`, `vertical`; a newer site may send others, so keep a fallback.

**stepsColumns** `StepsColumns | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Horizontal only. Auto fits as many as comfortably fit and works for any number of steps. Or lock a maximum per row. One of `auto`, `2`, `3`, `4`; a newer site may send others, so keep a fallback.

**stepsGap** `StepsGap | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Gap between steps. One of `tight`, `normal`, `roomy`; a newer site may send others, so keep a fallback.

**stepsAlign** `StepsAlign | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Horizontal only — aligns the section header and each step’s text. (Vertical is always left-aligned beside its marker.) One of `center`, `left`; a newer site may send others, so keep a fallback.

**stepsConnector** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. A line linking the step markers into a timeline (down the markers when vertical, across them when horizontal).

**stepsCardStyle** `StepsCardStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Plain keeps the connector-linked timeline (just marker + text, no card). Every other style boxes each step — Raised is a quiet lit card, Luxe a frosted glass panel, Outline a plaque frame, Spine adds a color rail, Tint an accent wash; Ticket/Bracket/Forge/Press/Inlay are the graphic showstoppers. One of `raised`, `luxe`, `outline`, `plain`, `poster`, `edge`, `tint`, `ticket`, `bracket`, `forge`, `press`, `inlay`; a newer site may send others, so keep a fallback.

**stepsCardStyleRadius** `StepsCardStyleRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner rounding for each card. Default keeps the widget’s own tuned corners — except Forge, which defaults to tight machined corners matching its engraved frame. One of `default`, `square`, `slight`, `rounded`, `large`; a newer site may send others, so keep a fallback.

**stepsCardStyleAccentColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Colors the Spine rail, Bracket marks, Forge corner/frame and Press margin rule. Leave empty to use the brand accent.

**stepsCardStyleAccentColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**stepsCardStyleForgeScope** `StepsCardStyleForgeScope | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the Forge plate wears its color: a single corner mark (the machinist’s datum, default) or the whole engraved frame. One of `corner`, `frame`; a newer site may send others, so keep a fallback.

**stepsCardStyleForgeWeight** `StepsCardStyleForgeWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Thickness of the Forge corner mark / colored frame. One of `fine`, `medium`, `bold`; a newer site may send others, so keep a fallback.

**stepsCardHover** `StepsCardHover | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. What a boxed step does on hover (applies when Step style is not Plain). Lift/Pop/Press/Glow/Outline are instant; Sheen sweeps a light across; Tilt, Magnetic and Spotlight follow the cursor (need site animations on). One of `none`, `lift`, `pop`, `press`, `glow`, `border`, `sheen`, `tilt`, `magnetic`, `spotlight`; a newer site may send others, so keep a fallback.

**stepsMarker** `StepsMarker | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Number auto-counts 1, 2, 3…; Icon shows each step’s icon (falling back to the number when a step has none); None hides the marker badge. One of `number`, `icon`, `none`; a newer site may send others, so keep a fallback.

**stepsMarkerStyle** `StepsMarkerStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Soft is a tinted accent badge; Filled is a solid accent badge; Outline is a bordered badge. One of `soft`, `filled`, `outline`; a newer site may send others, so keep a fallback.

**stepsMarkerShape** `StepsMarkerShape | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Marker shape. One of `circle`, `rounded`, `square`; a newer site may send others, so keep a fallback.

**stepsMarkerSize** `StepsMarkerSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Marker size. One of `small`, `medium`, `large`; a newer site may send others, so keep a fallback.

**stepsAccentColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Color for the marker badge and the connector line. Leave empty to use the site accent color.

**stepsAccentColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme accent.

**stepsTitleSize** `StepsTitleSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Title size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**stepsTitleWeight** `StepsTitleWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Title weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**stepsTitleColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to track the theme text color.

**stepsTitleColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**stepsBodySize** `StepsBodySize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Body size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**stepsBodyWeight** `StepsBodyWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Body weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**stepsBodyColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the muted text color.

**stepsBodyColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**stepsItems** `readonly StepsWidgetStepsItemsItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `StepsWidgetStepsItemsItem`. Each item is one step in the process. They render in this order; the number marker counts automatically. Its fields are listed under the first `StepsWidgetStepsItemsItem` above.

**stepsBg** `StepsBg | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The section’s full-width background band in dark mode. Transparent lets the page background show through. The palette options track the site colors; choose “Custom color…” for a specific color. One of `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**stepsBgCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (dark theme)” is set to Custom color.

**stepsBgLight** `StepsBgLight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. “Match dark theme” reuses the dark-theme choice; otherwise set the light-mode band independently. One of `inherit`, `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**stepsBgLightCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (light theme)” is set to Custom color.

**stepsFontOverrides** `readonly StepsWidgetStepsFontOverridesItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `StepsWidgetStepsFontOverridesItem`. Optional. Set part of this section in a different typeface. Leave empty to follow the site’s fonts (Site design → Typography). At most 4 items. Its fields are listed under the first `StepsWidgetStepsFontOverridesItem` above.

**stepsCtaLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The visible button text. Leave empty to hide the button.

**stepsCtaUrl** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Where the button goes — a path (/blog) or full URL.

**stepsCtaNewTab** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Opens the link in a new browser tab (adds rel="noopener noreferrer").

**stepsCtaVariant** `StepsCtaVariant | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fills with the color; Outline / Soft / Text link use it for the border + text. One of `solid`, `outline`, `soft`, `link`; a newer site may send others, so keep a fallback.

**stepsCtaSize** `StepsCtaSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Button size. One of `small`, `normal`, `large`; a newer site may send others, so keep a fallback.

**stepsCtaRadius** `StepsCtaRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner radius. One of `pill`, `rounded`, `slight`, `square`; a newer site may send others, so keep a fallback.

**stepsCtaColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fill, or the border + text for the other styles. Defaults to the brand accent; CLEAR it for a transparent, outline-only button.

**stepsCtaColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color. (Brand tokens already flip per theme.)

**stepsCtaTextColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The text/icon color. Clear it to derive from the button color (readable on solid fills).

**stepsCtaTextColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme label color.

**stepsCtaHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Drives the hover treatment. Leave empty to derive it from the button color.

**stepsCtaHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme hover color.

**stepsCtaStyle** `StepsCtaStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The hover treatment: a soft shadow, a colored offset shadow, a glow, a fill sweep, or a thicker border. One of `none`, `single`, `dual`, `glow`, `sweep`, `thicken`; a newer site may send others, so keep a fallback.

**stepsCtaShadowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. The offset-shadow or glow color on hover. Leave empty to use the site secondary color.

**stepsCtaShadowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme shadow color.

**stepsCtaAnimation** `StepsCtaAnimation | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Hover motion. One of `lift`, `scale`, `lift-scale`, `none`; a newer site may send others, so keep a fallback.

**stepsCtaIcon** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.

**stepsCtaIconFamily** `StepsCtaIconFamily | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon family. One of `classic-regular`, `duotone-regular`, `brands`, `jelly`, `jelly-duo`, `whiteboard`; a newer site may send others, so keep a fallback.

**stepsCtaIconPosition** `StepsCtaIconPosition | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which side of the label the icon sits on (when an icon name is set). One of `before`, `after`; a newer site may send others, so keep a fallback.

**stepsCtaIconNudge** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. The icon slides toward its side on hover (e.g. an arrow edges outward).

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**MediaTextWidget**

A `media-text` widget: its `type` and its own fields. A field left out takes its default.

**type** `MediaTextWidgetType`

**Always sent.** The widget’s type: always `media-text`. One of `media-text`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**mediaTextEyebrowEnabled** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. A small label above the section heading (e.g. "Why us").

**mediaTextEyebrow** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Eyebrow.

**mediaTextEyebrowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the secondary (mint) color.

**mediaTextEyebrowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**mediaTextEyebrowWeight** `MediaTextEyebrowWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**mediaTextEyebrowSize** `MediaTextEyebrowSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**mediaTextHeading** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional section heading above the blocks. Leave empty to show just the blocks.

**mediaTextHeadingColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to track the theme text color.

**mediaTextHeadingColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**mediaTextHeadingWeight** `MediaTextHeadingWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Heading weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**mediaTextHeadingSize** `MediaTextHeadingSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Heading size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**mediaTextIntro** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional short sentence under the heading.

**mediaTextIntroColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the muted text color.

**mediaTextIntroColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**mediaTextIntroWeight** `MediaTextIntroWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Intro weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**mediaTextIntroSize** `MediaTextIntroSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Intro size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**mediaTextAlign** `MediaTextAlign | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Aligns the section header and the text inside each block. (Side-by-side rows usually read best left-aligned.) One of `left`, `center`; a newer site may send others, so keep a fallback.

**mediaTextRatio** `MediaTextRatio | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. For media-left / media-right rows: how the two columns share the width. One of `balanced`, `media`, `text`; a newer site may send others, so keep a fallback.

**mediaTextVAlign** `MediaTextVAlign | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. For media-left / media-right rows: how the text lines up against the media. One of `center`, `top`; a newer site may send others, so keep a fallback.

**mediaTextMediaRatio** `MediaTextMediaRatio | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Aspect ratio of the media frame. Auto keeps an image at its natural shape (videos and embeds always use a ratio). One of `auto`, `landscape`, `standard`, `square`, `portrait`, `wide`; a newer site may send others, so keep a fallback.

**mediaTextMediaRadius** `MediaTextMediaRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Media corners. One of `large`, `rounded`, `slight`, `square`; a newer site may send others, so keep a fallback.

**mediaTextGap** `MediaTextGap | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Gap between blocks. One of `tight`, `normal`, `roomy`; a newer site may send others, so keep a fallback.

**mediaTextDividers** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. A hairline rule between blocks.

**mediaTextBlockEyebrowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Each block’s eyebrow color. Leave empty to use the secondary (mint) color.

**mediaTextBlockEyebrowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**mediaTextBlockEyebrowWeight** `MediaTextBlockEyebrowWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Block eyebrow weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**mediaTextBlockHeadingColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to track the theme text color.

**mediaTextBlockHeadingColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**mediaTextBlockHeadingWeight** `MediaTextBlockHeadingWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Block heading weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**mediaTextBlockHeadingSize** `MediaTextBlockHeadingSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Block heading size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**mediaTextBodyColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the muted text color.

**mediaTextBodyColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**mediaTextBodyWeight** `MediaTextBodyWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Block body weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**mediaTextBodySize** `MediaTextBodySize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Block body size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**mediaTextBlocks** `readonly MediaTextWidgetMediaTextBlocksItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `MediaTextWidgetMediaTextBlocksItem`. Each block is one media + text row. They render top to bottom in this order; alternate “Media left” / “Media right” for a classic zig-zag. Its fields are listed under the first `MediaTextWidgetMediaTextBlocksItem` above.

**mediaTextBg** `MediaTextBg | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The section’s full-width background band in dark mode. Transparent lets the page background show through. The palette options track the site colors; choose “Custom color…” for a specific color. One of `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**mediaTextBgCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (dark theme)” is set to Custom color.

**mediaTextBgLight** `MediaTextBgLight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. “Match dark theme” reuses the dark-theme choice; otherwise set the light-mode band independently. One of `inherit`, `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**mediaTextBgLightCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (light theme)” is set to Custom color.

**mediaTextFontOverrides** `readonly MediaTextWidgetMediaTextFontOverridesItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `MediaTextWidgetMediaTextFontOverridesItem`. Optional. Set part of this section in a different typeface. Leave empty to follow the site’s fonts (Site design → Typography). At most 4 items. Its fields are listed under the first `MediaTextWidgetMediaTextFontOverridesItem` above.

**mediaTextCtaVariant** `MediaTextCtaVariant | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fills with the color; Outline / Soft / Text link use it for the border + text. One of `solid`, `outline`, `soft`, `link`; a newer site may send others, so keep a fallback.

**mediaTextCtaSize** `MediaTextCtaSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Button size. One of `small`, `normal`, `large`; a newer site may send others, so keep a fallback.

**mediaTextCtaRadius** `MediaTextCtaRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner radius. One of `pill`, `rounded`, `slight`, `square`; a newer site may send others, so keep a fallback.

**mediaTextCtaColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fill, or the border + text for the other styles. Defaults to the brand accent; CLEAR it for a transparent, outline-only button.

**mediaTextCtaColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color. (Brand tokens already flip per theme.)

**mediaTextCtaTextColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The text/icon color. Clear it to derive from the button color (readable on solid fills).

**mediaTextCtaTextColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme label color.

**mediaTextCtaHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Drives the hover treatment. Leave empty to derive it from the button color.

**mediaTextCtaHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme hover color.

**mediaTextCtaStyle** `MediaTextCtaStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The hover treatment: a soft shadow, a colored offset shadow, a glow, a fill sweep, or a thicker border. One of `none`, `single`, `dual`, `glow`, `sweep`, `thicken`; a newer site may send others, so keep a fallback.

**mediaTextCtaShadowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. The offset-shadow or glow color on hover. Leave empty to use the site secondary color.

**mediaTextCtaShadowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme shadow color.

**mediaTextCtaAnimation** `MediaTextCtaAnimation | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Hover motion. One of `lift`, `scale`, `lift-scale`, `none`; a newer site may send others, so keep a fallback.

**mediaTextCtaIcon** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.

**mediaTextCtaIconFamily** `MediaTextCtaIconFamily | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon family. One of `classic-regular`, `duotone-regular`, `brands`, `jelly`, `jelly-duo`, `whiteboard`; a newer site may send others, so keep a fallback.

**mediaTextCtaIconPosition** `MediaTextCtaIconPosition | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which side of the label the icon sits on (when an icon name is set). One of `before`, `after`; a newer site may send others, so keep a fallback.

**mediaTextCtaIconNudge** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. The icon slides toward its side on hover (e.g. an arrow edges outward).

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**DeviceMockWidget**

A `device-mock` widget: its `type` and its own fields. A field left out takes its default.

**type** `DeviceMockWidgetType`

**Always sent.** The widget’s type: always `device-mock`. One of `device-mock`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**deviceMockArrangement** `DeviceMockArrangement | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which devices to show. Duo overlaps a phone on the corner of a desktop browser; Trio adds a TV behind them (on narrow screens Trio drops the TV and shows as a Duo). Each device used gets its own screen tab. One of `duo`, `trio`, `desktop`, `phone`, `tv`; a newer site may send others, so keep a fallback.

**deviceMockTextPlacement** `DeviceMockTextPlacement | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the eyebrow / heading / intro / button sit. Left or right puts the text in a column beside the devices (stacked above them on narrow screens); None shows the devices only. One of `above`, `left`, `right`, `none`; a newer site may send others, so keep a fallback.

**deviceMockSize** `DeviceMockSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. How large the devices render within the section. One of `compact`, `normal`, `large`; a newer site may send others, so keep a fallback.

**deviceMockBrowserRatio** `DeviceMockBrowserRatio | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The browser window’s content area. Match your desktop captures. One of `16:10`, `16:9`; a newer site may send others, so keep a fallback.

**deviceMockBrowserUrl** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The address shown in the browser toolbar — decoration only, not a link.

**deviceMockPhoneStatusBar** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Adds a time / signal / battery bar across the top of the phone screen. Leave off for native phone screenshots — they already include the real status bar.

**deviceMockPhoneTime** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Status bar time.

**deviceMockMotionPause** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Adds a small, unobtrusive pause/play control so visitors can stop the auto-playing background motion (WCAG 2.2.2). Only appears when a moving background is set.

**deviceMockEyebrowEnabled** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. A small label above the heading (e.g. "Product tour").

**deviceMockEyebrow** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Small label shown above the title.

**deviceMockEyebrowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Overrides the eyebrow + its dash. Leave empty to use the secondary (mint) color.

**deviceMockEyebrowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the mint default.

**deviceMockEyebrowWeight** `DeviceMockEyebrowWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**deviceMockEyebrowSize** `DeviceMockEyebrowSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**deviceMockHeading** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional. Leave empty to show just the devices.

**deviceMockHeadingColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to track the theme text color.

**deviceMockHeadingColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**deviceMockHeadingWeight** `DeviceMockHeadingWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Heading weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**deviceMockHeadingSize** `DeviceMockHeadingSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Heading size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**deviceMockIntro** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional short paragraph under the heading.

**deviceMockIntroColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the muted text color.

**deviceMockIntroColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**deviceMockIntroWeight** `DeviceMockIntroWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Intro weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**deviceMockIntroSize** `DeviceMockIntroSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Intro size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**deviceMockCaption** `string`

**Sometimes sent:** `undefined` when the site leaves it out. A short line shown under the devices.

**deviceMockTvMediaType** `DeviceMockTvMediaType | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A still screenshot, or a short looping screen recording. One of `image`, `video`; a newer site may send others, so keep a fallback.

**deviceMockTvImage** `readonly Readonly\<Record\<string, unknown\>\>[]`

**Sometimes sent:** `undefined` when the site leaves it out. Use a native-resolution 16:9 capture of the screen with NO device frame (the frame is drawn for you) — e.g. 1920 × 1080 or 3840 × 2160. The related `@apostrophecms/image` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.

**deviceMockTvImageAlt** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Required once a screenshot is picked. Describe what the screen shows for visitors who can’t see it — e.g. “Dashboard with a weekly activity chart and a list of recent orders”. Skip the device itself (“a phone showing…”); the frame is decorative.

**deviceMockTvVideo** `readonly Readonly\<Record\<string, unknown\>\>[]`

**Sometimes sent:** `undefined` when the site leaves it out. Pick a clip from the Videos library (⌘K → Videos). It plays as a short, muted, looping screen recording — keep it SHORT (about 5–15 seconds) and SMALL (under about 10 MB; an H.264 MP4 without an audio track is ideal), and give the Videos item a poster image: visitors see the poster first, and reduced-motion visitors only ever see the poster. Use a native-resolution 16:9 capture of the screen with NO device frame (the frame is drawn for you) — e.g. 1920 × 1080 or 3840 × 2160. The related `video` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.

**deviceMockTvVideoAlt** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Recommended. A short description of what the recording shows, read to screen-reader users — e.g. “Creating a new project in three clicks”. Leave empty only if the surrounding text already says it.

**deviceMockTvFit** `DeviceMockTvFit | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Fill crops the media to fill the whole screen (best for native captures). Fit shows the whole image or video, leaving bars if its shape differs from the screen. One of `cover`, `contain`; a newer site may send others, so keep a fallback.

**deviceMockTvAnchor** `DeviceMockTvAnchor | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which part stays visible when the media is cropped. Top keeps an app’s header in view — right for most screenshots. One of `top`, `center`, `bottom`; a newer site may send others, so keep a fallback.

**deviceMockDesktopMediaType** `DeviceMockDesktopMediaType | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A still screenshot, or a short looping screen recording. One of `image`, `video`; a newer site may send others, so keep a fallback.

**deviceMockDesktopImage** `readonly Readonly\<Record\<string, unknown\>\>[]`

**Sometimes sent:** `undefined` when the site leaves it out. Use a native-resolution capture of the page content only — no browser toolbar and no device frame (both are drawn for you). 16:10 (e.g. 2880 × 1800) or 16:9 (e.g. 2560 × 1440), matching the “Desktop screen shape” setting. The related `@apostrophecms/image` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.

**deviceMockDesktopImageAlt** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Required once a screenshot is picked. Describe what the screen shows for visitors who can’t see it — e.g. “Dashboard with a weekly activity chart and a list of recent orders”. Skip the device itself (“a phone showing…”); the frame is decorative.

**deviceMockDesktopVideo** `readonly Readonly\<Record\<string, unknown\>\>[]`

**Sometimes sent:** `undefined` when the site leaves it out. Pick a clip from the Videos library (⌘K → Videos). It plays as a short, muted, looping screen recording — keep it SHORT (about 5–15 seconds) and SMALL (under about 10 MB; an H.264 MP4 without an audio track is ideal), and give the Videos item a poster image: visitors see the poster first, and reduced-motion visitors only ever see the poster. Use a native-resolution capture of the page content only — no browser toolbar and no device frame (both are drawn for you). 16:10 (e.g. 2880 × 1800) or 16:9 (e.g. 2560 × 1440), matching the “Desktop screen shape” setting. The related `video` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.

**deviceMockDesktopVideoAlt** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Recommended. A short description of what the recording shows, read to screen-reader users — e.g. “Creating a new project in three clicks”. Leave empty only if the surrounding text already says it.

**deviceMockDesktopFit** `DeviceMockDesktopFit | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Fill crops the media to fill the whole screen (best for native captures). Fit shows the whole image or video, leaving bars if its shape differs from the screen. One of `cover`, `contain`; a newer site may send others, so keep a fallback.

**deviceMockDesktopAnchor** `DeviceMockDesktopAnchor | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which part stays visible when the media is cropped. Top keeps an app’s header in view — right for most screenshots. One of `top`, `center`, `bottom`; a newer site may send others, so keep a fallback.

**deviceMockPhoneMediaType** `DeviceMockPhoneMediaType | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A still screenshot, or a short looping screen recording. One of `image`, `video`; a newer site may send others, so keep a fallback.

**deviceMockPhoneImage** `readonly Readonly\<Record\<string, unknown\>\>[]`

**Sometimes sent:** `undefined` when the site leaves it out. Use a native-resolution portrait screenshot with NO device frame (the frame is drawn for you) — e.g. 1179 × 2556 or 1290 × 2796 (about 9:19.5). The related `@apostrophecms/image` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.

**deviceMockPhoneImageAlt** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Required once a screenshot is picked. Describe what the screen shows for visitors who can’t see it — e.g. “Dashboard with a weekly activity chart and a list of recent orders”. Skip the device itself (“a phone showing…”); the frame is decorative.

**deviceMockPhoneVideo** `readonly Readonly\<Record\<string, unknown\>\>[]`

**Sometimes sent:** `undefined` when the site leaves it out. Pick a clip from the Videos library (⌘K → Videos). It plays as a short, muted, looping screen recording — keep it SHORT (about 5–15 seconds) and SMALL (under about 10 MB; an H.264 MP4 without an audio track is ideal), and give the Videos item a poster image: visitors see the poster first, and reduced-motion visitors only ever see the poster. Use a native-resolution portrait screenshot with NO device frame (the frame is drawn for you) — e.g. 1179 × 2556 or 1290 × 2796 (about 9:19.5). The related `video` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.

**deviceMockPhoneVideoAlt** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Recommended. A short description of what the recording shows, read to screen-reader users — e.g. “Creating a new project in three clicks”. Leave empty only if the surrounding text already says it.

**deviceMockPhoneFit** `DeviceMockPhoneFit | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Fill crops the media to fill the whole screen (best for native captures). Fit shows the whole image or video, leaving bars if its shape differs from the screen. One of `cover`, `contain`; a newer site may send others, so keep a fallback.

**deviceMockPhoneAnchor** `DeviceMockPhoneAnchor | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which part stays visible when the media is cropped. Top keeps an app’s header in view — right for most screenshots. One of `top`, `center`, `bottom`; a newer site may send others, so keep a fallback.

**deviceMockBg** `DeviceMockBg | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The section’s full-width background band in dark mode. Transparent lets the page background show through. The palette options track the site colors; choose “Custom color…” for a specific color. One of `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**deviceMockBgCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (dark theme)” is set to Custom color.

**deviceMockBgLight** `DeviceMockBgLight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. “Match dark theme” reuses the dark-theme choice; otherwise set the light-mode band independently. One of `inherit`, `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**deviceMockBgLightCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (light theme)” is set to Custom color.

**deviceMockFontOverrides** `readonly DeviceMockWidgetDeviceMockFontOverridesItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `DeviceMockWidgetDeviceMockFontOverridesItem`. Optional. Set part of this section in a different typeface. Leave empty to follow the site’s fonts (Site design → Typography). At most 4 items. Its fields are listed under the first `DeviceMockWidgetDeviceMockFontOverridesItem` above.

**deviceMockCtaLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The visible button text. Leave empty to hide the button.

**deviceMockCtaUrl** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Where the button goes — a path (/blog) or full URL.

**deviceMockCtaNewTab** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Opens the link in a new browser tab (adds rel="noopener noreferrer").

**deviceMockCtaVariant** `DeviceMockCtaVariant | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fills with the color; Outline / Soft / Text link use it for the border + text. One of `solid`, `outline`, `soft`, `link`; a newer site may send others, so keep a fallback.

**deviceMockCtaSize** `DeviceMockCtaSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Button size. One of `small`, `normal`, `large`; a newer site may send others, so keep a fallback.

**deviceMockCtaRadius** `DeviceMockCtaRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner radius. One of `pill`, `rounded`, `slight`, `square`; a newer site may send others, so keep a fallback.

**deviceMockCtaColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fill, or the border + text for the other styles. Defaults to the brand accent; CLEAR it for a transparent, outline-only button.

**deviceMockCtaColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color. (Brand tokens already flip per theme.)

**deviceMockCtaTextColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The text/icon color. Clear it to derive from the button color (readable on solid fills).

**deviceMockCtaTextColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme label color.

**deviceMockCtaHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Drives the hover treatment. Leave empty to derive it from the button color.

**deviceMockCtaHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme hover color.

**deviceMockCtaStyle** `DeviceMockCtaStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The hover treatment: a soft shadow, a colored offset shadow, a glow, a fill sweep, or a thicker border. One of `none`, `single`, `dual`, `glow`, `sweep`, `thicken`; a newer site may send others, so keep a fallback.

**deviceMockCtaShadowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. The offset-shadow or glow color on hover. Leave empty to use the site secondary color.

**deviceMockCtaShadowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme shadow color.

**deviceMockCtaAnimation** `DeviceMockCtaAnimation | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Hover motion. One of `lift`, `scale`, `lift-scale`, `none`; a newer site may send others, so keep a fallback.

**deviceMockCtaIcon** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.

**deviceMockCtaIconFamily** `DeviceMockCtaIconFamily | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon family. One of `classic-regular`, `duotone-regular`, `brands`, `jelly`, `jelly-duo`, `whiteboard`; a newer site may send others, so keep a fallback.

**deviceMockCtaIconPosition** `DeviceMockCtaIconPosition | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which side of the label the icon sits on (when an icon name is set). One of `before`, `after`; a newer site may send others, so keep a fallback.

**deviceMockCtaIconNudge** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. The icon slides toward its side on hover (e.g. an arrow edges outward).

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**TeamWidget**

A `team` widget: its `type` and its own fields. A field left out takes its default.

**type** `TeamWidgetType`

**Always sent.** The widget’s type: always `team`. One of `team`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**teamEyebrow** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Small label shown above the title.

**teamEyebrowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Overrides the eyebrow + its dash. Leave empty to use the secondary (mint) color.

**teamEyebrowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the mint default.

**teamEyebrowWeight** `TeamEyebrowWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**teamEyebrowSize** `TeamEyebrowSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**teamHeading** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional. Leave empty to show just the team.

**teamHeadingColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to track the theme text color.

**teamHeadingColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**teamHeadingWeight** `TeamHeadingWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Heading weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**teamIntro** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional short sentence under the heading.

**teamIntroColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the muted text color.

**teamIntroColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**teamIntroWeight** `TeamIntroWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Intro weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**teamIntroSize** `TeamIntroSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Intro size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**teamAlign** `TeamAlign | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Header alignment. One of `center`, `left`; a newer site may send others, so keep a fallback.

**teamFeaturedOnly** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Show only members you have flagged “Featured” in the Team Members manager — e.g. a short leadership row on the home page.

**teamCount** `number | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The most members to show, in the manager’s sort order. 1 to 50.

**teamLayout** `TeamLayout | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Grid: a tidy multi-row grid (the full team page). Carousel: a continuous auto-scrolling marquee (needs site animations enabled — falls back to the grid when they are off). Spotlight: featured members large on top, the rest in a smaller grid. List: wide rows with the full bio. Scatter: a playful arrangement with varied spacing so the cards float freely. One of `grid`, `carousel`, `spotlight`, `list`, `scatter`; a newer site may send others, so keep a fallback.

**teamColumns** `TeamColumns | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. How many cards per row. Auto fits as many as comfortably fit (the Scatter layout composes on three columns when set to Auto). One of `auto`, `2`, `3`, `4`; a newer site may send others, so keep a fallback.

**teamSpotlightHeroes** `TeamSpotlightHeroes | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. How many members lead the section at full size. Members flagged “Featured” fill the spots first, in the manager’s sort order; any extra featured members join the rows below. One of `1`, `2`; a newer site may send others, so keep a fallback.

**teamSpotlightColumns** `TeamSpotlightColumns | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. How many of the remaining members sit on each row under the featured spots. One of `2`, `3`, `4`, `5`; a newer site may send others, so keep a fallback.

**teamSpeed** `TeamSpeed | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. How fast the carousel auto-scrolls. One of `vslow`, `slow`, `normal`, `fast`; a newer site may send others, so keep a fallback.

**teamDirection** `TeamDirection | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Scroll direction. One of `left`, `right`; a newer site may send others, so keep a fallback.

**teamScatter** `TeamScatter | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. How far the cards drift from a tidy grid. Subtle keeps a loose grid; Wild pushes the offsets to their playful maximum. One of `subtle`, `playful`, `wild`; a newer site may send others, so keep a fallback.

**teamGap** `TeamGap | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Gap between cards. One of `tight`, `normal`, `roomy`; a newer site may send others, so keep a fallback.

**teamCardLayout** `TeamCardLayout | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Portrait: the photo on top, name/role/bio below — the classic team card. Overlay: a full-bleed photo with a solid color panel over its lower edge holding the name and role. Profile: a horizontal bar — avatar left, name/role/tagline right. Roster: minimal — just the avatar, name and role. (The List section layout always uses its own wide row.) One of `portrait`, `overlay`, `profile`, `roster`; a newer site may send others, so keep a fallback.

**teamPhotoAspect** `TeamPhotoAspect | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The photo’s aspect ratio on the photo-led card layouts. One of `square`, `portrait`, `tall`; a newer site may send others, so keep a fallback.

**teamAvatarShape** `TeamAvatarShape | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The photo’s outline. Squircle is a soft superellipse-style corner (approximated with heavy rounding). One of `circle`, `rounded`, `squircle`, `square`; a newer site may send others, so keep a fallback.

**teamAvatarSize** `TeamAvatarSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Avatar size. One of `small`, `medium`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**teamAvatarBorder** `TeamAvatarBorder | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A ring around the photo in the avatar color. One of `none`, `hairline`, `thin`, `bold`; a newer site may send others, so keep a fallback.

**teamAvatarTreatment** `TeamAvatarTreatment | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A flat color accent behind the photo. Panel offsets a solid block behind it; Halo draws a soft concentric disc. Both use the avatar color. One of `none`, `panel`, `halo`; a newer site may send others, so keep a fallback.

**teamAvatarColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Colors the border and the backdrop treatment. Leave empty to use the brand accent.

**teamAvatarColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**teamShowRole** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Show role / title.

**teamShowBio** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Shown on the Portrait and Profile cards and the List rows. The Overlay and Roster layouts stay bio-free by design.

**teamShowTagline** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. The member’s one-liner, shown on the Profile and Roster cards and the List rows.

**teamHoverPhoto** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Cross-fades to a member’s alternate photo on hover (set per member; does nothing for members without one, and stays off for visitors who prefer reduced motion).

**teamCardStyle** `TeamCardStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The card treatment. Outline (the default) is a plaque frame — a framed-portrait look; Raised is a quiet lit card; Luxe a frosted glass panel; Ticket/Bracket/Inlay are the graphic showstoppers. One of `raised`, `luxe`, `outline`, `plain`, `poster`, `edge`, `tint`, `ticket`, `bracket`, `inlay`; a newer site may send others, so keep a fallback.

**teamCardStyleRadius** `TeamCardStyleRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner rounding for each card. Default keeps the widget’s own tuned corners — except Forge, which defaults to tight machined corners matching its engraved frame. One of `default`, `square`, `slight`, `rounded`, `large`; a newer site may send others, so keep a fallback.

**teamCardStyleAccentColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Colors the Spine rail, Bracket marks, Forge corner/frame and Press margin rule. Leave empty to use the brand accent.

**teamCardStyleAccentColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**teamCardHover** `TeamCardHover | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. What a card does on hover. Lift/Pop/Press/Glow/Outline are instant; Sheen sweeps a light across; Tilt, Magnetic and Spotlight follow the cursor (need site animations on). Vary it per section so the page is not cookie-cutter. One of `none`, `lift`, `pop`, `press`, `glow`, `border`, `sheen`, `tilt`, `magnetic`, `spotlight`; a newer site may send others, so keep a fallback.

**teamCardAlign** `TeamCardAlign | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. How the name, role and bio align inside each card (the Profile card and List rows are always left-aligned beside the avatar). One of `center`, `left`; a newer site may send others, so keep a fallback.

**teamAccentColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — the lettered-avatar fallback background and the role color default. Leave empty to use the brand accent. (The icon row has its own colors on the Social links tab.)

**teamAccentColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**teamPanelColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The solid panel over the photo on the Overlay card. Leave empty to use the card color.

**teamPanelColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**teamNameSize** `TeamNameSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Name size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**teamNameWeight** `TeamNameWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Name weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**teamNameColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to track the theme text color.

**teamNameColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**teamRoleSize** `TeamRoleSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Role size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**teamRoleWeight** `TeamRoleWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Role weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**teamRoleColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the accent color.

**teamRoleColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**teamBioSize** `TeamBioSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Bio size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**teamBioWeight** `TeamBioWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Bio weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**teamBioColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the muted text color.

**teamBioColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**teamBioClamp** `TeamBioClamp | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Cap each bio at this many lines (the rest is truncated with an ellipsis) so one long bio can’t blow up the card height. The List layout always shows the full bio. One of `none`, `2`, `3`, `4`, `6`; a newer site may send others, so keep a fallback.

**teamTaglineColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the faint text color.

**teamTaglineColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**teamShowSocials** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. The member’s social profile icons (set per member in the Team Members manager).

**teamShowContact** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Off by default — turns each member’s email and phone (when set) into icon links. Only enable when you want those details public.

**teamSocialVariant** `TeamSocialVariant | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon style. One of `bare`, `outline`, `solid`; a newer site may send others, so keep a fallback.

**teamSocialSize** `TeamSocialSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**teamSocialSpacing** `TeamSocialSpacing | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Gap between the icons. One of `tight`, `normal`, `loose`; a newer site may send others, so keep a fallback.

**teamSocialHover** `TeamSocialHover | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Hover to each platform’s own brand color, or to the site accent (or a chosen hover color). One of `brand`, `accent`; a newer site may send others, so keep a fallback.

**teamSocialColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Resting icon color. Leave empty for the muted default.

**teamSocialColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the muted default.

**teamSocialHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Hover color” is Accent / custom. Leave empty for the site accent.

**teamSocialHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the accent.

**teamBg** `TeamBg | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The section’s full-width background band in dark mode. Transparent lets the page background show through. The palette options track the site colors; choose “Custom color…” for a specific color. One of `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**teamBgCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (dark theme)” is set to Custom color.

**teamBgLight** `TeamBgLight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. “Match dark theme” reuses the dark-theme choice; otherwise set the light-mode band independently. One of `inherit`, `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**teamBgLightCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (light theme)” is set to Custom color.

**teamFontOverrides** `readonly TeamWidgetTeamFontOverridesItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `TeamWidgetTeamFontOverridesItem`. Optional. Set part of this section in a different typeface. Leave empty to follow the site’s fonts (Site design → Typography). At most 4 items.

**TeamWidgetTeamFontOverridesItem**

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**target** `Target | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which text this typeface replaces. Rows apply in order, so a broad row (Everything) followed by a narrow one (Headings) gives the section a base face plus an exception. One of `all`, `heading`, `body`, `eyebrow`, `button`, `code`; a newer site may send others, so keep a fallback.

**source** `Source | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the typeface comes from. The first option costs nothing extra — those faces are already loaded. The others load an additional font on pages that use this section. One of `slot`, `curated`, `cdn`, `upload`; a newer site may send others, so keep a fallback.

**slot** `Slot | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Set in Site design → Typography. Following the site’s own faces keeps a section on-brand and adds no download. One of `display`, `body`, `accent`; a newer site may send others, so keep a fallback.

**curated** `Curated | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Vetted families from Bunny Fonts and Fontshare, with their available weights already verified. One of `archivo`, `bricolage-grotesque`, `clash-display`, `courier-prime`, `dm-mono`, `dm-sans`, `fira-code`, `fraunces`, `general-sans`, `ibm-plex-mono`, `ibm-plex-sans`, `inconsolata`, `inter`, `jetbrains-mono`, `karla`, `lora`, `manrope`, `nunito-sans`, `outfit`, `playfair-display`, `public-sans`, `red-hat-mono`, `satoshi`, `sentient`, `sora`, `source-code-pro`, `source-sans-3`, `source-serif-4`, `space-grotesk`, `space-mono`, `spline-sans-mono`, `supreme`, `switzer`, `syne`, `ubuntu-mono`, `unbounded`, `victor-mono`, `work-sans`, `zodiak`; a newer site may send others, so keep a fallback.

**cdnProvider** `CdnProvider | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where to browse for the family. Pick one, then follow the link below to find the exact name. One of `bunny`, `fontshare`; a newer site may send others, so keep a fallback.

**cdnFamily** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Exactly as the provider’s catalog spells it, e.g. "Space Grotesk" or "Clash Display". A name the provider doesn’t have loads nothing and this row is ignored.

**cdnWeights** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 500, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold) — but a family that ships only ONE weight (Acme, for instance) loads nothing at all unless that weight is among these, so set it explicitly if the typeface doesn’t appear.

**uploads** `readonly TeamWidgetTeamFontOverridesItemUploadsItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `TeamWidgetTeamFontOverridesItemUploadsItem`. One file per weight/style of the SAME typeface. woff2 strongly recommended (smallest, universally supported); woff/ttf/otf also accepted. At most 4 items.

**TeamWidgetTeamFontOverridesItemUploadsItem**

**file** `Readonly\<Record\<string, unknown\>\>`

**Always sent.** File attachment reference.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**weight** `Weight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Weight. One of `100`, `200`, `300`, `400`, `500`, `600`, `700`, `800`, `900`; a newer site may send others, so keep a fallback.

**style** `Style | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Style. One of `normal`, `italic`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**fallback** `Fallback | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Generic system font shown while this typeface loads (and if it fails). Curated picks set this automatically. One of `sans`, `serif`, `mono`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**teamCtaLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The visible button text. Leave empty to hide the button.

**teamCtaUrl** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Where the button goes — a path (/blog) or full URL.

**teamCtaNewTab** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Opens the link in a new browser tab (adds rel="noopener noreferrer").

**teamCtaVariant** `TeamCtaVariant | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fills with the color; Outline / Soft / Text link use it for the border + text. One of `solid`, `outline`, `soft`, `link`; a newer site may send others, so keep a fallback.

**teamCtaSize** `TeamCtaSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Button size. One of `small`, `normal`, `large`; a newer site may send others, so keep a fallback.

**teamCtaRadius** `TeamCtaRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner radius. One of `pill`, `rounded`, `slight`, `square`; a newer site may send others, so keep a fallback.

**teamCtaColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fill, or the border + text for the other styles. Defaults to the brand accent; CLEAR it for a transparent, outline-only button.

**teamCtaColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color. (Brand tokens already flip per theme.)

**teamCtaTextColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The text/icon color. Clear it to derive from the button color (readable on solid fills).

**teamCtaTextColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme label color.

**teamCtaHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Drives the hover treatment. Leave empty to derive it from the button color.

**teamCtaHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme hover color.

**teamCtaStyle** `TeamCtaStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The hover treatment: a soft shadow, a colored offset shadow, a glow, a fill sweep, or a thicker border. One of `none`, `single`, `dual`, `glow`, `sweep`, `thicken`; a newer site may send others, so keep a fallback.

**teamCtaShadowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. The offset-shadow or glow color on hover. Leave empty to use the site secondary color.

**teamCtaShadowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme shadow color.

**teamCtaAnimation** `TeamCtaAnimation | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Hover motion. One of `lift`, `scale`, `lift-scale`, `none`; a newer site may send others, so keep a fallback.

**teamCtaIcon** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.

**teamCtaIconFamily** `TeamCtaIconFamily | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon family. One of `classic-regular`, `duotone-regular`, `brands`, `jelly`, `jelly-duo`, `whiteboard`; a newer site may send others, so keep a fallback.

**teamCtaIconPosition** `TeamCtaIconPosition | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which side of the label the icon sits on (when an icon name is set). One of `before`, `after`; a newer site may send others, so keep a fallback.

**teamCtaIconNudge** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. The icon slides toward its side on hover (e.g. an arrow edges outward).

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**FaqWidget**

A `faq` widget: its `type` and its own fields. A field left out takes its default.

**type** `FaqWidgetType`

**Always sent.** The widget’s type: always `faq`. One of `faq`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**faqEyebrow** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Small label shown above the title.

**faqEyebrowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Overrides the eyebrow + its dash. Leave empty to use the secondary (mint) color.

**faqEyebrowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the mint default.

**faqEyebrowWeight** `FaqEyebrowWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**faqEyebrowSize** `FaqEyebrowSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**faqHeading** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional. Leave empty to show just the questions.

**faqHeadingColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to track the theme text color.

**faqHeadingColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**faqHeadingWeight** `FaqHeadingWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Heading weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**faqIntro** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional short sentence under the heading.

**faqIntroColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the muted text color.

**faqIntroColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**faqIntroWeight** `FaqIntroWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Intro weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**faqIntroSize** `FaqIntroSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Intro size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**faqAlign** `FaqAlign | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The Split layout always sets its header column left. One of `center`, `left`; a newer site may send others, so keep a fallback.

**faqFeaturedOnly** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Show only questions you have flagged “Featured” in the FAQs manager — e.g. a short top-questions block on the home page, linking out to the full FAQ page.

**faqCount** `number | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The most questions to show, in the manager’s sort order. Raise it for a full FAQ page. 1 to 50.

**faqCategories** `readonly Readonly\<Record\<string, unknown\>\>[]`

**Sometimes sent:** `undefined` when the site leaves it out. Optional filter. Leave empty to show questions from every category. Manage the list under FAQ Categories. The related `faq-category` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document; a document the site can’t find is left out.

**faqGroupBy** `FaqGroupBy | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. By category renders a subheading per FAQ category, in the order picked in the category filter (or, with no filter, the FAQ Categories sort order); questions without a category are listed last. One of `none`, `category`; a newer site may send others, so keep a fallback.

**faqLayout** `FaqLayout | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Accordion: a single centered column of collapsing questions — the classic FAQ. Split: the header (and button) sit in a left column with the accordion beside them. Two columns: the accordion flows across two columns. Open panels: every answer visible in a card grid — no collapsing. One of `accordion`, `split`, `columns`, `panels`; a newer site may send others, so keep a fallback.

**faqPanelColumns** `FaqPanelColumns | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. How many open panels sit per row (they stack on small screens). One of `1`, `2`, `3`; a newer site may send others, so keep a fallback.

**faqOpenMode** `FaqOpenMode | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. One at a time closes the previous answer when a new one opens; Independent lets visitors hold several open. One of `single`, `multiple`; a newer site may send others, so keep a fallback.

**faqFirstOpen** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Starts the section with the first answer expanded so the block never reads as an empty list of rows.

**faqMarker** `FaqMarker | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The disclosure marker on each question. Plus rotates into a close mark; Chevron flips. One of `plus`, `chevron`; a newer site may send others, so keep a fallback.

**faqGap** `FaqGap | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Space between questions. One of `tight`, `normal`, `roomy`; a newer site may send others, so keep a fallback.

**faqSchema** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Adds this section’s questions to the page’s schema.org FAQPage markup so search engines can read them (all FAQ sections on a page share one FAQPage block). Costs nothing when on; turn off only to exclude these questions.

**faqCardStyle** `FaqCardStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The question-row treatment. Plain (the default) is the classic divided list — hairlines between questions. Any other style turns each question into a card: Raised is a quiet lit card, Outline a framed row, Luxe frosted glass; Ticket/Bracket/Inlay are the graphic showstoppers. One of `raised`, `luxe`, `outline`, `plain`, `poster`, `edge`, `tint`, `ticket`, `bracket`, `forge`, `press`, `inlay`; a newer site may send others, so keep a fallback.

**faqCardStyleRadius** `FaqCardStyleRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner rounding for each card. Default keeps the widget’s own tuned corners — except Forge, which defaults to tight machined corners matching its engraved frame. One of `default`, `square`, `slight`, `rounded`, `large`; a newer site may send others, so keep a fallback.

**faqCardStyleAccentColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Colors the Spine rail, Bracket marks, Forge corner/frame and Press margin rule. Leave empty to use the brand accent.

**faqCardStyleAccentColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**faqCardStyleForgeScope** `FaqCardStyleForgeScope | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the Forge plate wears its color: a single corner mark (the machinist’s datum, default) or the whole engraved frame. One of `corner`, `frame`; a newer site may send others, so keep a fallback.

**faqCardStyleForgeWeight** `FaqCardStyleForgeWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Thickness of the Forge corner mark / colored frame. One of `fine`, `medium`, `bold`; a newer site may send others, so keep a fallback.

**faqCardHover** `FaqCardHover | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. What a question row does on hover. None (the default) keeps the accordion calm — the open/close motion is the interaction. The card effects (Lift/Glow/…) suit the card styles; the cursor-tracked ones need site animations on. One of `none`, `lift`, `pop`, `press`, `glow`, `border`, `sheen`, `tilt`, `magnetic`, `spotlight`; a newer site may send others, so keep a fallback.

**faqAccentColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — colors the toggle icon and the open question’s highlight. Leave empty to use the brand accent.

**faqAccentColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**faqQuestionSize** `FaqQuestionSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Question size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**faqQuestionWeight** `FaqQuestionWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Question weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**faqQuestionColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to track the theme text color.

**faqQuestionColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**faqAnswerSize** `FaqAnswerSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Answer size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**faqAnswerWeight** `FaqAnswerWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Answer weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**faqAnswerColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the muted text color.

**faqAnswerColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**faqGroupHeadingWeight** `FaqGroupHeadingWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Category heading weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**faqGroupHeadingColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to track the theme text color.

**faqGroupHeadingColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**faqBg** `FaqBg | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The section’s full-width background band in dark mode. Transparent lets the page background show through. The palette options track the site colors; choose “Custom color…” for a specific color. One of `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**faqBgCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (dark theme)” is set to Custom color.

**faqBgLight** `FaqBgLight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. “Match dark theme” reuses the dark-theme choice; otherwise set the light-mode band independently. One of `inherit`, `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**faqBgLightCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (light theme)” is set to Custom color.

**faqFontOverrides** `readonly FaqWidgetFaqFontOverridesItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `FaqWidgetFaqFontOverridesItem`. Optional. Set part of this section in a different typeface. Leave empty to follow the site’s fonts (Site design → Typography). At most 4 items. Its fields are listed under the first `FaqWidgetFaqFontOverridesItem` above.

**faqCtaLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The visible button text. Leave empty to hide the button.

**faqCtaUrl** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Where the button goes — a path (/blog) or full URL.

**faqCtaNewTab** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Opens the link in a new browser tab (adds rel="noopener noreferrer").

**faqCtaVariant** `FaqCtaVariant | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fills with the color; Outline / Soft / Text link use it for the border + text. One of `solid`, `outline`, `soft`, `link`; a newer site may send others, so keep a fallback.

**faqCtaSize** `FaqCtaSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Button size. One of `small`, `normal`, `large`; a newer site may send others, so keep a fallback.

**faqCtaRadius** `FaqCtaRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner radius. One of `pill`, `rounded`, `slight`, `square`; a newer site may send others, so keep a fallback.

**faqCtaColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fill, or the border + text for the other styles. Defaults to the brand accent; CLEAR it for a transparent, outline-only button.

**faqCtaColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color. (Brand tokens already flip per theme.)

**faqCtaTextColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The text/icon color. Clear it to derive from the button color (readable on solid fills).

**faqCtaTextColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme label color.

**faqCtaHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Drives the hover treatment. Leave empty to derive it from the button color.

**faqCtaHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme hover color.

**faqCtaStyle** `FaqCtaStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The hover treatment: a soft shadow, a colored offset shadow, a glow, a fill sweep, or a thicker border. One of `none`, `single`, `dual`, `glow`, `sweep`, `thicken`; a newer site may send others, so keep a fallback.

**faqCtaShadowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. The offset-shadow or glow color on hover. Leave empty to use the site secondary color.

**faqCtaShadowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme shadow color.

**faqCtaAnimation** `FaqCtaAnimation | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Hover motion. One of `lift`, `scale`, `lift-scale`, `none`; a newer site may send others, so keep a fallback.

**faqCtaIcon** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.

**faqCtaIconFamily** `FaqCtaIconFamily | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon family. One of `classic-regular`, `duotone-regular`, `brands`, `jelly`, `jelly-duo`, `whiteboard`; a newer site may send others, so keep a fallback.

**faqCtaIconPosition** `FaqCtaIconPosition | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which side of the label the icon sits on (when an icon name is set). One of `before`, `after`; a newer site may send others, so keep a fallback.

**faqCtaIconNudge** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. The icon slides toward its side on hover (e.g. an arrow edges outward).

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**ServiceMapWidget**

A `service-map` widget: its `type` and its own fields. A field left out takes its default.

**type** `ServiceMapWidgetType`

**Always sent.** The widget’s type: always `service-map`. One of `service-map`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**serviceMapEyebrow** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Small label shown above the title.

**serviceMapEyebrowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Overrides the eyebrow + its dash. Leave empty to use the secondary (mint) color.

**serviceMapEyebrowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the mint default.

**serviceMapEyebrowWeight** `ServiceMapEyebrowWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**serviceMapEyebrowSize** `ServiceMapEyebrowSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**serviceMapHeading** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Heading.

**serviceMapHeadingColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Leave empty for the standard ink color.

**serviceMapHeadingColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**serviceMapHeadingWeight** `ServiceMapHeadingWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Heading weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**serviceMapIntro** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional short paragraph under the heading. The data source’s own description (service days etc.) shows in the result panel, not here.

**serviceMapIntroSize** `ServiceMapIntroSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Intro size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**serviceMapHeight** `ServiceMapHeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Map height. One of `compact`, `standard`, `tall`; a newer site may send others, so keep a fallback.

**serviceMapTheme** `ServiceMapTheme | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Curated light/dark basemap pairs — each follows the visitor’s theme toggle. “Site palette” derives the basemap from this site’s own colors. One of `palette`, `classic`, `silver`, `retro`; a newer site may send others, so keep a fallback.

**serviceMapFrameRadius** `ServiceMapFrameRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Map corner radius. One of `square`, `slight`, `rounded`, `large`; a newer site may send others, so keep a fallback.

**serviceMapFrameBorderColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Leave empty for the standard hairline — set it to match a colored border on the zone cards.

**serviceMapFrameBorderColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**serviceMapFrameGlowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional soft glow around the map frame — pairs with a glowing zone-card style. Leave empty for none.

**serviceMapFrameGlowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**serviceMapSchema** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. On pages with this section, upgrades the business structured data from the compact site-wide form to the full detail: every public place name, every zip code, and area boundaries. Costs visitors nothing; turn off to keep this page at the compact site-wide form. (Requires structured data on in Site settings → SEO; demo map data is never published.)

**serviceMapShowLegend** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. The legend card overlaid on the map. The zone cards below the map always carry the same information for screen readers and when the map can’t load.

**serviceMapKeySwatchSize** `ServiceMapKeySwatchSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Key swatch size. One of `small`, `medium`, `large`; a newer site may send others, so keep a fallback.

**serviceMapKeyJustify** `ServiceMapKeyJustify | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Key text justification. One of `left`, `center`, `right`; a newer site may send others, so keep a fallback.

**serviceMapKeyTextSize** `ServiceMapKeyTextSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Key text size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**serviceMapKeyTextWeight** `ServiceMapKeyTextWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Key text weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**serviceMapKeyTextColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Leave empty for the standard ink color.

**serviceMapKeyTextColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**serviceMapKeyRadius** `ServiceMapKeyRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Key corner radius. One of `square`, `slight`, `rounded`, `large`; a newer site may send others, so keep a fallback.

**serviceMapKeyBorderColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Leave empty for the standard hairline — set it to match the map frame or the zone cards.

**serviceMapKeyBorderColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**serviceMapKeyGlowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional soft glow around the key card. Leave empty for none.

**serviceMapKeyGlowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**serviceMapShowCards** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. The zone/pricing cards under the map. Turning this off hides them visually — they stay in the page for screen readers and no-JavaScript visitors (the map itself isn’t accessible).

**serviceMapCardStyle** `ServiceMapCardStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The card surface. Raised is a quiet lit card; Luxe is a frosted glass panel; Outline is a double-rule plaque frame; Plain has no chrome; Poster frames the card with an accent keyline; Spine embeds a color rail along the top; Tint washes the card in the accent color. Showstoppers: Ticket punches notches into the sides, Bracket draws only corner marks, Forge is a machined plate with an engraved frame, Press is a punched index card with a margin rule, Inlay recesses the content into a well. One of `raised`, `luxe`, `outline`, `plain`, `poster`, `edge`, `tint`, `inlay`; a newer site may send others, so keep a fallback.

**serviceMapCardStyleRadius** `ServiceMapCardStyleRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner rounding for each card. Default keeps the widget’s own tuned corners — except Forge, which defaults to tight machined corners matching its engraved frame. One of `default`, `square`, `slight`, `rounded`, `large`; a newer site may send others, so keep a fallback.

**serviceMapCardStyleAccentColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Colors the Spine rail, Bracket marks, Forge corner/frame and Press margin rule. Leave empty to use the brand accent.

**serviceMapCardStyleAccentColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**serviceMapCardsHover** `ServiceMapCardsHover | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. What a card does on hover. Lift/Pop/Press/Glow/Outline are instant CSS effects; Sheen sweeps a soft light across; Tilt, Magnetic and Spotlight follow the cursor (these need site animations on — visitors who prefer reduced motion see the resting card). Pick a different one per section so a page feels varied, not cookie-cutter. One of `none`, `lift`, `pop`, `press`, `glow`, `border`, `sheen`, `tilt`, `magnetic`, `spotlight`; a newer site may send others, so keep a fallback.

**serviceMapCardsSwatchSize** `ServiceMapCardsSwatchSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Card swatch size. One of `small`, `medium`, `large`; a newer site may send others, so keep a fallback.

**serviceMapCardsJustify** `ServiceMapCardsJustify | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Card text justification. One of `left`, `center`, `right`; a newer site may send others, so keep a fallback.

**serviceMapCardsNameWeight** `ServiceMapCardsNameWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Zone name weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**serviceMapCardsTextSize** `ServiceMapCardsTextSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Card text size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**serviceMapCardsTextColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Colors the zone names; supporting copy stays muted. Leave empty for the standard ink color.

**serviceMapCardsTextColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**serviceMapCardsSubSize** `ServiceMapCardsSubSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The price and detail lines under each zone name — sized relative to the card text size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**serviceMapCardsSubWeight** `ServiceMapCardsSubWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Supporting text weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**serviceMapCardsSubColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Leave empty for the standard muted color.

**serviceMapCardsSubColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**serviceMapIncludedLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional label shown instead of “$0” wherever a zone has no fee (key, cards, results). Clear it to show the plain price — $0 doesn’t always mean included.

**serviceMapZoneOverrides** `readonly ServiceMapWidgetServiceMapZoneOverridesItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `ServiceMapWidgetServiceMapZoneOverridesItem`. Per-zone display overrides, matched by the zone name the data source provides. Rename a zone, replace its price text, or hide it entirely — the underlying data is never changed.

**ServiceMapWidgetServiceMapZoneOverridesItem**

**zoneName** `string`

**Always sent.** Case-insensitive match against the zone name in the map data.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**displayName** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional replacement name shown everywhere this zone appears.

**priceLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional replacement for the price text (e.g. “Included”, “Call us”). Overrides the zero-price label too.

**hide** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. The zone stays on the map and in search results — it just leaves the key and cards.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**serviceMapShowSearch** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Show the “check your area” search.

**serviceMapSearchLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Search label.

**serviceMapSearchPlaceholder** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Search placeholder.

**serviceMapSearchJustify** `ServiceMapSearchJustify | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Positions the search box and button above the map. One of `left`, `center`, `right`; a newer site may send others, so keep a fallback.

**serviceMapSearchInputRadius** `ServiceMapSearchInputRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Same radius scale as the buttons, so the box and button can match. One of `pill`, `rounded`, `slight`, `square`; a newer site may send others, so keep a fallback.

**serviceMapAutocomplete** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Google address autocomplete under the search box (needs the Places API enabled on the key — see the setup guide in Connections → Google Maps). ZIP-only typing never triggers suggestions when the data source is zip-based.

**serviceMapOutsideAreaText** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Shown when a searched location doesn’t fall in any zone (or the premium radius).

**serviceMapSearchButtonText** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Leave empty for “Check”. The button’s look is configured in the Search button tab.

**serviceMapSearchButtonVariant** `ServiceMapSearchButtonVariant | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fills with the color; Outline / Soft / Text link use it for the border + text. One of `solid`, `outline`, `soft`, `link`; a newer site may send others, so keep a fallback.

**serviceMapSearchButtonSize** `ServiceMapSearchButtonSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Button size. One of `small`, `normal`, `large`; a newer site may send others, so keep a fallback.

**serviceMapSearchButtonRadius** `ServiceMapSearchButtonRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner radius. One of `pill`, `rounded`, `slight`, `square`; a newer site may send others, so keep a fallback.

**serviceMapSearchButtonColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fill, or the border + text for the other styles. Defaults to the brand accent; CLEAR it for a transparent, outline-only button.

**serviceMapSearchButtonColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color. (Brand tokens already flip per theme.)

**serviceMapSearchButtonTextColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The text/icon color. Clear it to derive from the button color (readable on solid fills).

**serviceMapSearchButtonTextColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme label color.

**serviceMapSearchButtonHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Drives the hover treatment. Leave empty to derive it from the button color.

**serviceMapSearchButtonHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme hover color.

**serviceMapSearchButtonStyle** `ServiceMapSearchButtonStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The hover treatment: a soft shadow, a colored offset shadow, a glow, a fill sweep, or a thicker border. One of `none`, `single`, `dual`, `glow`, `sweep`, `thicken`; a newer site may send others, so keep a fallback.

**serviceMapSearchButtonShadowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. The offset-shadow or glow color on hover. Leave empty to use the site secondary color.

**serviceMapSearchButtonShadowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme shadow color.

**serviceMapSearchButtonAnimation** `ServiceMapSearchButtonAnimation | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Hover motion. One of `lift`, `scale`, `lift-scale`, `none`; a newer site may send others, so keep a fallback.

**serviceMapPanelPlacement** `ServiceMapPanelPlacement | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Popup placement. One of `center`, `corner`; a newer site may send others, so keep a fallback.

**serviceMapPanelLook** `ServiceMapPanelLook | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Popup style. One of `overlay`, `solid`; a newer site may send others, so keep a fallback.

**serviceMapPanelShowQuery** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Repeats the searched ZIP code or address at the top of the result popup.

**serviceMapPanelShowCity** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Looks up the locality for a searched ZIP code (one extra Geocoding API call per search) and shows it beside the searched value.

**serviceMapPanelTextSize** `ServiceMapPanelTextSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Popup text size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**serviceMapPanelTitleWeight** `ServiceMapPanelTitleWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Popup title weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**serviceMapShowPremium** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. When the data carries a premium (distance-priced) service, include it in search results and the zone cards. Sources without their own premium block use the pricing set in Service area map → Areas and pricing.

**serviceMapShowPremiumRing** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Needs a premium range limit (miles) — with no limit there is no ring to draw.

**serviceMapPremiumEstimateNote** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Premium estimate note.

**serviceMapPremiumUnavailableText** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Shown when a distance estimate isn’t possible (e.g. the Distance Matrix API isn’t enabled on the key).

**serviceMapMarkerImage** `readonly Readonly\<Record\<string, unknown\>\>[]`

**Sometimes sent:** `undefined` when the site leaves it out. Optional logo/pin image for the business marker. Leave empty for a simple accent-color pin. The related `@apostrophecms/image` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.

**serviceMapMarkerImageLight** `readonly Readonly\<Record\<string, unknown\>\>[]`

**Sometimes sent:** `undefined` when the site leaves it out. Optional light-theme variant. Falls back to the dark-theme image. The related `@apostrophecms/image` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.

**serviceMapMarkerLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Accessible name + hover title for the marker. Leave empty to use the business name from Site settings.

**serviceMapMarkerSize** `ServiceMapMarkerSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Marker size. One of `small`, `medium`, `large`; a newer site may send others, so keep a fallback.

**serviceMapMarkerBounce** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. The business marker gently bobs in place. Automatically disabled for visitors who prefer reduced motion.

**serviceMapShowLocation** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Adds the business location (named by its label in Service area map → Your location) as the FIRST entry of the map key and zone cards.

**serviceMapBg** `ServiceMapBg | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The section’s full-width background band in dark mode. Transparent lets the page background show through. The palette options track the site colors; choose “Custom color…” for a specific color. One of `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**serviceMapBgCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (dark theme)” is set to Custom color.

**serviceMapBgLight** `ServiceMapBgLight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. “Match dark theme” reuses the dark-theme choice; otherwise set the light-mode band independently. One of `inherit`, `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**serviceMapBgLightCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (light theme)” is set to Custom color.

**serviceMapFontOverrides** `readonly ServiceMapWidgetServiceMapFontOverridesItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `ServiceMapWidgetServiceMapFontOverridesItem`. Optional. Set part of this section in a different typeface. Leave empty to follow the site’s fonts (Site design → Typography). At most 4 items.

**ServiceMapWidgetServiceMapFontOverridesItem**

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**target** `Target | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which text this typeface replaces. Rows apply in order, so a broad row (Everything) followed by a narrow one (Headings) gives the section a base face plus an exception. One of `all`, `heading`, `body`, `eyebrow`, `button`, `code`; a newer site may send others, so keep a fallback.

**source** `Source | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the typeface comes from. The first option costs nothing extra — those faces are already loaded. The others load an additional font on pages that use this section. One of `slot`, `curated`, `cdn`, `upload`; a newer site may send others, so keep a fallback.

**slot** `Slot | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Set in Site design → Typography. Following the site’s own faces keeps a section on-brand and adds no download. One of `display`, `body`, `accent`; a newer site may send others, so keep a fallback.

**curated** `Curated | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Vetted families from Bunny Fonts and Fontshare, with their available weights already verified. One of `archivo`, `bricolage-grotesque`, `clash-display`, `courier-prime`, `dm-mono`, `dm-sans`, `fira-code`, `fraunces`, `general-sans`, `ibm-plex-mono`, `ibm-plex-sans`, `inconsolata`, `inter`, `jetbrains-mono`, `karla`, `lora`, `manrope`, `nunito-sans`, `outfit`, `playfair-display`, `public-sans`, `red-hat-mono`, `satoshi`, `sentient`, `sora`, `source-code-pro`, `source-sans-3`, `source-serif-4`, `space-grotesk`, `space-mono`, `spline-sans-mono`, `supreme`, `switzer`, `syne`, `ubuntu-mono`, `unbounded`, `victor-mono`, `work-sans`, `zodiak`; a newer site may send others, so keep a fallback.

**cdnProvider** `CdnProvider | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where to browse for the family. Pick one, then follow the link below to find the exact name. One of `bunny`, `fontshare`; a newer site may send others, so keep a fallback.

**cdnFamily** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Exactly as the provider’s catalog spells it, e.g. "Space Grotesk" or "Clash Display". A name the provider doesn’t have loads nothing and this row is ignored.

**cdnWeights** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 500, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold) — but a family that ships only ONE weight (Acme, for instance) loads nothing at all unless that weight is among these, so set it explicitly if the typeface doesn’t appear.

**uploads** `readonly ServiceMapWidgetServiceMapFontOverridesItemUploadsItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `ServiceMapWidgetServiceMapFontOverridesItemUploadsItem`. One file per weight/style of the SAME typeface. woff2 strongly recommended (smallest, universally supported); woff/ttf/otf also accepted. At most 4 items.

**ServiceMapWidgetServiceMapFontOverridesItemUploadsItem**

**file** `Readonly\<Record\<string, unknown\>\>`

**Always sent.** File attachment reference.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**weight** `Weight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Weight. One of `100`, `200`, `300`, `400`, `500`, `600`, `700`, `800`, `900`; a newer site may send others, so keep a fallback.

**style** `Style | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Style. One of `normal`, `italic`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**fallback** `Fallback | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Generic system font shown while this typeface loads (and if it fails). Curated picks set this automatically. One of `sans`, `serif`, `mono`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**BlogPreviewWidget**

A `blog-preview` widget: its `type` and its own fields. A field left out takes its default.

**type** `BlogPreviewWidgetType`

**Always sent.** The widget’s type: always `blog-preview`. One of `blog-preview`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**blogHeading** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Heading.

**blogSubheading** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Subheading.

**blogCardImageAspect** `BlogCardImageAspect | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Aspect ratio of the featured image. Choose “Hidden” for text-only cards. One of `16/10`, `4/3`, `3/2`, `1/1`, `none`; a newer site may send others, so keep a fallback.

**blogCardImageHover** `BlogCardImageHover | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Image hover. One of `zoom`, `none`; a newer site may send others, so keep a fallback.

**blogCardImageFill** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Use the featured image as the full card background, with the title and meta overlaid on a dark scrim. Posts with no image fall back to a normal card.

**blogCardPreset** `BlogCardPreset | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The card surface. Raised is a quiet lit card; Luxe a frosted glass panel; Outline a plaque frame; Spine adds a color rail; Tint an accent wash; Ticket/Bracket/Forge/Press/Inlay are the graphic showstoppers. (On image-led cards the photo covers the top edge.) One of `raised`, `luxe`, `outline`, `plain`, `poster`, `edge`, `tint`, `ticket`, `bracket`, `forge`, `press`, `inlay`; a newer site may send others, so keep a fallback.

**blogCardPresetRadius** `BlogCardPresetRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner rounding for each card. Default keeps the widget’s own tuned corners — except Forge, which defaults to tight machined corners matching its engraved frame. One of `default`, `square`, `slight`, `rounded`, `large`; a newer site may send others, so keep a fallback.

**blogCardPresetAccentColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Colors the Spine rail, Bracket marks, Forge corner/frame and Press margin rule. Leave empty to use the brand accent.

**blogCardPresetAccentColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**blogCardPresetForgeScope** `BlogCardPresetForgeScope | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the Forge plate wears its color: a single corner mark (the machinist’s datum, default) or the whole engraved frame. One of `corner`, `frame`; a newer site may send others, so keep a fallback.

**blogCardPresetForgeWeight** `BlogCardPresetForgeWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Thickness of the Forge corner mark / colored frame. One of `fine`, `medium`, `bold`; a newer site may send others, so keep a fallback.

**blogCardHover** `BlogCardHover | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. What a card does on hover. Lift/Pop/Press/Glow/Outline are instant; Sheen sweeps a light across; Tilt (3-D + glare), Magnetic and Spotlight follow the cursor (need site animations on). The Hover color below tints these. One of `none`, `lift`, `pop`, `press`, `glow`, `border`, `sheen`, `tilt`, `magnetic`, `spotlight`; a newer site may send others, so keep a fallback.

**blogCardHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Border / shadow / glow color on hover. Leave empty to use the site accent color.

**blogCardHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the accent.

**blogCardShowCategory** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Show category.

**blogCardCategoryStyle** `BlogCardCategoryStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. How the category badge uses its color (set per category under Blog Categories). Filled = colored background; Outline = colored border + text; Minimal = colored text only. One of `filled`, `outline`, `minimal`; a newer site may send others, so keep a fallback.

**blogCardShowDate** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Show date.

**blogCardShowExcerpt** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Show excerpt.

**blogCardExcerptLines** `BlogCardExcerptLines | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. How many lines of the excerpt to show before truncating. One of `2`, `3`, `4`, `none`; a newer site may send others, so keep a fallback.

**blogCardShowAuthor** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Show author.

**blogCardShowReadMore** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Show “Read post” link.

**blogCardReadMorePlacement** `BlogCardReadMorePlacement | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Auto puts it on the right of horizontal cards (list / compact / featured) and below the text on grid cards. Or force one placement everywhere. One of `auto`, `below`, `right`; a newer site may send others, so keep a fallback.

**blogCardReadMoreColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Overrides the “Read post” link color. Leave empty to use the site accent color.

**blogCardReadMoreColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the accent.

**blogCardReadMoreHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Color of the “Read post” link when the card is hovered. Leave empty to use the accent color.

**blogCardReadMoreHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme hover color, then the accent.

**blogCardTitleColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Overrides the card title color. Leave empty to track the theme’s text color.

**blogCardTitleColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the theme default.

**blogCardTitleWeight** `BlogCardTitleWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Title weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**blogCardTitleHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Title color when the card is hovered. Leave empty to use the site accent color.

**blogCardTitleHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme hover color, then the accent.

**blogCardTextColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Overrides the excerpt text color. Leave empty for the muted default.

**blogCardTextColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the muted default.

**blogCardTextWeight** `BlogCardTextWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Excerpt weight. One of `normal`, `medium`, `semibold`, `bold`; a newer site may send others, so keep a fallback.

**blogCardMetaColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Date / meta line color. Leave empty for the faint default.

**blogCardMetaColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the faint default.

**blogBg** `BlogBg | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The section’s full-width background band in dark mode. Transparent lets the page background show through. The palette options track the site colors; choose “Custom color…” for a specific color. One of `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**blogBgCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (dark theme)” is set to Custom color.

**blogBgLight** `BlogBgLight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. “Match dark theme” reuses the dark-theme choice; otherwise set the light-mode band independently. One of `inherit`, `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**blogBgLightCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (light theme)” is set to Custom color.

**blogFontOverrides** `readonly BlogPreviewWidgetBlogFontOverridesItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `BlogPreviewWidgetBlogFontOverridesItem`. Optional. Set part of this section in a different typeface. Leave empty to follow the site’s fonts (Site design → Typography). At most 4 items.

**BlogPreviewWidgetBlogFontOverridesItem**

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**target** `Target | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which text this typeface replaces. Rows apply in order, so a broad row (Everything) followed by a narrow one (Headings) gives the section a base face plus an exception. One of `all`, `heading`, `body`, `eyebrow`, `button`, `code`; a newer site may send others, so keep a fallback.

**source** `Source | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the typeface comes from. The first option costs nothing extra — those faces are already loaded. The others load an additional font on pages that use this section. One of `slot`, `curated`, `cdn`, `upload`; a newer site may send others, so keep a fallback.

**slot** `Slot | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Set in Site design → Typography. Following the site’s own faces keeps a section on-brand and adds no download. One of `display`, `body`, `accent`; a newer site may send others, so keep a fallback.

**curated** `Curated | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Vetted families from Bunny Fonts and Fontshare, with their available weights already verified. One of `archivo`, `bricolage-grotesque`, `clash-display`, `courier-prime`, `dm-mono`, `dm-sans`, `fira-code`, `fraunces`, `general-sans`, `ibm-plex-mono`, `ibm-plex-sans`, `inconsolata`, `inter`, `jetbrains-mono`, `karla`, `lora`, `manrope`, `nunito-sans`, `outfit`, `playfair-display`, `public-sans`, `red-hat-mono`, `satoshi`, `sentient`, `sora`, `source-code-pro`, `source-sans-3`, `source-serif-4`, `space-grotesk`, `space-mono`, `spline-sans-mono`, `supreme`, `switzer`, `syne`, `ubuntu-mono`, `unbounded`, `victor-mono`, `work-sans`, `zodiak`; a newer site may send others, so keep a fallback.

**cdnProvider** `CdnProvider | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where to browse for the family. Pick one, then follow the link below to find the exact name. One of `bunny`, `fontshare`; a newer site may send others, so keep a fallback.

**cdnFamily** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Exactly as the provider’s catalog spells it, e.g. "Space Grotesk" or "Clash Display". A name the provider doesn’t have loads nothing and this row is ignored.

**cdnWeights** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 500, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold) — but a family that ships only ONE weight (Acme, for instance) loads nothing at all unless that weight is among these, so set it explicitly if the typeface doesn’t appear.

**uploads** `readonly BlogPreviewWidgetBlogFontOverridesItemUploadsItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `BlogPreviewWidgetBlogFontOverridesItemUploadsItem`. One file per weight/style of the SAME typeface. woff2 strongly recommended (smallest, universally supported); woff/ttf/otf also accepted. At most 4 items.

**BlogPreviewWidgetBlogFontOverridesItemUploadsItem**

**file** `Readonly\<Record\<string, unknown\>\>`

**Always sent.** File attachment reference.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**weight** `Weight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Weight. One of `100`, `200`, `300`, `400`, `500`, `600`, `700`, `800`, `900`; a newer site may send others, so keep a fallback.

**style** `Style | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Style. One of `normal`, `italic`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**fallback** `Fallback | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Generic system font shown while this typeface loads (and if it fails). Curated picks set this automatically. One of `sans`, `serif`, `mono`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**blogCtaLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The visible button text. Leave empty to hide the button.

**blogCtaUrl** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Where the button goes — a path (/blog) or full URL.

**blogCtaNewTab** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Opens the link in a new browser tab (adds rel="noopener noreferrer").

**blogCtaVariant** `BlogCtaVariant | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fills with the color; Outline / Soft / Text link use it for the border + text. One of `solid`, `outline`, `soft`, `link`; a newer site may send others, so keep a fallback.

**blogCtaSize** `BlogCtaSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Button size. One of `small`, `normal`, `large`; a newer site may send others, so keep a fallback.

**blogCtaRadius** `BlogCtaRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner radius. One of `pill`, `rounded`, `slight`, `square`; a newer site may send others, so keep a fallback.

**blogCtaColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fill, or the border + text for the other styles. Defaults to the brand accent; CLEAR it for a transparent, outline-only button.

**blogCtaColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color. (Brand tokens already flip per theme.)

**blogCtaTextColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The text/icon color. Clear it to derive from the button color (readable on solid fills).

**blogCtaTextColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme label color.

**blogCtaHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Drives the hover treatment. Leave empty to derive it from the button color.

**blogCtaHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme hover color.

**blogCtaStyle** `BlogCtaStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The hover treatment: a soft shadow, a colored offset shadow, a glow, a fill sweep, or a thicker border. One of `none`, `single`, `dual`, `glow`, `sweep`, `thicken`; a newer site may send others, so keep a fallback.

**blogCtaShadowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. The offset-shadow or glow color on hover. Leave empty to use the site secondary color.

**blogCtaShadowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme shadow color.

**blogCtaAnimation** `BlogCtaAnimation | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Hover motion. One of `lift`, `scale`, `lift-scale`, `none`; a newer site may send others, so keep a fallback.

**blogCtaIcon** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.

**blogCtaIconFamily** `BlogCtaIconFamily | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon family. One of `classic-regular`, `duotone-regular`, `brands`, `jelly`, `jelly-duo`, `whiteboard`; a newer site may send others, so keep a fallback.

**blogCtaIconPosition** `BlogCtaIconPosition | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which side of the label the icon sits on (when an icon name is set). One of `before`, `after`; a newer site may send others, so keep a fallback.

**blogCtaIconNudge** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. The icon slides toward its side on hover (e.g. an arrow edges outward).

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**CookieDeclarationWidget**

A `cookie-declaration` widget: its `type` and its own fields. A field left out takes its default.

**type** `CookieDeclarationWidgetType`

**Always sent.** The widget’s type: always `cookie-declaration`. One of `cookie-declaration`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**cookieDeclEyebrow** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Eyebrow.

**cookieDeclHeading** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Heading.

**cookieDeclIntro** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Introduction.

**cookieDeclShowStatus** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. A short block naming what this visitor has allowed, with a button that reopens the preferences panel. Withdrawal has to be as easy as consent, so leave this on unless the page offers another way.

**cookieDeclShowTable** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Provider, type, duration and domain per entry. Off leaves the plain-language disclosures alone, which reads better but tells a technical reader less.

**cookieDeclLayout** `CookieDeclLayout | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Layout. One of `stacked`, `compact`; a newer site may send others, so keep a fallback.

**cookieDeclBg** `CookieDeclBg | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The section’s full-width background band in dark mode. Transparent lets the page background show through. The palette options track the site colors; choose “Custom color…” for a specific color. One of `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**cookieDeclBgCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (dark theme)” is set to Custom color.

**cookieDeclBgLight** `CookieDeclBgLight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. “Match dark theme” reuses the dark-theme choice; otherwise set the light-mode band independently. One of `inherit`, `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**cookieDeclBgLightCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (light theme)” is set to Custom color.

**cookieDeclFontOverrides** `readonly CookieDeclarationWidgetCookieDeclFontOverridesItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `CookieDeclarationWidgetCookieDeclFontOverridesItem`. Optional. Set part of this section in a different typeface. Leave empty to follow the site’s fonts (Site design → Typography). At most 4 items.

**CookieDeclarationWidgetCookieDeclFontOverridesItem**

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**target** `Target | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which text this typeface replaces. Rows apply in order, so a broad row (Everything) followed by a narrow one (Headings) gives the section a base face plus an exception. One of `all`, `heading`, `body`, `eyebrow`, `button`, `code`; a newer site may send others, so keep a fallback.

**source** `Source | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the typeface comes from. The first option costs nothing extra — those faces are already loaded. The others load an additional font on pages that use this section. One of `slot`, `curated`, `cdn`, `upload`; a newer site may send others, so keep a fallback.

**slot** `Slot | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Set in Site design → Typography. Following the site’s own faces keeps a section on-brand and adds no download. One of `display`, `body`, `accent`; a newer site may send others, so keep a fallback.

**curated** `Curated | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Vetted families from Bunny Fonts and Fontshare, with their available weights already verified. One of `archivo`, `bricolage-grotesque`, `clash-display`, `courier-prime`, `dm-mono`, `dm-sans`, `fira-code`, `fraunces`, `general-sans`, `ibm-plex-mono`, `ibm-plex-sans`, `inconsolata`, `inter`, `jetbrains-mono`, `karla`, `lora`, `manrope`, `nunito-sans`, `outfit`, `playfair-display`, `public-sans`, `red-hat-mono`, `satoshi`, `sentient`, `sora`, `source-code-pro`, `source-sans-3`, `source-serif-4`, `space-grotesk`, `space-mono`, `spline-sans-mono`, `supreme`, `switzer`, `syne`, `ubuntu-mono`, `unbounded`, `victor-mono`, `work-sans`, `zodiak`; a newer site may send others, so keep a fallback.

**cdnProvider** `CdnProvider | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where to browse for the family. Pick one, then follow the link below to find the exact name. One of `bunny`, `fontshare`; a newer site may send others, so keep a fallback.

**cdnFamily** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Exactly as the provider’s catalog spells it, e.g. "Space Grotesk" or "Clash Display". A name the provider doesn’t have loads nothing and this row is ignored.

**cdnWeights** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 500, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold) — but a family that ships only ONE weight (Acme, for instance) loads nothing at all unless that weight is among these, so set it explicitly if the typeface doesn’t appear.

**uploads** `readonly CookieDeclarationWidgetCookieDeclFontOverridesItemUploadsItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `CookieDeclarationWidgetCookieDeclFontOverridesItemUploadsItem`. One file per weight/style of the SAME typeface. woff2 strongly recommended (smallest, universally supported); woff/ttf/otf also accepted. At most 4 items.

**CookieDeclarationWidgetCookieDeclFontOverridesItemUploadsItem**

**file** `Readonly\<Record\<string, unknown\>\>`

**Always sent.** File attachment reference.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**weight** `Weight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Weight. One of `100`, `200`, `300`, `400`, `500`, `600`, `700`, `800`, `900`; a newer site may send others, so keep a fallback.

**style** `Style | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Style. One of `normal`, `italic`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**fallback** `Fallback | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Generic system font shown while this typeface loads (and if it fails). Curated picks set this automatically. One of `sans`, `serif`, `mono`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**RichTextWidget**

A `@apostrophecms/rich-text` widget: its `type` and its own fields. A field left out takes its default.

**type** `RichTextWidgetType`

**Always sent.** The widget’s type: always `@apostrophecms/rich-text`. One of `@apostrophecms/rich-text`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**content** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The text as HTML, e.g. `<h2>Our story</h2><p>It began with <strong>one</strong> idea.</p>`. The site keeps the tags and styles this area’s editor offers (paragraphs, headings, bold, italic, links, lists…) and removes the rest.

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**PricingWidget**

A `pricing` widget: its `type` and its own fields. A field left out takes its default.

**type** `PricingWidgetType`

**Always sent.** The widget’s type: always `pricing`. One of `pricing`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**pricingEyebrowEnabled** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. A small label above the heading (e.g. "Pricing").

**pricingEyebrow** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Eyebrow.

**pricingEyebrowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the secondary (mint) color.

**pricingEyebrowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**pricingEyebrowWeight** `PricingEyebrowWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**pricingEyebrowSize** `PricingEyebrowSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**pricingHeading** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional. Leave empty to show just the cards.

**pricingHeadingColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to track the theme text color.

**pricingHeadingColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**pricingHeadingWeight** `PricingHeadingWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Heading weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**pricingHeadingSize** `PricingHeadingSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Heading size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**pricingIntro** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional short sentence under the heading.

**pricingIntroColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the muted text color.

**pricingIntroColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**pricingIntroWeight** `PricingIntroWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Intro weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**pricingIntroSize** `PricingIntroSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Intro size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**pricingColumns** `PricingColumns | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Auto fits as many as comfortably fit and works for any number of cards. Or lock a maximum per row. One of `auto`, `2`, `3`, `4`; a newer site may send others, so keep a fallback.

**pricingGap** `PricingGap | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Gap between cards. One of `tight`, `normal`, `roomy`; a newer site may send others, so keep a fallback.

**pricingCardStyle** `PricingCardStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The base treatment for every tier (a highlighted tier always gets its own bold framed look). Raised is a quiet lit card; Luxe a frosted glass panel; Outline a plaque frame; Spine adds a color rail; Tint an accent wash; Ticket/Bracket/Forge/Press/Inlay are the graphic showstoppers. One of `raised`, `luxe`, `outline`, `plain`, `poster`, `edge`, `tint`, `ticket`, `bracket`, `forge`, `press`, `inlay`; a newer site may send others, so keep a fallback.

**pricingCardStyleRadius** `PricingCardStyleRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner rounding for each card. Default keeps the widget’s own tuned corners — except Forge, which defaults to tight machined corners matching its engraved frame. One of `default`, `square`, `slight`, `rounded`, `large`; a newer site may send others, so keep a fallback.

**pricingCardStyleAccentColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Colors the Spine rail, Bracket marks, Forge corner/frame and Press margin rule. Leave empty to use the brand accent.

**pricingCardStyleAccentColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**pricingCardStyleForgeScope** `PricingCardStyleForgeScope | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the Forge plate wears its color: a single corner mark (the machinist’s datum, default) or the whole engraved frame. One of `corner`, `frame`; a newer site may send others, so keep a fallback.

**pricingCardStyleForgeWeight** `PricingCardStyleForgeWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Thickness of the Forge corner mark / colored frame. One of `fine`, `medium`, `bold`; a newer site may send others, so keep a fallback.

**pricingAlign** `PricingAlign | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Aligns the section header and the text inside each card. One of `center`, `left`; a newer site may send others, so keep a fallback.

**pricingEqualHeight** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Stretch every card to the tallest one and pin each button to the bottom, so the cards line up even with uneven feature lists.

**pricingFeatureMarkers** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. A check (included) or cross (not included) before each feature. Off = a plain list.

**pricingCardHover** `PricingCardHover | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. How a card reacts to the pointer. Rise floats it up on an accent underglow; Selection ring previews the highlighted look + tints the price; Spotlight washes accent light over the price; Checklist lights up the ✓ marks one-by-one; Tilt is a 3-D parallax that only runs when site animations are on. One of `none`, `rise`, `ring`, `spotlight`, `checklist`, `tilt`; a newer site may send others, so keep a fallback.

**pricingHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Border / glow / spotlight / checkmark color on hover. Leave empty to use the highlight accent (then the site accent).

**pricingHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme hover accent.

**pricingEntrance** `PricingEntrance | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. How the cards animate in as they scroll into view. Featured-led makes the highlighted tier settle last with a little emphasis (draws the eye to the recommended plan); Simple stagger fades them in evenly. Only plays when site animations are on (Site design → Motion) — otherwise the cards are simply shown. One of `featured`, `stagger`, `none`; a newer site may send others, so keep a fallback.

**pricingNameSize** `PricingNameSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Size of each card’s name / title. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**pricingPriceSize** `PricingPriceSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Size of the price amount (the period and price note scale with it). One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**pricingDescSize** `PricingDescSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Size of each card’s description blurb. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**pricingFeatureSize** `PricingFeatureSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Size of the feature list text (notes and check marks scale with it). One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**pricingHighlightBadge** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Ribbon text shown on a highlighted tier that doesn’t set its own badge. Each tier can override it (or badge a non-highlighted tier) below. Leave empty for no automatic badge.

**pricingAccentColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Color for the highlighted tier’s border + ring and each tier’s badge. Leave empty to use the site accent color.

**pricingAccentColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme accent.

**pricingTiers** `readonly PricingWidgetPricingTiersItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `PricingWidgetPricingTiersItem`. Each card is one tier / package / service. Toggle “Highlight” on the one you want to stand out. Its fields are listed under the first `PricingWidgetPricingTiersItem` above.

**pricingBg** `PricingBg | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The section’s full-width background band in dark mode. Transparent lets the page background show through. The palette options track the site colors; choose “Custom color…” for a specific color. One of `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**pricingBgCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (dark theme)” is set to Custom color.

**pricingBgLight** `PricingBgLight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. “Match dark theme” reuses the dark-theme choice; otherwise set the light-mode band independently. One of `inherit`, `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**pricingBgLightCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (light theme)” is set to Custom color.

**pricingFontOverrides** `readonly PricingWidgetPricingFontOverridesItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `PricingWidgetPricingFontOverridesItem`. Optional. Set part of this section in a different typeface. Leave empty to follow the site’s fonts (Site design → Typography). At most 4 items. Its fields are listed under the first `PricingWidgetPricingFontOverridesItem` above.

**pricingFeaturedCtaLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The visible button text. Leave empty to hide the button.

**pricingFeaturedCtaUrl** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Where the button goes — a path (/blog) or full URL.

**pricingFeaturedCtaNewTab** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Opens the link in a new browser tab (adds rel="noopener noreferrer").

**pricingFeaturedCtaVariant** `PricingFeaturedCtaVariant | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fills with the color; Outline / Soft / Text link use it for the border + text. One of `solid`, `outline`, `soft`, `link`; a newer site may send others, so keep a fallback.

**pricingFeaturedCtaSize** `PricingFeaturedCtaSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Button size. One of `small`, `normal`, `large`; a newer site may send others, so keep a fallback.

**pricingFeaturedCtaRadius** `PricingFeaturedCtaRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner radius. One of `pill`, `rounded`, `slight`, `square`; a newer site may send others, so keep a fallback.

**pricingFeaturedCtaColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fill, or the border + text for the other styles. Defaults to the brand accent; CLEAR it for a transparent, outline-only button.

**pricingFeaturedCtaColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color. (Brand tokens already flip per theme.)

**pricingFeaturedCtaTextColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The text/icon color. Clear it to derive from the button color (readable on solid fills).

**pricingFeaturedCtaTextColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme label color.

**pricingFeaturedCtaHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Drives the hover treatment. Leave empty to derive it from the button color.

**pricingFeaturedCtaHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme hover color.

**pricingFeaturedCtaStyle** `PricingFeaturedCtaStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The hover treatment: a soft shadow, a colored offset shadow, a glow, a fill sweep, or a thicker border. One of `none`, `single`, `dual`, `glow`, `sweep`, `thicken`; a newer site may send others, so keep a fallback.

**pricingFeaturedCtaShadowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. The offset-shadow or glow color on hover. Leave empty to use the site secondary color.

**pricingFeaturedCtaShadowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme shadow color.

**pricingFeaturedCtaAnimation** `PricingFeaturedCtaAnimation | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Hover motion. One of `lift`, `scale`, `lift-scale`, `none`; a newer site may send others, so keep a fallback.

**pricingFeaturedCtaIcon** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.

**pricingFeaturedCtaIconFamily** `PricingFeaturedCtaIconFamily | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon family. One of `classic-regular`, `duotone-regular`, `brands`, `jelly`, `jelly-duo`, `whiteboard`; a newer site may send others, so keep a fallback.

**pricingFeaturedCtaIconPosition** `PricingFeaturedCtaIconPosition | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which side of the label the icon sits on (when an icon name is set). One of `before`, `after`; a newer site may send others, so keep a fallback.

**pricingFeaturedCtaIconNudge** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. The icon slides toward its side on hover (e.g. an arrow edges outward).

**pricingCtaLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The visible button text. Leave empty to hide the button.

**pricingCtaUrl** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Where the button goes — a path (/blog) or full URL.

**pricingCtaNewTab** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Opens the link in a new browser tab (adds rel="noopener noreferrer").

**pricingCtaVariant** `PricingCtaVariant | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fills with the color; Outline / Soft / Text link use it for the border + text. One of `solid`, `outline`, `soft`, `link`; a newer site may send others, so keep a fallback.

**pricingCtaSize** `PricingCtaSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Button size. One of `small`, `normal`, `large`; a newer site may send others, so keep a fallback.

**pricingCtaRadius** `PricingCtaRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner radius. One of `pill`, `rounded`, `slight`, `square`; a newer site may send others, so keep a fallback.

**pricingCtaColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fill, or the border + text for the other styles. Defaults to the brand accent; CLEAR it for a transparent, outline-only button.

**pricingCtaColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color. (Brand tokens already flip per theme.)

**pricingCtaTextColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The text/icon color. Clear it to derive from the button color (readable on solid fills).

**pricingCtaTextColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme label color.

**pricingCtaHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Drives the hover treatment. Leave empty to derive it from the button color.

**pricingCtaHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme hover color.

**pricingCtaStyle** `PricingCtaStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The hover treatment: a soft shadow, a colored offset shadow, a glow, a fill sweep, or a thicker border. One of `none`, `single`, `dual`, `glow`, `sweep`, `thicken`; a newer site may send others, so keep a fallback.

**pricingCtaShadowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. The offset-shadow or glow color on hover. Leave empty to use the site secondary color.

**pricingCtaShadowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme shadow color.

**pricingCtaAnimation** `PricingCtaAnimation | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Hover motion. One of `lift`, `scale`, `lift-scale`, `none`; a newer site may send others, so keep a fallback.

**pricingCtaIcon** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.

**pricingCtaIconFamily** `PricingCtaIconFamily | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon family. One of `classic-regular`, `duotone-regular`, `brands`, `jelly`, `jelly-duo`, `whiteboard`; a newer site may send others, so keep a fallback.

**pricingCtaIconPosition** `PricingCtaIconPosition | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which side of the label the icon sits on (when an icon name is set). One of `before`, `after`; a newer site may send others, so keep a fallback.

**pricingCtaIconNudge** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. The icon slides toward its side on hover (e.g. an arrow edges outward).

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**NewsletterWidget**

A `newsletter` widget: its `type` and its own fields. A field left out takes its default.

**type** `NewsletterWidgetType`

**Always sent.** The widget’s type: always `newsletter`. One of `newsletter`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**newsletterForm** `readonly Readonly\<Record\<string, unknown\>\>[]`

**Sometimes sent:** `undefined` when the site leaves it out. The Form (Forms manager) that receives these submissions and routes them — configure its destinations on the form’s Actions tab. Create one if you have not yet. The related `@apostrophecms/form` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.

**newsletterEyebrowEnabled** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Show eyebrow.

**newsletterEyebrow** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Small label shown above the title.

**newsletterEyebrowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Overrides the eyebrow + its dash. Leave empty to use the secondary (mint) color.

**newsletterEyebrowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the mint default.

**newsletterEyebrowWeight** `NewsletterEyebrowWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**newsletterEyebrowSize** `NewsletterEyebrowSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**newsletterHeading** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Heading.

**newsletterHeadingColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to track the theme text color.

**newsletterHeadingColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**newsletterHeadingWeight** `NewsletterHeadingWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**newsletterHeadingSize** `NewsletterHeadingSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**newsletterIntro** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional short sentence under the heading.

**newsletterIntroColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the muted text color.

**newsletterIntroColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**newsletterIntroWeight** `NewsletterIntroWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**newsletterIntroSize** `NewsletterIntroSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**newsletterBand** `NewsletterBand | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Plain sits on the page; Raised is a contained card; Accent is a solid brand-color band. One of `plain`, `raised`, `accent`; a newer site may send others, so keep a fallback.

**newsletterAccentColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The accent band color. Leave empty to use the site accent color.

**newsletterAccentColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the accent.

**newsletterAlign** `NewsletterAlign | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Alignment. One of `center`, `left`; a newer site may send others, so keep a fallback.

**newsletterLayout** `NewsletterLayout | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Inline puts the field + button on one row (stacks on small screens); Stacked always stacks them. One of `inline`, `stacked`; a newer site may send others, so keep a fallback.

**newsletterWidth** `NewsletterWidth | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Content width. One of `narrow`, `normal`, `wide`; a newer site may send others, so keep a fallback.

**newsletterNameEnabled** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Collect a name.

**newsletterNameLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Name label.

**newsletterNamePlaceholder** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Name placeholder.

**newsletterEmailLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Email label.

**newsletterEmailPlaceholder** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Email placeholder.

**newsletterConsentEnabled** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Optional opt-in checkbox (e.g. for GDPR-style explicit consent).

**newsletterConsentText** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Consent statement.

**newsletterDisclaimer** `string`

**Sometimes sent:** `undefined` when the site leaves it out. A small line under the form, e.g. an unsubscribe note.

**newsletterSuccessMessage** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Success message.

**newsletterErrorMessage** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Error message.

**newsletterBg** `NewsletterBg | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The section’s full-width background band in dark mode. Transparent lets the page background show through. The palette options track the site colors; choose “Custom color…” for a specific color. One of `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**newsletterBgCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (dark theme)” is set to Custom color.

**newsletterBgLight** `NewsletterBgLight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. “Match dark theme” reuses the dark-theme choice; otherwise set the light-mode band independently. One of `inherit`, `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**newsletterBgLightCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (light theme)” is set to Custom color.

**newsletterFontOverrides** `readonly NewsletterWidgetNewsletterFontOverridesItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `NewsletterWidgetNewsletterFontOverridesItem`. Optional. Set part of this section in a different typeface. Leave empty to follow the site’s fonts (Site design → Typography). At most 4 items.

**NewsletterWidgetNewsletterFontOverridesItem**

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**target** `Target | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which text this typeface replaces. Rows apply in order, so a broad row (Everything) followed by a narrow one (Headings) gives the section a base face plus an exception. One of `all`, `heading`, `body`, `eyebrow`, `button`, `code`; a newer site may send others, so keep a fallback.

**source** `Source | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the typeface comes from. The first option costs nothing extra — those faces are already loaded. The others load an additional font on pages that use this section. One of `slot`, `curated`, `cdn`, `upload`; a newer site may send others, so keep a fallback.

**slot** `Slot | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Set in Site design → Typography. Following the site’s own faces keeps a section on-brand and adds no download. One of `display`, `body`, `accent`; a newer site may send others, so keep a fallback.

**curated** `Curated | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Vetted families from Bunny Fonts and Fontshare, with their available weights already verified. One of `archivo`, `bricolage-grotesque`, `clash-display`, `courier-prime`, `dm-mono`, `dm-sans`, `fira-code`, `fraunces`, `general-sans`, `ibm-plex-mono`, `ibm-plex-sans`, `inconsolata`, `inter`, `jetbrains-mono`, `karla`, `lora`, `manrope`, `nunito-sans`, `outfit`, `playfair-display`, `public-sans`, `red-hat-mono`, `satoshi`, `sentient`, `sora`, `source-code-pro`, `source-sans-3`, `source-serif-4`, `space-grotesk`, `space-mono`, `spline-sans-mono`, `supreme`, `switzer`, `syne`, `ubuntu-mono`, `unbounded`, `victor-mono`, `work-sans`, `zodiak`; a newer site may send others, so keep a fallback.

**cdnProvider** `CdnProvider | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where to browse for the family. Pick one, then follow the link below to find the exact name. One of `bunny`, `fontshare`; a newer site may send others, so keep a fallback.

**cdnFamily** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Exactly as the provider’s catalog spells it, e.g. "Space Grotesk" or "Clash Display". A name the provider doesn’t have loads nothing and this row is ignored.

**cdnWeights** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 500, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold) — but a family that ships only ONE weight (Acme, for instance) loads nothing at all unless that weight is among these, so set it explicitly if the typeface doesn’t appear.

**uploads** `readonly NewsletterWidgetNewsletterFontOverridesItemUploadsItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `NewsletterWidgetNewsletterFontOverridesItemUploadsItem`. One file per weight/style of the SAME typeface. woff2 strongly recommended (smallest, universally supported); woff/ttf/otf also accepted. At most 4 items.

**NewsletterWidgetNewsletterFontOverridesItemUploadsItem**

**file** `Readonly\<Record\<string, unknown\>\>`

**Always sent.** File attachment reference.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**weight** `Weight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Weight. One of `100`, `200`, `300`, `400`, `500`, `600`, `700`, `800`, `900`; a newer site may send others, so keep a fallback.

**style** `Style | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Style. One of `normal`, `italic`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**fallback** `Fallback | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Generic system font shown while this typeface loads (and if it fails). Curated picks set this automatically. One of `sans`, `serif`, `mono`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**newsletterSubmitLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The visible button text. Leave empty to hide the button.

**newsletterSubmitVariant** `NewsletterSubmitVariant | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fills with the color; Outline / Soft / Text link use it for the border + text. One of `solid`, `outline`, `soft`, `link`; a newer site may send others, so keep a fallback.

**newsletterSubmitSize** `NewsletterSubmitSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Button size. One of `small`, `normal`, `large`; a newer site may send others, so keep a fallback.

**newsletterSubmitRadius** `NewsletterSubmitRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner radius. One of `pill`, `rounded`, `slight`, `square`; a newer site may send others, so keep a fallback.

**newsletterSubmitColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fill, or the border + text for the other styles. Defaults to the brand accent; CLEAR it for a transparent, outline-only button.

**newsletterSubmitColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color. (Brand tokens already flip per theme.)

**newsletterSubmitTextColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The text/icon color. Clear it to derive from the button color (readable on solid fills).

**newsletterSubmitTextColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme label color.

**newsletterSubmitHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Drives the hover treatment. Leave empty to derive it from the button color.

**newsletterSubmitHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme hover color.

**newsletterSubmitStyle** `NewsletterSubmitStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The hover treatment: a soft shadow, a colored offset shadow, a glow, a fill sweep, or a thicker border. One of `none`, `single`, `dual`, `glow`, `sweep`, `thicken`; a newer site may send others, so keep a fallback.

**newsletterSubmitShadowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. The offset-shadow or glow color on hover. Leave empty to use the site secondary color.

**newsletterSubmitShadowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme shadow color.

**newsletterSubmitAnimation** `NewsletterSubmitAnimation | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Hover motion. One of `lift`, `scale`, `lift-scale`, `none`; a newer site may send others, so keep a fallback.

**newsletterSubmitIcon** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.

**newsletterSubmitIconFamily** `NewsletterSubmitIconFamily | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon family. One of `classic-regular`, `duotone-regular`, `brands`, `jelly`, `jelly-duo`, `whiteboard`; a newer site may send others, so keep a fallback.

**newsletterSubmitIconPosition** `NewsletterSubmitIconPosition | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which side of the label the icon sits on (when an icon name is set). One of `before`, `after`; a newer site may send others, so keep a fallback.

**newsletterSubmitIconNudge** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. The icon slides toward its side on hover (e.g. an arrow edges outward).

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**SmsSignupWidget**

A `sms-signup` widget: its `type` and its own fields. A field left out takes its default.

**type** `SmsSignupWidgetType`

**Always sent.** The widget’s type: always `sms-signup`. One of `sms-signup`; a newer site may send others, so keep a fallback.

**smsSignupConsentText** `string`

**Always sent.** Shown beside a required checkbox; the form shows only once this is filled in. Be specific about what they are agreeing to. The brand name is added automatically from Site settings.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**smsSignupForm** `readonly Readonly\<Record\<string, unknown\>\>[]`

**Sometimes sent:** `undefined` when the site leaves it out. The Form (Forms manager) that receives these SMS opt-ins and routes them — configure its destinations on the form’s Actions tab. The related `@apostrophecms/form` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.

**smsSignupEyebrowEnabled** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Show eyebrow.

**smsSignupEyebrow** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Small label shown above the title.

**smsSignupEyebrowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Overrides the eyebrow + its dash. Leave empty to use the secondary (mint) color.

**smsSignupEyebrowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the mint default.

**smsSignupEyebrowWeight** `SmsSignupEyebrowWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**smsSignupEyebrowSize** `SmsSignupEyebrowSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**smsSignupHeading** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Heading.

**smsSignupHeadingColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to track the theme text color.

**smsSignupHeadingColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**smsSignupHeadingWeight** `SmsSignupHeadingWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**smsSignupHeadingSize** `SmsSignupHeadingSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**smsSignupIntro** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional short sentence under the heading.

**smsSignupIntroColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the muted text color.

**smsSignupIntroColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**smsSignupIntroWeight** `SmsSignupIntroWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**smsSignupIntroSize** `SmsSignupIntroSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**smsSignupBand** `SmsSignupBand | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Plain sits on the page; Raised is a contained card; Accent is a solid brand-color band. One of `plain`, `raised`, `accent`; a newer site may send others, so keep a fallback.

**smsSignupAccentColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The accent band color. Leave empty to use the site accent color.

**smsSignupAccentColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the accent.

**smsSignupAlign** `SmsSignupAlign | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Alignment. One of `center`, `left`; a newer site may send others, so keep a fallback.

**smsSignupLayout** `SmsSignupLayout | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Inline puts the field + button on one row (stacks on small screens); Stacked always stacks them. One of `inline`, `stacked`; a newer site may send others, so keep a fallback.

**smsSignupWidth** `SmsSignupWidth | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Content width. One of `narrow`, `normal`, `wide`; a newer site may send others, so keep a fallback.

**smsSignupNameEnabled** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Collect a name.

**smsSignupNameLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Name label.

**smsSignupNamePlaceholder** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Name placeholder.

**smsSignupPhoneLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Phone label.

**smsSignupPhonePlaceholder** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Phone placeholder.

**smsSignupTermsText** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Carrier-compliance fine print shown under the form.

**smsSignupPrivacyUrl** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional — linked from the fine print.

**smsSignupTermsUrl** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional — linked from the fine print.

**smsSignupSuccessMessage** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Success message.

**smsSignupErrorMessage** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Error message.

**smsSignupBg** `SmsSignupBg | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The section’s full-width background band in dark mode. Transparent lets the page background show through. The palette options track the site colors; choose “Custom color…” for a specific color. One of `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**smsSignupBgCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (dark theme)” is set to Custom color.

**smsSignupBgLight** `SmsSignupBgLight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. “Match dark theme” reuses the dark-theme choice; otherwise set the light-mode band independently. One of `inherit`, `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**smsSignupBgLightCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (light theme)” is set to Custom color.

**smsSignupFontOverrides** `readonly SmsSignupWidgetSmsSignupFontOverridesItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `SmsSignupWidgetSmsSignupFontOverridesItem`. Optional. Set part of this section in a different typeface. Leave empty to follow the site’s fonts (Site design → Typography). At most 4 items.

**SmsSignupWidgetSmsSignupFontOverridesItem**

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**target** `Target | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which text this typeface replaces. Rows apply in order, so a broad row (Everything) followed by a narrow one (Headings) gives the section a base face plus an exception. One of `all`, `heading`, `body`, `eyebrow`, `button`, `code`; a newer site may send others, so keep a fallback.

**source** `Source | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the typeface comes from. The first option costs nothing extra — those faces are already loaded. The others load an additional font on pages that use this section. One of `slot`, `curated`, `cdn`, `upload`; a newer site may send others, so keep a fallback.

**slot** `Slot | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Set in Site design → Typography. Following the site’s own faces keeps a section on-brand and adds no download. One of `display`, `body`, `accent`; a newer site may send others, so keep a fallback.

**curated** `Curated | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Vetted families from Bunny Fonts and Fontshare, with their available weights already verified. One of `archivo`, `bricolage-grotesque`, `clash-display`, `courier-prime`, `dm-mono`, `dm-sans`, `fira-code`, `fraunces`, `general-sans`, `ibm-plex-mono`, `ibm-plex-sans`, `inconsolata`, `inter`, `jetbrains-mono`, `karla`, `lora`, `manrope`, `nunito-sans`, `outfit`, `playfair-display`, `public-sans`, `red-hat-mono`, `satoshi`, `sentient`, `sora`, `source-code-pro`, `source-sans-3`, `source-serif-4`, `space-grotesk`, `space-mono`, `spline-sans-mono`, `supreme`, `switzer`, `syne`, `ubuntu-mono`, `unbounded`, `victor-mono`, `work-sans`, `zodiak`; a newer site may send others, so keep a fallback.

**cdnProvider** `CdnProvider | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where to browse for the family. Pick one, then follow the link below to find the exact name. One of `bunny`, `fontshare`; a newer site may send others, so keep a fallback.

**cdnFamily** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Exactly as the provider’s catalog spells it, e.g. "Space Grotesk" or "Clash Display". A name the provider doesn’t have loads nothing and this row is ignored.

**cdnWeights** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 500, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold) — but a family that ships only ONE weight (Acme, for instance) loads nothing at all unless that weight is among these, so set it explicitly if the typeface doesn’t appear.

**uploads** `readonly SmsSignupWidgetSmsSignupFontOverridesItemUploadsItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `SmsSignupWidgetSmsSignupFontOverridesItemUploadsItem`. One file per weight/style of the SAME typeface. woff2 strongly recommended (smallest, universally supported); woff/ttf/otf also accepted. At most 4 items.

**SmsSignupWidgetSmsSignupFontOverridesItemUploadsItem**

**file** `Readonly\<Record\<string, unknown\>\>`

**Always sent.** File attachment reference.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**weight** `Weight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Weight. One of `100`, `200`, `300`, `400`, `500`, `600`, `700`, `800`, `900`; a newer site may send others, so keep a fallback.

**style** `Style | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Style. One of `normal`, `italic`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**fallback** `Fallback | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Generic system font shown while this typeface loads (and if it fails). Curated picks set this automatically. One of `sans`, `serif`, `mono`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**smsSignupSubmitLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The visible button text. Leave empty to hide the button.

**smsSignupSubmitVariant** `SmsSignupSubmitVariant | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fills with the color; Outline / Soft / Text link use it for the border + text. One of `solid`, `outline`, `soft`, `link`; a newer site may send others, so keep a fallback.

**smsSignupSubmitSize** `SmsSignupSubmitSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Button size. One of `small`, `normal`, `large`; a newer site may send others, so keep a fallback.

**smsSignupSubmitRadius** `SmsSignupSubmitRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner radius. One of `pill`, `rounded`, `slight`, `square`; a newer site may send others, so keep a fallback.

**smsSignupSubmitColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fill, or the border + text for the other styles. Defaults to the brand accent; CLEAR it for a transparent, outline-only button.

**smsSignupSubmitColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color. (Brand tokens already flip per theme.)

**smsSignupSubmitTextColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The text/icon color. Clear it to derive from the button color (readable on solid fills).

**smsSignupSubmitTextColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme label color.

**smsSignupSubmitHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Drives the hover treatment. Leave empty to derive it from the button color.

**smsSignupSubmitHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme hover color.

**smsSignupSubmitStyle** `SmsSignupSubmitStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The hover treatment: a soft shadow, a colored offset shadow, a glow, a fill sweep, or a thicker border. One of `none`, `single`, `dual`, `glow`, `sweep`, `thicken`; a newer site may send others, so keep a fallback.

**smsSignupSubmitShadowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. The offset-shadow or glow color on hover. Leave empty to use the site secondary color.

**smsSignupSubmitShadowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme shadow color.

**smsSignupSubmitAnimation** `SmsSignupSubmitAnimation | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Hover motion. One of `lift`, `scale`, `lift-scale`, `none`; a newer site may send others, so keep a fallback.

**smsSignupSubmitIcon** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.

**smsSignupSubmitIconFamily** `SmsSignupSubmitIconFamily | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon family. One of `classic-regular`, `duotone-regular`, `brands`, `jelly`, `jelly-duo`, `whiteboard`; a newer site may send others, so keep a fallback.

**smsSignupSubmitIconPosition** `SmsSignupSubmitIconPosition | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which side of the label the icon sits on (when an icon name is set). One of `before`, `after`; a newer site may send others, so keep a fallback.

**smsSignupSubmitIconNudge** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. The icon slides toward its side on hover (e.g. an arrow edges outward).

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**FormRenderWidget**

A `form-render` widget: its `type` and its own fields. A field left out takes its default.

**type** `FormRenderWidgetType`

**Always sent.** The widget’s type: always `form-render`. One of `form-render`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**form** `readonly Readonly\<Record\<string, unknown\>\>[]`

**Sometimes sent:** `undefined` when the site leaves it out. The form to show here. Build and edit the form itself in the Forms manager (create one there first if needed). The related `@apostrophecms/form` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.

**styleOverride** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Off: the form renders with the styling saved on the form itself. On: the styling below replaces it here only — the form’s fields and other placements are unaffected.

**formFontOverrides** `readonly FormRenderWidgetFormFontOverridesItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `FormRenderWidgetFormFontOverridesItem`. Optional. Set part of this form in a different typeface. Leave empty to follow the site’s fonts (Site design → Typography). At most 4 items.

**FormRenderWidgetFormFontOverridesItem**

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**target** `Target | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which text this typeface replaces. Rows apply in order, so a broad row (Everything) followed by a narrow one (Headings) gives the section a base face plus an exception. One of `all`, `heading`, `body`, `eyebrow`, `button`, `code`; a newer site may send others, so keep a fallback.

**source** `Source | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the typeface comes from. The first option costs nothing extra — those faces are already loaded. The others load an additional font on pages that use this section. One of `slot`, `curated`, `cdn`, `upload`; a newer site may send others, so keep a fallback.

**slot** `Slot | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Set in Site design → Typography. Following the site’s own faces keeps a section on-brand and adds no download. One of `display`, `body`, `accent`; a newer site may send others, so keep a fallback.

**curated** `Curated | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Vetted families from Bunny Fonts and Fontshare, with their available weights already verified. One of `archivo`, `bricolage-grotesque`, `clash-display`, `courier-prime`, `dm-mono`, `dm-sans`, `fira-code`, `fraunces`, `general-sans`, `ibm-plex-mono`, `ibm-plex-sans`, `inconsolata`, `inter`, `jetbrains-mono`, `karla`, `lora`, `manrope`, `nunito-sans`, `outfit`, `playfair-display`, `public-sans`, `red-hat-mono`, `satoshi`, `sentient`, `sora`, `source-code-pro`, `source-sans-3`, `source-serif-4`, `space-grotesk`, `space-mono`, `spline-sans-mono`, `supreme`, `switzer`, `syne`, `ubuntu-mono`, `unbounded`, `victor-mono`, `work-sans`, `zodiak`; a newer site may send others, so keep a fallback.

**cdnProvider** `CdnProvider | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where to browse for the family. Pick one, then follow the link below to find the exact name. One of `bunny`, `fontshare`; a newer site may send others, so keep a fallback.

**cdnFamily** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Exactly as the provider’s catalog spells it, e.g. "Space Grotesk" or "Clash Display". A name the provider doesn’t have loads nothing and this row is ignored.

**cdnWeights** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 500, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold) — but a family that ships only ONE weight (Acme, for instance) loads nothing at all unless that weight is among these, so set it explicitly if the typeface doesn’t appear.

**uploads** `readonly FormRenderWidgetFormFontOverridesItemUploadsItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `FormRenderWidgetFormFontOverridesItemUploadsItem`. One file per weight/style of the SAME typeface. woff2 strongly recommended (smallest, universally supported); woff/ttf/otf also accepted. At most 4 items.

**FormRenderWidgetFormFontOverridesItemUploadsItem**

**file** `Readonly\<Record\<string, unknown\>\>`

**Always sent.** File attachment reference.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**weight** `Weight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Weight. One of `100`, `200`, `300`, `400`, `500`, `600`, `700`, `800`, `900`; a newer site may send others, so keep a fallback.

**style** `Style | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Style. One of `normal`, `italic`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**fallback** `Fallback | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Generic system font shown while this typeface loads (and if it fails). Curated picks set this automatically. One of `sans`, `serif`, `mono`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**formEyebrowEnabled** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Show eyebrow.

**formEyebrow** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Small label shown above the title.

**formEyebrowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Overrides the eyebrow + its dash. Leave empty to use the secondary (mint) color.

**formEyebrowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the mint default.

**formEyebrowWeight** `FormEyebrowWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**formEyebrowSize** `FormEyebrowSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**formHeading** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Heading.

**formHeadingColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to track the theme text color.

**formHeadingColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**formHeadingWeight** `FormHeadingWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**formHeadingSize** `FormHeadingSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**formIntro** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Optional short sentence under the heading.

**formIntroColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the muted text color.

**formIntroColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color.

**formIntroWeight** `FormIntroWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**formIntroSize** `FormIntroSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Size. One of `small`, `normal`, `large`, `xlarge`, `xxlarge`; a newer site may send others, so keep a fallback.

**formBand** `FormBand | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Plain sits on the page; Raised is a contained card; Accent is a solid brand-color band. One of `plain`, `raised`, `accent`; a newer site may send others, so keep a fallback.

**formAccentColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The accent band color. Leave empty to use the site accent color.

**formAccentColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the accent.

**formAlign** `FormAlign | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Alignment of the section header (the form fields stay left-aligned for legibility). One of `center`, `left`; a newer site may send others, so keep a fallback.

**formWidth** `FormWidth | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Content width. One of `narrow`, `normal`, `wide`; a newer site may send others, so keep a fallback.

**formLabelGap** `FormLabelGap | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Vertical space between each field’s label and its input. One of `compact`, `normal`, `roomy`, `spacious`; a newer site may send others, so keep a fallback.

**formBg** `FormBg | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The section’s full-width background band in dark mode. Transparent lets the page background show through. The palette options track the site colors; choose “Custom color…” for a specific color. One of `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**formBgCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (dark theme)” is set to Custom color.

**formBgLight** `FormBgLight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. “Match dark theme” reuses the dark-theme choice; otherwise set the light-mode band independently. One of `inherit`, `transparent`, `surface`, `raised`, `sunken`, `hill`, `accent-soft`, `custom`; a newer site may send others, so keep a fallback.

**formBgLightCustom** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Used when “Section background (light theme)” is set to Custom color.

**formSubmitLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The visible button text. Leave empty to hide the button.

**formSubmitVariant** `FormSubmitVariant | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fills with the color; Outline / Soft / Text link use it for the border + text. One of `solid`, `outline`, `soft`, `link`; a newer site may send others, so keep a fallback.

**formSubmitSize** `FormSubmitSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Button size. One of `small`, `normal`, `large`; a newer site may send others, so keep a fallback.

**formSubmitRadius** `FormSubmitRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner radius. One of `pill`, `rounded`, `slight`, `square`; a newer site may send others, so keep a fallback.

**formSubmitColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fill, or the border + text for the other styles. Defaults to the brand accent; CLEAR it for a transparent, outline-only button.

**formSubmitColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color. (Brand tokens already flip per theme.)

**formSubmitTextColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The text/icon color. Clear it to derive from the button color (readable on solid fills).

**formSubmitTextColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme label color.

**formSubmitHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Drives the hover treatment. Leave empty to derive it from the button color.

**formSubmitHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme hover color.

**formSubmitStyle** `FormSubmitStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The hover treatment: a soft shadow, a colored offset shadow, a glow, a fill sweep, or a thicker border. One of `none`, `single`, `dual`, `glow`, `sweep`, `thicken`; a newer site may send others, so keep a fallback.

**formSubmitShadowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. The offset-shadow or glow color on hover. Leave empty to use the site secondary color.

**formSubmitShadowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme shadow color.

**formSubmitAnimation** `FormSubmitAnimation | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Hover motion. One of `lift`, `scale`, `lift-scale`, `none`; a newer site may send others, so keep a fallback.

**formSubmitIcon** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.

**formSubmitIconFamily** `FormSubmitIconFamily | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon family. One of `classic-regular`, `duotone-regular`, `brands`, `jelly`, `jelly-duo`, `whiteboard`; a newer site may send others, so keep a fallback.

**formSubmitIconPosition** `FormSubmitIconPosition | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which side of the label the icon sits on (when an icon name is set). One of `before`, `after`; a newer site may send others, so keep a fallback.

**formSubmitIconNudge** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. The icon slides toward its side on hover (e.g. an arrow edges outward).

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**FinalCtaWidget**

A `final-cta` widget: its `type` and its own fields. A field left out takes its default.

**type** `FinalCtaWidgetType`

**Always sent.** The widget’s type: always `final-cta`. One of `final-cta`; a newer site may send others, so keep a fallback.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there.

**metaType** `MetaType`

**Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback.

**ctaAlign** `CtaAlign | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Content alignment. One of `center`, `left`; a newer site may send others, so keep a fallback.

**ctaEyebrowEnabled** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Show eyebrow / kicker.

**ctaEyebrow** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Small label shown above the title.

**ctaEyebrowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Overrides the eyebrow + its dash. Leave empty to use the secondary (mint) color.

**ctaEyebrowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the mint default.

**ctaEyebrowWeight** `CtaEyebrowWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**ctaEyebrowSize** `CtaEyebrowSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Eyebrow size. One of `small`, `normal`, `large`, `xlarge`; a newer site may send others, so keep a fallback.

**ctaIconPlacement** `CtaIconPlacement | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. An optional Font Awesome icon above the headline. One of `none`, `top`; a newer site may send others, so keep a fallback.

**ctaIcon** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.

**ctaIconFamily** `CtaIconFamily | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon family. One of `classic-regular`, `duotone-regular`, `brands`, `jelly`, `jelly-duo`, `whiteboard`; a newer site may send others, so keep a fallback.

**ctaIconColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional — leave empty to use the design’s own color rhythm.

**ctaIconAnimation** `CtaIconAnimation | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon animation. One of `none`, `fa-beat`, `fa-bounce`, `fa-fade`, `fa-beat-fade`, `fa-flip`, `fa-shake`, `fa-spin`; a newer site may send others, so keep a fallback.

**ctaIconSize** `CtaIconSize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Relative to the component’s base icon size. One of `default`, `sm`, `lg`, `xl`, `2xl`, `2x`, `3x`, `4x`, `5x`; a newer site may send others, so keep a fallback.

**ctaIconTilt** `CtaIconTilt | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A slight rotation for a more playful look. One of `none`, `left`, `right`; a newer site may send others, so keep a fallback.

**ctaHeadline** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Headline.

**ctaHeadlineColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Overrides the headline color. Leave empty for the on-accent (legible-on-band) default.

**ctaHeadlineColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the on-accent default.

**ctaHeadlineWeight** `CtaHeadlineWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Headline weight. One of `normal`, `medium`, `semibold`, `bold`, `extrabold`; a newer site may send others, so keep a fallback.

**ctaBody** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Supporting copy.

**ctaBodyColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Overrides the supporting-copy color. Leave empty for the softened on-accent default.

**ctaBodyColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the softened on-accent default.

**ctaBodyWeight** `CtaBodyWeight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Body weight. One of `normal`, `medium`, `semibold`, `bold`; a newer site may send others, so keep a fallback.

**ctaBackgroundType** `CtaBackgroundType | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid keeps the loud color block; Image places a photo behind the text with a readability overlay. One of `solid`, `image`; a newer site may send others, so keep a fallback.

**ctaBackgroundColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The solid band color (and the fallback behind a background image). Leave empty to use the site accent color.

**ctaBackgroundColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color, then the accent.

**ctaImage** `ImageArea`

**Sometimes sent:** `undefined` when the site leaves it out. An `ImageArea`. Widgets, top to bottom: send `{ "items": [ … ] }`, one object per widget with its `type`. Writing it replaces the whole area. Its fields are listed under the first `ImageArea` above.

**ctaOverlayColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Scrim over the image to keep the text readable. Leave empty to use the accent color.

**ctaOverlayColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme overlay, then the accent.

**ctaOverlayOpacity** `number | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Overlay opacity (%). 0 to 100.

**ctaRings** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. The two large outlined circles on the band.

**ctaRingColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Drawn at a low opacity. Leave empty to use the on-accent (white-ish) default.

**ctaFontOverrides** `readonly FinalCtaWidgetCtaFontOverridesItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `FinalCtaWidgetCtaFontOverridesItem`. Optional. Set part of this section in a different typeface. Leave empty to follow the site’s fonts (Site design → Typography). At most 4 items.

**FinalCtaWidgetCtaFontOverridesItem**

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**target** `Target | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which text this typeface replaces. Rows apply in order, so a broad row (Everything) followed by a narrow one (Headings) gives the section a base face plus an exception. One of `all`, `heading`, `body`, `eyebrow`, `button`, `code`; a newer site may send others, so keep a fallback.

**source** `Source | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the typeface comes from. The first option costs nothing extra — those faces are already loaded. The others load an additional font on pages that use this section. One of `slot`, `curated`, `cdn`, `upload`; a newer site may send others, so keep a fallback.

**slot** `Slot | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Set in Site design → Typography. Following the site’s own faces keeps a section on-brand and adds no download. One of `display`, `body`, `accent`; a newer site may send others, so keep a fallback.

**curated** `Curated | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Vetted families from Bunny Fonts and Fontshare, with their available weights already verified. One of `archivo`, `bricolage-grotesque`, `clash-display`, `courier-prime`, `dm-mono`, `dm-sans`, `fira-code`, `fraunces`, `general-sans`, `ibm-plex-mono`, `ibm-plex-sans`, `inconsolata`, `inter`, `jetbrains-mono`, `karla`, `lora`, `manrope`, `nunito-sans`, `outfit`, `playfair-display`, `public-sans`, `red-hat-mono`, `satoshi`, `sentient`, `sora`, `source-code-pro`, `source-sans-3`, `source-serif-4`, `space-grotesk`, `space-mono`, `spline-sans-mono`, `supreme`, `switzer`, `syne`, `ubuntu-mono`, `unbounded`, `victor-mono`, `work-sans`, `zodiak`; a newer site may send others, so keep a fallback.

**cdnProvider** `CdnProvider | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where to browse for the family. Pick one, then follow the link below to find the exact name. One of `bunny`, `fontshare`; a newer site may send others, so keep a fallback.

**cdnFamily** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Exactly as the provider’s catalog spells it, e.g. "Space Grotesk" or "Clash Display". A name the provider doesn’t have loads nothing and this row is ignored.

**cdnWeights** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 500, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold) — but a family that ships only ONE weight (Acme, for instance) loads nothing at all unless that weight is among these, so set it explicitly if the typeface doesn’t appear.

**uploads** `readonly FinalCtaWidgetCtaFontOverridesItemUploadsItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `FinalCtaWidgetCtaFontOverridesItemUploadsItem`. One file per weight/style of the SAME typeface. woff2 strongly recommended (smallest, universally supported); woff/ttf/otf also accepted. At most 4 items.

**FinalCtaWidgetCtaFontOverridesItemUploadsItem**

**file** `Readonly\<Record\<string, unknown\>\>`

**Always sent.** File attachment reference.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**weight** `Weight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Weight. One of `100`, `200`, `300`, `400`, `500`, `600`, `700`, `800`, `900`; a newer site may send others, so keep a fallback.

**style** `Style | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Style. One of `normal`, `italic`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**fallback** `Fallback | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Generic system font shown while this typeface loads (and if it fails). Curated picks set this automatically. One of `sans`, `serif`, `mono`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**ctaPrimaryLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The visible button text. Leave empty to hide the button.

**ctaPrimaryUrl** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Where the button goes — a path (/blog) or full URL.

**ctaPrimaryNewTab** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Opens the link in a new browser tab (adds rel="noopener noreferrer").

**ctaPrimaryVariant** `CtaPrimaryVariant | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fills with the color; Outline / Soft / Text link use it for the border + text. One of `solid`, `outline`, `soft`, `link`; a newer site may send others, so keep a fallback.

**ctaPrimarySize** `CtaPrimarySize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Button size. One of `small`, `normal`, `large`; a newer site may send others, so keep a fallback.

**ctaPrimaryRadius** `CtaPrimaryRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner radius. One of `pill`, `rounded`, `slight`, `square`; a newer site may send others, so keep a fallback.

**ctaPrimaryColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fill, or the border + text for the other styles. Defaults to the brand accent; CLEAR it for a transparent, outline-only button.

**ctaPrimaryColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color. (Brand tokens already flip per theme.)

**ctaPrimaryTextColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The text/icon color. Clear it to derive from the button color (readable on solid fills).

**ctaPrimaryTextColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme label color.

**ctaPrimaryHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Drives the hover treatment. Leave empty to derive it from the button color.

**ctaPrimaryHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme hover color.

**ctaPrimaryStyle** `CtaPrimaryStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The hover treatment: a soft shadow, a colored offset shadow, a glow, a fill sweep, or a thicker border. One of `none`, `single`, `dual`, `glow`, `sweep`, `thicken`; a newer site may send others, so keep a fallback.

**ctaPrimaryShadowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. The offset-shadow or glow color on hover. Leave empty to use the site secondary color.

**ctaPrimaryShadowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme shadow color.

**ctaPrimaryAnimation** `CtaPrimaryAnimation | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Hover motion. One of `lift`, `scale`, `lift-scale`, `none`; a newer site may send others, so keep a fallback.

**ctaPrimaryIcon** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.

**ctaPrimaryIconFamily** `CtaPrimaryIconFamily | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon family. One of `classic-regular`, `duotone-regular`, `brands`, `jelly`, `jelly-duo`, `whiteboard`; a newer site may send others, so keep a fallback.

**ctaPrimaryIconPosition** `CtaPrimaryIconPosition | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which side of the label the icon sits on (when an icon name is set). One of `before`, `after`; a newer site may send others, so keep a fallback.

**ctaPrimaryIconNudge** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. The icon slides toward its side on hover (e.g. an arrow edges outward).

**ctaSecondaryLabel** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The visible button text. Leave empty to hide the button.

**ctaSecondaryUrl** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Where the button goes — a path (/blog) or full URL.

**ctaSecondaryNewTab** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. Opens the link in a new browser tab (adds rel="noopener noreferrer").

**ctaSecondaryVariant** `CtaSecondaryVariant | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fills with the color; Outline / Soft / Text link use it for the border + text. One of `solid`, `outline`, `soft`, `link`; a newer site may send others, so keep a fallback.

**ctaSecondarySize** `CtaSecondarySize | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Button size. One of `small`, `normal`, `large`; a newer site may send others, so keep a fallback.

**ctaSecondaryRadius** `CtaSecondaryRadius | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Corner radius. One of `pill`, `rounded`, `slight`, `square`; a newer site may send others, so keep a fallback.

**ctaSecondaryColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Solid fill, or the border + text for the other styles. Defaults to the brand accent; CLEAR it for a transparent, outline-only button.

**ctaSecondaryColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme color. (Brand tokens already flip per theme.)

**ctaSecondaryTextColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The text/icon color. Clear it to derive from the button color (readable on solid fills).

**ctaSecondaryTextColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme label color.

**ctaSecondaryHoverColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Drives the hover treatment. Leave empty to derive it from the button color.

**ctaSecondaryHoverColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme hover color.

**ctaSecondaryStyle** `CtaSecondaryStyle | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The hover treatment: a soft shadow, a colored offset shadow, a glow, a fill sweep, or a thicker border. One of `none`, `single`, `dual`, `glow`, `sweep`, `thicken`; a newer site may send others, so keep a fallback.

**ctaSecondaryShadowColor** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. The offset-shadow or glow color on hover. Leave empty to use the site secondary color.

**ctaSecondaryShadowColorLight** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional light-theme override. Falls back to the dark-theme shadow color.

**ctaSecondaryAnimation** `CtaSecondaryAnimation | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Hover motion. One of `lift`, `scale`, `lift-scale`, `none`; a newer site may send others, so keep a fallback.

**ctaSecondaryIcon** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Any Font Awesome icon name, e.g. star, bolt, arrow-left-to-bracket (no “fa-” prefix). Browse at fontawesome.com/icons.

**ctaSecondaryIconFamily** `CtaSecondaryIconFamily | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Icon family. One of `classic-regular`, `duotone-regular`, `brands`, `jelly`, `jelly-duo`, `whiteboard`; a newer site may send others, so keep a fallback.

**ctaSecondaryIconPosition** `CtaSecondaryIconPosition | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which side of the label the icon sits on (when an icon name is set). One of `before`, `after`; a newer site may send others, so keep a fallback.

**ctaSecondaryIconNudge** `boolean`

**Sometimes sent:** `undefined` when the site leaves it out. The icon slides toward its side on hover (e.g. an arrow edges outward).

**sectionCss** `CustomCSS | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. Its fields are listed under the first `CustomCSS` above.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**postFontOverrides** `readonly BlogPostFontOverridesItem[] | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A list of `BlogPostFontOverridesItem`. Optional. Leave empty to follow the blog’s Reading settings (and, through them, the site fonts). Adding a row here replaces the blog-wide choice for this post only. At most 4 items.

**BlogPostFontOverridesItem**

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**target** `Target | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which text this typeface replaces. Rows apply in order, so a broad row (Everything) followed by a narrow one (Headings) gives the section a base face plus an exception. One of `all`, `heading`, `body`, `eyebrow`, `button`, `code`; a newer site may send others, so keep a fallback.

**source** `Source | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the typeface comes from. The first option costs nothing extra — those faces are already loaded. The others load an additional font on pages that use this section. One of `slot`, `curated`, `cdn`, `upload`; a newer site may send others, so keep a fallback.

**slot** `Slot | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Set in Site design → Typography. Following the site’s own faces keeps a section on-brand and adds no download. One of `display`, `body`, `accent`; a newer site may send others, so keep a fallback.

**curated** `Curated | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Vetted families from Bunny Fonts and Fontshare, with their available weights already verified. One of `archivo`, `bricolage-grotesque`, `clash-display`, `courier-prime`, `dm-mono`, `dm-sans`, `fira-code`, `fraunces`, `general-sans`, `ibm-plex-mono`, `ibm-plex-sans`, `inconsolata`, `inter`, `jetbrains-mono`, `karla`, `lora`, `manrope`, `nunito-sans`, `outfit`, `playfair-display`, `public-sans`, `red-hat-mono`, `satoshi`, `sentient`, `sora`, `source-code-pro`, `source-sans-3`, `source-serif-4`, `space-grotesk`, `space-mono`, `spline-sans-mono`, `supreme`, `switzer`, `syne`, `ubuntu-mono`, `unbounded`, `victor-mono`, `work-sans`, `zodiak`; a newer site may send others, so keep a fallback.

**cdnProvider** `CdnProvider | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where to browse for the family. Pick one, then follow the link below to find the exact name. One of `bunny`, `fontshare`; a newer site may send others, so keep a fallback.

**cdnFamily** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Exactly as the provider’s catalog spells it, e.g. "Space Grotesk" or "Clash Display". A name the provider doesn’t have loads nothing and this row is ignored.

**cdnWeights** `string`

**Sometimes sent:** `undefined` when the site leaves it out. Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 500, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold) — but a family that ships only ONE weight (Acme, for instance) loads nothing at all unless that weight is among these, so set it explicitly if the typeface doesn’t appear.

**uploads** `readonly BlogPostFontOverridesItemUploadsItem[]`

**Sometimes sent:** `undefined` when the site leaves it out. A list of `BlogPostFontOverridesItemUploadsItem`. One file per weight/style of the SAME typeface. woff2 strongly recommended (smallest, universally supported); woff/ttf/otf also accepted. At most 4 items.

**BlogPostFontOverridesItemUploadsItem**

**file** `Readonly\<Record\<string, unknown\>\>`

**Always sent.** File attachment reference.

**id** `string`

**Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.

**weight** `Weight | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Weight. One of `100`, `200`, `300`, `400`, `500`, `600`, `700`, `800`, `900`; a newer site may send others, so keep a fallback.

**style** `Style | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Style. One of `normal`, `italic`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**fallback** `Fallback | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Generic system font shown while this typeface loads (and if it fails). Curated picks set this automatically. One of `sans`, `serif`, `mono`; a newer site may send others, so keep a fallback.

**fields** `Readonly\<Record\<string, unknown\>\>`

**Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

**seoTitle** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Overrides the document title in the browser tab and search results. Leave blank to use the regular title.

**seoDescription** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Shown in search results and link previews. Aim for 150–160 characters.

**seoImage** `ImageArea`

**Sometimes sent:** `undefined` when the site leaves it out. An `ImageArea`. Used for Open Graph / social link previews. Recommended 1200×630. Widgets, top to bottom: send `{ "items": [ … ] }`, one object per widget with its `type`. Writing it replaces the whole area. Its fields are listed under the first `ImageArea` above.

**archived** `boolean | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. In the archive: kept, but out of every list and off the site until it is restored. `false` (or null) for a live document.

**createdAt** `Date | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. When it was created (ISO 8601). Format: an ISO 8601 date and time.

**updatedAt** `Date | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. When it last changed (ISO 8601). Format: an ISO 8601 date and time.

**url** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The document’s page on the site. Format: an absolute URL.

**parentUrl** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The page that lists it (the blog page). Format: an absolute URL.

**parentSlug** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. That page’s slug.

**parent** `Readonly\<Record\<string, unknown\>\>`

**Sometimes sent:** `undefined` when the site leaves it out. That page, briefly (`_id`, `title`, `slug`, `type`, `path`, `level`).

**aposShareKey** `string | null`

**Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The draft’s preview share key, while its share link is on: the link is the draft’s `_url` with `aposShareKey` and `aposShareId` (the draft’s `_id`) in its query. Absent otherwise, and on published documents.

**pages** `number`

**Always sent.** Pages in the whole list (0 when it is empty).

**currentPage** `number`

**Always sent.** This page, from 1.

> [accordion] Errors
>
> Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below; catch only what you want to react to (see [Errors and testing](https://docs.fetchski-attract.com/typescript/errors.md)).
>
> **ValidationFailed** `400`
>
> The site refused what was sent: `errors` lists each field’s problem, `siteMessage` the first.
>
> **Retried first:** No. **Read:** `errors` (field → messages), `siteMessage`.
>
> **AuthenticationFailed** `401`
>
> The API key is missing or refused (malformed, revoked, expired), or a signature its signing mode needs is missing or stale.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **Forbidden** `403`
>
> The key may not do this: a scope it lacks, or an address outside its allowlist. `siteMessage` names it.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **NotFound** `404`
>
> Nothing matches, or the caller may not see it.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **SiteError** `500`
>
> The site failed. Its logs say why.
>
> **Retried first:** No (only a 502, 503 or 504 is retried). **Read:** `siteMessage`, `errorName`, `data`.
>
> **SiteUnreachable** `no answer`
>
> No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).
>
> **Retried first:** Yes, after 0.5 s then 1 s. **Read:** `reason`, `neverConnected`.
>
> **RequestNotSent** `not sent`
>
> The client refused to send it (e.g. a path segment of `..`); the site never saw it.
>
> **Retried first:** No. **Read:** `reason` (what to change).
>
> **SiteRequestFailed** `any other`
>
> Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).
>
> **Retried first:** No. **Read:** `reason`, `status`.
>
> **UnknownSite** `setup`
>
> `sites.forSite('acme')` named a slug your sites (`createSiteClients()`) don’t have.
>
> **Retried first:** No: nothing was sent. **Read:** `message`, `slug`.
>
> **SiteConfigurationError** `setup`
>
> The client’s settings are wrong: no `FETCHSKI_ATTRACT_URL` (or `baseUrl`), or a malformed API key.
>
> **Retried first:** No: nothing was sent. **Read:** `message` (what to fix).

## Behavior

* **Access:** an API key with `content:blog:read` (or a master above it: `content:blog:all`, `content:all`, `admin:all`) reads the published documents; drafts (`aposMode=draft`) need `content:blog:write` (or a master above it). A signed-in person reads as far as their own permissions allow, and anyone else reads the published documents’ public fields.
* **Rate limit:** the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with `Retry-After`. The client waits and retries for you; you see `RateLimited` only if that runs out.
* **Retries:** a read is safe to repeat: the client retries it on no answer, a 502/503/504 and a 429.
* **Timeout:** 15 s per attempt by default; raise `timeout` (milliseconds) on the client for longer.
* **Paging:** one page per call. To walk them all, use `listBlogsAll()` (see More examples): it asks for the next page as you iterate, and stops after page `pages`.

## More examples

`listBlogsAll()` takes `listBlogs()`’s arguments except `page`. `listBlogsPick()` takes the same arguments except `page`, after the fields to answer: each row is the document’s `id` and those fields.

```ts Every page wrap theme={"dark"}
import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
for await (const blog of site.blogPosts().listBlogsAll()) {
  console.log(blog); // the next page is fetched as you iterate
}
```

```ts Only some fields wrap theme={"dark"}
import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const rows = await site.blogPosts().listBlogsPick(['title', 'slug']); // [{ id, title, slug }, …]: every blog post, across every page
```

## Test it

It calls the function above with a fake client: the fake answers every call with a valid example, so nothing leaves your machine and no settings or key are needed. Run it with `node --test`.

```ts tests/blogPosts-listBlogs.test.ts theme={"dark"}
import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { listBlogs } from '../src/attract/list-blogs.ts';

test('blogPosts.listBlogs', async () => {
  const site = fakeSite();
  await listBlogs(site);
  site.assertCalled('blogPosts.listBlogs');
});
```

**Answer with your own values:** fake `blogPosts.listBlogs` with a `sequence()` of pages, each `factories.BlogList({...})`, and walk `listBlogsAll()`.

```ts tests/blogPosts-listBlogs-answer.test.ts theme={"dark"}
import assert from 'node:assert/strict';
import { test } from 'node:test';
import { factories, fakeSite, sequence } from '@fetchski/attract-cms-sdk/testing';

test('blogPosts.listBlogs answers your values', async () => {
  const site = fakeSite({
    'blogPosts.listBlogs': sequence(
      factories.BlogList({ currentPage: 1, pages: 2 }),
      factories.BlogList({ currentPage: 2, pages: 2 })
    )
  });
  const walked: unknown[] = [];
  for await (const blog of site.blogPosts().listBlogsAll()) {
    walked.push(blog);
  }
  assert.equal(walked.length, 2);
});
```

To fake `listBlogsAll()`, answer `blogPosts.listBlogs` (the walk calls it page by page): a `sequence()` of answers for several pages.

## Related

> [card] [List a blog post’s locales](https://docs.fetchski-attract.com/typescript/reference/blog-posts/get-blog-locales.md)
>
> `site.blogPosts().getBlogLocales()`

> [card] [Get the Markdown template](https://docs.fetchski-attract.com/typescript/reference/blog-posts/get-blog-markdown-template.md)
>
> `site.blogPosts().getBlogMarkdownTemplate()`

> [card] [Get the MDX template](https://docs.fetchski-attract.com/typescript/reference/blog-posts/get-blog-mdx-template.md)
>
> `site.blogPosts().getBlogMdxTemplate()`

> [card] [Create a blog post](https://docs.fetchski-attract.com/typescript/reference/blog-posts/create-blog.md)
>
> `site.blogPosts().createBlog()`

> [card] [Get a blog post](https://docs.fetchski-attract.com/typescript/reference/blog-posts/get-blog.md)
>
> `site.blogPosts().getBlog()`

> [card] [Replace a blog post](https://docs.fetchski-attract.com/typescript/reference/blog-posts/replace-blog.md)
>
> `site.blogPosts().replaceBlog()`

> [card] [GET /@apostrophecms/blog](https://docs.fetchski-attract.com/api-reference/blog-posts/list-blog-posts.md)
>
> The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.