IPublisherBoxStyleV1
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Paint of the box itself. Never affects the geometry of the box or its children — geometry always comes from layout weights.
export interface IPublisherBoxStyleV1
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) (Optional) | |||
number | (ALPHA) (Optional) Corner radius in percent of the page width — the same relative unit the rest of a document page is sized in, so the corners keep their proportion however large the page is rendered. Content reaching into a rounded corner is clipped. | ||
number | (ALPHA) (Optional) Inset of the box’s own content, in percent of the page width like IPublisherBoxStyleV1.borderRadius. Insets only inward — siblings and the layout gaps around the box are untouched. A box that paints a background usually wants one; a full-bleed box (an image-backed cover) wants none, which is why no default exists. |
Property details
IPublisherBoxStyleV1.backgroundpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
background?: PublisherBackgroundV1;
IPublisherBoxStyleV1.borderRadiuspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Corner radius in percent of the page width — the same relative unit the rest of a document page is sized in, so the corners keep their proportion however large the page is rendered. Content reaching into a rounded corner is clipped.
borderRadius?: number;
IPublisherBoxStyleV1.paddingpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Inset of the box’s own content, in percent of the page width like IPublisherBoxStyleV1.borderRadius. Insets only inward — siblings and the layout gaps around the box are untouched. A box that paints a background usually wants one; a full-bleed box (an image-backed cover) wants none, which is why no default exists.
padding?: number;