For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Resources
Get started
ReferenceGuidesExamplesChangelog
ReferenceGuidesExamplesChangelog
  • Designer API
    • Introduction
    • Getting Started
    • Webflow CLI
    • Error Handling
    • App Modes
  • Elements
    • Creating & Retrieving Elements
    • Element Properties & Methods
    • Element Types & Methods
  • Styles
    • Managing Style Properties
    • Managing Variable Modes
  • Components
  • Variables & Collections
    • Variable Collections
    • Variables
    • Variable Modes
  • Assets
  • Pages & Folders
      • Page information
      • Page settings
        • Get Open Graph title
        • Set Open Graph title
        • Check if page uses title as the Open Graph title
        • Use page title as Open Graph title
        • Get Open Graph description
        • Set Open Graph description
        • Check if page uses description as the Open Graph description
        • Use page description as Open Graph description
        • Get Open Graph image
        • Set Open Graph image URL
  • Utilities
    • User Events & Notifications
    • App Intents & Connections
  • Additional Resources
    • API Playground
    • FAQs
LogoLogo
Resources
Get started
On this page
  • page.usesDescriptionAsOpenGraphDescription()
Pages & FoldersManaging PagesOpen Graph metadata

Check if page uses description as Open Graph description

Was this page helpful?
Previous

Use description as Open Graph description

Next
Built with

page.usesDescriptionAsOpenGraphDescription()

Checks if the page uses its description as its Open Graph description.

Syntax

1page.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
2const currentPage = await webflow.getCurrentPage() as Page
3
4// Check page status
5const isOpenGraphDescription = await currentPage.usesDescriptionAsOpenGraphDescription()
6
7// Print page status
8if (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}

Try this example

Designer Ability

Designer AbilityLocaleBranchWorkflowSitemode
canReadPageSettingsAnyAnyAnyAny