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

await openDesign({ type: 'current_page' }, async (session) => {
  // Do something with session.page
  await session.sync();
});

TYPESCRIPT

Parameters

optionsDesignOpenCurrentPageOptions

Required

Options for configuring how the current page is read.

typestring

Required

The type of context.

The only valid value is "current_page".

callbackDesignOpenCurrentPageCallback

Required

A callback for operating on the current page.

Parameters

sessionDesignEditing.CurrentPageSession

Required

Session received by the openDesign callback when opening the current page.

pageDesignEditing.Page

Required

The current page of the design.

A page with either fixed or unbounded dimensions.

For more information, see AbsolutePage.

Represents design content that the SDK doesn't support.

typestringRead-only

Required

The only valid value is "unsupported".

helpersDesignEditing.PageHelpers

Required

These are various utilities that allow apps to do more complex operations on the page.

For more information, see PageHelpers.

syncfunction

Required

Saves any changes made during the session while keeping the session open.

Any changes in the session are only reflected in the design after this method is called.
Once this method is called, further changes in the session can still be made.

Returns

Promise<void>

Returns

Promise<void>

Returns

Promise<void>

Reads (and optionally updates) all pages of the user's design.

Usage: Read all pages

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

await openDesign({ type: 'all_pages' }, async (session) => {
  // Do something with session.pageRefs
  await session.sync();
});

TYPESCRIPT

Parameters

optionsDesignOpenAllPagesOptions

Required

Options for configuring how all pages are read.

typestring

Required

The type of context.

The only valid value is "all_pages".

callbackDesignOpenAllPagesCallback

Required

A callback for operating on all pages.

Parameters

sessionDesignEditing.AllPagesSession

Required

Session received by the openDesign callback when opening all pages.

pageRefsDesignEditing.PageRefList

Required

References to all pages of the design.

For more information, see PageRefList.

helpersDesignEditing.AllPagesHelpers

Required

These are various utilities that allow apps to do more complex operations on the page.

For more information, see AllPagesHelpers.

syncfunction

Required

Saves any changes made during the session while keeping the session open.

Any changes in the session are only reflected in the design after this method is called.
Once this method is called, further changes in the session can still be made.

Returns

Promise<void>

Returns

Promise<void>

Returns

Promise<void>

Permissions

To use this method, the following permissions must be enabled for the app:

canva:design:content:read, to read the design
canva:design:content:write, if the app calls the sync method

To learn more, see Permissions.

Rate limit

This method has the following rate limits:

Opening the design: 10 requests every 10 seconds
Calling the sync method: 10 requests every 10 seconds