IPublisherImageBackgroundV1
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Image painted behind a section’s or page’s content.
export interface IPublisherImageBackgroundV1
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (ALPHA) Local identifier of an image slot in IPublisherPageBodyV1.slots. Routing the image through a slot keeps it template-fillable and gives it the slot’s placeholder metadata. A reference that is missing or resolves to a non-image slot paints no background. | ||
“image” | (ALPHA) |
Property details
IPublisherImageBackgroundV1.slotIdpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Local identifier of an image slot in IPublisherPageBodyV1.slots. Routing the image through a slot keeps it template-fillable and gives it the slot’s placeholder metadata. A reference that is missing or resolves to a non-image slot paints no background.
slotId: string;
IPublisherImageBackgroundV1.typepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
type: "image";