Skip navigation

Skip to main content

API reference

Asset

getTemporaryUrl findFonts openColorSelector requestFontSelection upload Changelog

Asset: Test

initTestEnvironment

Design

addAudioTrack addElementAtCursor addElementAtPoint addNativeElement

addPage bulkCreate.launch createRichtextRange editContent getCurrentPageContext getCurrentPageMetadata getDefaultPageDimensions

getDesignMetadata getDesignTemplateMetadata getDesignToken initAppElement openDesign overlay.registerOnCanOpen publish.launch requestExport selection.registerOnChange setCurrentPageBackground ui.startDragToCursor ui.startDragToPoint ui.startDrag

Design: Test

initTestEnvironment

Error

Error: Test

initTestEnvironment

Intents

Intents: Content

prepareContentPublisher

Intents: Data

prepareDataConnector

Intents: Design

prepareDesignEditor

Intents: Test

initTestEnvironment

Platform

appProcess appProcess.broadcastMessage appProcess.current appProcess.current.getInfo appProcess.current.requestClose appProcess.current.setOnDispose appProcess.requestClose appProcess.registerOnMessage appProcess.registerOnStateChange features.isSupported features.registerOnSupportChange getPlatformInfo notification.addToast requestOpenExternalUrl Changelog

Platform: Test

initTestEnvironment

User

auth.getCanvaUserToken auth.initOauth monetization.isEnabled monetization.openTrackingSession monetization.requestEnableBillableAction Changelog

User: Test

initTestEnvironment

App scripts

build defineConfig dev extractTranslations prepareConfig Changelog

Changelog for @canva/app-scripts

The latest changes for the Canva Apps SDK @canva/app-scripts package.

v1.0.0 - 2026-08-12

Changed

@canva/app-scripts is now generally available, releases now use standard semver versions published to the latest npm dist-tag.

Fixed

Fixed the backend dev server crashing with Cannot find module 'esbuild-register' when the app is installed via pnpm.
Fixed the dev server needing two Ctrl+C presses to fully stop when a backend is configured.

v0.0.0-beta.5 - 2026-08-11

Added

Added support for the Apps SDK test harness to the webpack and Rsbuild adapters. See https://www.canva.dev/docs/apps/test-harness/ for details.
Exported prepareConfig() to resolve and validate a project's configuration (entry, output paths, translation settings) for a given command without running it. FullConfig, PreparedConfig, TranslationConfig, HarnessConfig and Command are now part of the public API.

v0.0.0-beta.4 - 2026-08-05

Fixed

Fixed an issue where .env was not loaded for API-only consumers. Environment variables such as CANVA_APP_ID are now loaded from the .env at rootDir, alongside canva-app.config.ts.

v0.0.0-beta.3 - 2026-08-03

Changed

Changed BuildResult.assets to objects with path and sizeBytes, and replaced ExtractTranslationsResult.files with a single outputFile reported the same way.
Updated the default rsbuild config to not summarize built assets (performance.printFileSize); asset sizes are reported on the build result instead.

Fixed

Fixed build results reporting bundler chunk names (app) instead of output filenames (app.js).

Security

Dependencies audit bringing modules up to date:

postcss                                  ^8.5.16   ->   ^8.5.23
webpack-dev-server                        ^5.2.5   ->   ^5.2.6

v0.0.0-beta.2 - 2026-07-10

Changed

CLI output polish: relative paths, resolved entry/bundler on the dev handle, backend-gated host warnings, and clean single-line errors.

v0.0.0-beta.1 - 2026-07-08

Added

Initial release of @canva/app-scripts.