SEO metadata

page.isExcludedFromSearch()

Check if the page is excluded from internal site search.

Syntax

1
page.isExcludedFromSearch(): Promise<boolean>;

Returns

Promise<boolean>

A Promise that resolves to a boolean value.

Example

1
// Get Current Page
2
const currentPage = await webflow.getCurrentPage()
3
4
// Check if page is excluded from webflow's internal site search
5
const isExcluded = await currentPage?.isExcludedFromSearch()
6
7
if (isExcluded){
8
  console.log("Current page is excluded from Webflow's internal site search")
9
} else {
10
  "Current page is included in included in Webflow's internal site search"
11
}

Designer Ability

page.excludeFromSearch(shouldExclude)

Sets whether the page should be excluded from search engine indexing.

Syntax

1
page.excludeFromSearch(shouldExclude: boolean): Promise<null>;

Parameters

• shouldExclude: boolean - Set to true to exclude the page from search engine indexing, false otherwise.

Returns

Promise<null>

A Promise that resolves to null when the page is excluded from search.

Example

1
// Get Current Page
2
const currentPage = await webflow.getCurrentPage()
3
4
// Exclud from search engine indexing
5
await currentPage.excludeFromSearch(true)

Designer Ability

page.usesTitleAsSearchTitle()

Checks if the page uses its title as the search engine title.

Syntax

1
page.usesTitleAsSearchTitle(): Promise<boolean>;

Returns

Promise<boolean>

A Promise that resolves to a boolean value

Example

1
// Get Current Page
2
const currentPage = await webflow.getCurrentPage()
3
4
// Check title
5
const usesTitle = await currentPage?.usesTitleAsSearchTitle()
6
7
if (usesTitle){
8
  console.log('This page uses its Title as the Search Engine title')
9
} else {
10
  console.log( "This page has a custom search engine title")
11
}

Designer Ability

page.useTitleAsSearchTitle(use)

Sets whether the page should use its title as the search engine title.

Syntax

1
page.useTitleAsSearchTitle(use: boolean): Promise<null>;

Parameters

• use: boolean - Set to true to use the page title as the search engine title, false otherwise.

Returns

Promise<null>

A Promise that resolves to null when the search engine title is set.

Example

1
// Get Current Page
2
const currentPage = await webflow.getCurrentPage()
3
4
// Set title as search title
5
await currentPage?.useTitleAsSearchTitle(true)

Designer Ability

page.getSearchTitle()

Retrieves the search engine title of the page.

Syntax

1
page.getSearchTitle(): Promise<string>;

Returns

Promise< string>

A Promise that resolves to a string with the search engine title.

Example

1
// Get Current Page
2
const currentPage = await webflow.getCurrentPage() as Page
3
4
// Get Search engine title and print details
5
const searchEngineTitle = currentPage.getSearchTitle()
6
console.log(searchEngineTitle)

Designer Ability

page.setSearchTitle(title)

Sets the search engine title of the page to the provided value.

Syntax

1
page.setSearchTitle(title: string): Promise<null>;

Parameters

• title: string - The new search engine title to set for the page.

Returns

Promise<null>

A Promise that resolves to a null value when the search engine title has been set.

Example

1
// Get Current Page
2
const currentPage = await webflow.getCurrentPage() as Page
3
4
// Set search engine title and print details
5
await currentPage.setSearchTitle("My New Title")
6
const searchTitle = await currentPage.getSearchTitle()
7
console.log(searchTitle)

Designer Ability

page.usesDescriptionAsSearchDescription()

Checks if the page uses its description as the search engine description.

Syntax

1
page.usesDescriptionAsSearchDescription(): Promise<boolean>;

Returns

Promise<boolean>

A Promise that resolves to a boolean value when the description is set.

Example

1
// Get current page
2
const currentPage = await webflow.getCurrentPage()
3
4
// Check search engine description
5
const isSearchDescription = await currentPage?.usesDescriptionAsSearchDescription()
6
7
if(isSearchDescription){
8
  console.log("This page uses its description as the search engine description")
9
} else {
10
  console.log("This page has a custom search engine description")
11
}

Designer Ability

page.useDescriptionAsSearchDescription(use)

Sets whether the page should use its description as the search engine description.

Syntax

1
page.useDescriptionAsSearchDescription(use: boolean): Promise<null>;

Parameters

• use: boolean - Set to true to use the page description as the search engine description, false otherwise.

Returns

Promise< null>

A Promise that resolves to null when the search engine description is set.

Example

1
// Get current page
2
const currentPage = await webflow.getCurrentPage()
3
4
// Set search description
5
await currentPage.useDescriptionAsSearchDescription(true)

Designer Ability

page.getSearchDescription()

Retrieves the search engine description of the page.

Syntax

1
page.getSearchDescription(): Promise<string>;

Returns

Promise< string>

A Promise that resolves to a string with the search engine description.

Example

1
// Get Current Page
2
const currentPage = await webflow.getCurrentPage() as Page
3
4
// Get search engine description and print details
5
const searchEngineDescription = currentPage.getSearchDescription()
6
console.log(searchEngineDescription)

Designer Ability

page.setSearchDescription(description)

Sets the search engine description of the page to the provided value.

Syntax

1
page.setSearchDescription(description: string): Promise<null>;

Parameters

• description: string - The new search engine description to set for the page.

Returns

Promise<null>

A Promise that resolves to null when the search engine description is set.

Example

1
// Get Current Page
2
const currentPage = await webflow.getCurrentPage() as Page
3
4
// Set search engine description and print details
5
await currentPage.setSearchDescription(description)
6
const searchDescription = await currentPage.getSearchDescription()
7
console.log(My New Description)

Designer Ability

page.usesOpenGraphImageAsSearchImage()

Check if the page uses its Open Graph image as the search engine image.

Syntax

1
page.usesOpenGraphImageAsSearchImage(): Promise<boolean>;

Returns

Promise<boolean>

A Promise that resolves to a boolean value to indicate whether a page uses its Open Graph image as a search engine image.

Example

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

Designer Ability

page.useOpenGraphImageAsSearchImage(use)

Choose whether the page should use its Open Graph image as the search engine image.

Syntax

1
page.useOpenGraphImageAsSearchImage(use: boolean): Promise<null>;

Parameters

• use: boolean - Set to true to use the Open Graph (OG) image as the search engine image, false otherwise.

Returns

Promise<null>

A Promise that resolves to null when the search image is set.

Example

1
// Get current page
2
const currentPage = await webflow.getCurrentPage()
3
4
// Set Open Graph image as search image
5
await currentPage?.useOpenGraphImageAsSearchImage(true)

Designer Ability

page.getSearchImage()

Retrieves the search engine image URL of the page.

Syntax

1
page.getSearchImage(): Promise<string>;

Returns

Promise<string>

A Promise that resolves to a string with the search engine image URL.

Example

1
// Get Current Page
2
const currentPage = await webflow.getCurrentPage() as Page
3
4
// Get search engine Image and print details
5
const searchEngineImage = currentPage.getSearchImage()
6
console.log(searchEngineImage)

Designer Ability

page.setSearchImage(url)

Sets the search engine image of the page to the provided URL.

Syntax

1
page.setSearchImage(url: string): Promise<null>;

Parameters

• url: string - The new search engine image URL to set for the page.

Returns

Promise<null>

A Promise that resolves to null when the search engine image is set.

Example

1
// Get Current Page
2
const currentPage = await webflow.getCurrentPage() as Page
3
4
// Set search engine image and print details
5
await currentPage.setSearchImage(image)
6
const searchImage = await currentPage.getSearchImage()
7
console.log(searchImage)

Designer Ability