IPublisherWidgetBaseV2
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
export interface IPublisherWidgetBaseV2
Remarks
Empty content is an absent key; "" and null are invalid.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (ALPHA) Unique within its page. Copying a page keeps widget ids as written. Matches | ||
boolean | (ALPHA) (Optional) Enforced by the editor, never checked on write. | ||
(ALPHA) (Optional) | |||
number | (ALPHA) (Optional) Share of the parent’s main axis, greater than 0. Defaults to 1. | ||
(ALPHA) |
Property details
IPublisherWidgetBaseV2.idpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Unique within its page. Copying a page keeps widget ids as written. Matches [A-Za-z0-9_.-]{1,64}.
id: string;
IPublisherWidgetBaseV2.lockedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Enforced by the editor, never checked on write.
locked?: boolean;
IPublisherWidgetBaseV2.placeholderpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
placeholder?: IPublisherWidgetPlaceholderV2;
IPublisherWidgetBaseV2.proportionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Share of the parent’s main axis, greater than 0. Defaults to 1.
proportion?: number;
IPublisherWidgetBaseV2.typepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
type: PublisherWidgetTypeV2;