Use description as Open Graph description (Designer API v2)

`page.useDescriptionAsOpenGraphDescription()`

Sets a page’s description as its Open Graph description.

Syntax

1 page.usesDescriptionAsOpenGraphDescription(): Promise<boolean>

Returns

Promise<boolean>

A Promise that resolves to a boolean indicating whether the page uses its description as its Open Graph description.

Example

1 // Get Current Page
2 const currentPage = await webflow.getCurrentPage() as Page
3 
4 // Check page status
5 const isOpenGraphDescription = await currentPage.usesDescriptionAsOpenGraphDescription()
6 
7 // Print page status
8 if (isOpenGraphDescription) {
9 
10   console.log('Page uses Page Description as Open Graph Description')
11 } else {
12   console.log('This page has a custom Open Graph Description')
13 }

Designer Ability

Designer Ability	Locale	Branch	Workflow	Sitemode
canReadPageSettings	Any	Any	Any	Any

1	// Get Current Page
2	const currentPage = await webflow.getCurrentPage() as Page
3
4	// Check page status
5	const isOpenGraphDescription = await currentPage.usesDescriptionAsOpenGraphDescription()
6
7	// Print page status
8	if (isOpenGraphDescription) {
9
10	console.log('Page uses Page Description as Open Graph Description')
11	} else {
12	console.log('This page has a custom Open Graph Description')
13	}