IPublisherHeadingWidgetV2
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
export interface IPublisherHeadingWidgetV2 extends IPublisherWidgetBaseV2
Extends: IPublisherWidgetBaseV2
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) (Optional) Outline level below the page title, independent of the text style. Defaults to 1. | |||
string | (ALPHA) (Optional) Inline markdown only. | ||
(ALPHA) (Optional) | |||
“heading” | (ALPHA) |
Property details
IPublisherHeadingWidgetV2.levelpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Outline level below the page title, independent of the text style. Defaults to 1.
level?: PublisherHeadingLevelV2;
IPublisherHeadingWidgetV2.markdownpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Inline markdown only.
markdown?: string;
IPublisherHeadingWidgetV2.stylepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
textStyle defaults to publisherHeadingDefaultTextStyleV2() of the level.
style?: IPublisherTextWidgetStyleV2;
IPublisherHeadingWidgetV2.typepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
type: "heading";