IPublisherPageBodyV1
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Body of a document page: geometry (flex split tree) plus the slots it places.
export interface IPublisherPageBodyV1
Remarks
This is both the content of the standalone IPublisherPageTemplateV1 object and the shape embedded in template/document content (IPublisherDocumentPageV1).
There is no header/footer chrome: page title, description, footer, page numbers and logos are ordinary slots in the layout tree (text slots with {currentPageNumber}/{totalPages}, an image slot with {logo}). Every slot fills its layout area completely.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) (Optional) Page-level filters: merged over content-level filters (a filter targeting the same object replaces the inherited one); slot filters apply on top. | |||
(ALPHA) (Optional) Page proportions the layout was authored for. Defaults to DefaultPublisherPageFormatV1. | |||
“cover” | “section” | “content” | (ALPHA) (Optional) Editor hint only (template galleries, default styling, AI context). Renderers must not branch layout logic on it — geometry always comes from | ||
(ALPHA) Root of the layout tree. | |||
(ALPHA) All slots referenced by the layout, flat, keyed by localIdentifier. | |||
(ALPHA) (Optional) Paint of the page itself, behind everything the layout places. |
Property details
IPublisherPageBodyV1.filterspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Page-level filters: merged over content-level filters (a filter targeting the same object replaces the inherited one); slot filters apply on top.
filters?: FilterContextItem[];
IPublisherPageBodyV1.formatpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Page proportions the layout was authored for. Defaults to DefaultPublisherPageFormatV1.
format?: PublisherPageFormatV1;
IPublisherPageBodyV1.kindpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Editor hint only (template galleries, default styling, AI context). Renderers must not branch layout logic on it — geometry always comes from layout.
kind?: "cover" | "section" | "content";
IPublisherPageBodyV1.layoutpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Root of the layout tree.
layout: PublisherLayoutNodeV1;
IPublisherPageBodyV1.slotspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
All slots referenced by the layout, flat, keyed by localIdentifier.
slots: PublisherSlotV1[];
IPublisherPageBodyV1.stylepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Paint of the page itself, behind everything the layout places.
style?: IPublisherBoxStyleV1;