editDesign
API reference for the JavaScript API's editDesign method.
Opens an existing design in the Canva editor.

Usage

1
api.editDesign({
2
design: {
3
id: "DESIGN ID GOES HERE",
4
},
5
});
Copied!
You must initialize the SDK before calling the editDesign function.

Parameters

Name
Type
Required
Description
opts
object
Yes
Options for opening an existing design in the Canva editor.
opts.design
object
Yes
Options for the user's design.
opts.design.id
object
Yes
The ID of the user's design.
opts.editor
object
No
Options for the Canva editor.
opts.editor.publishLabel
string
No
A label for the Publish button. The default value is Publish.
opts.editor.fileType
string
No
A file type for the exported design. The accepted values include png, pdf, jpeg, and jpeg. The ability to export designs as mp4 and gif is an invite-only feature. The default value is png. If this argument is null, the editor uses whatever value is defined for the createDesign method.
opts.onDesignOpen
function
No
A function that runs when a user opens their design. For more information, see onDesignOpen.
opts.onDesignPublish
function
No
A function that runs when the user publishes their design. For more information, see onDesignPublish.
opts.onDesignClose
function
No
A function that runs when the user closes their design. For more information, see onDesignClose.

Returns

void
Copy link