getCurrentPageContext

API reference for the getCurrentPageContext method.

This version of the API is a preview. Preview APIs are unstable and may change without warning. You can't release public apps using this API until it's stable.

Allows to get the context of currently selected page.

Usage: Get current page information

import { getCurrentPageContext } from "@canva/design";

const pageContext = await getCurrentPageContext();
if (pageContext.dimensions) {
  // Do something with the page dimensions, e.g. `pageContext.dimensions.width` and `pageContext.dimensions.height`
} else {
  // This page type does not have fixed dimensions, e.g. Whiteboard or Doc
}

TYPESCRIPT

Returns

Page context of currently selected page. This is a Promise that resolves with the following object:

dimensionsPageDimensions | undefined

The dimensions of the page, in pixels.

This may be undefined because some types of pages don't have dimensions, such as whiteboards.

widthnumber

The width of the page, in pixels.

heightnumber

The height of the page, in pixels.