Skip navigation

Skip to main content

On September 25th, 2024, we released v2 of the Apps SDK. To learn what’s new and how to upgrade, see Migration FAQ and Migration guide.
API reference
Intents: design
API reference

prepareDesignEditor

API reference for the intents prepareDesignEditor 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.

Prepares a DesignEditor Intent.

Usage

import { prepareDesignEditor } from '@canva/intents/design';


prepareDesignEditor({
 render: async () => {
   // TODO: Implement the logic to render your app's UI
 },
});
TSX

Parameters

implementationDesignEditorIntentRequired

Main interface for implementing the DesignEditor intent.

Implementing the DesignEditor Intent enables apps to assist users in editing designs, by presenting interactive and creative tooling alongside the Canva design surface.

renderfunctionRequired

Renders the UI containing the app’s functionality.

Example

function render() {
  // render your UI using your preferred framework
}
TSX

Returns

void

Returns

void