API reference
Asset: Test
Design
addAudioTrackaddElementAtCursoraddElementAtPointaddNativeElementaddPagebulkCreate.launchcreateRichtextRangeeditContentgetBrandKitColorsgetCurrentPageContextgetCurrentPageMetadatagetDefaultPageDimensionsgetDesignColorsgetDesignMetadatagetDesignTemplateMetadatagetDesignTokeninitAppElementopenDesignoverlay.registerOnCanOpenpublish.launchrequestExportselection.registerOnChangesetCurrentPageBackgroundui.startDragToCursorui.startDragToPointui.startDragChangelog
Design: Test
Error
Error: Test
Intents
Intents: Content
Intents: Data
Intents: Design
Intents: Test
Platform
appProcessappProcess.broadcastMessageappProcess.currentappProcess.current.getInfoappProcess.current.requestCloseappProcess.current.setOnDisposeappProcess.requestCloseappProcess.registerOnMessageappProcess.registerOnStateChangefeatures.isSupportedfeatures.registerOnSupportChangegetPlatformInfonotification.addToastrequestOpenExternalUrlChangelog
Platform: Test
User
User: Test
Changelog for @canva/app-scripts
The latest changes for the Canva Apps SDK @canva/app-scripts package.
v1.1.1 - 2026-08-31
Security
- Dependencies audit bringing modules up to date:
postcss ^8.5.23 -> ^8.5.26
v1.1.0 - 2026-08-20
Changed
- Linked the migration guide for apps moving off a hand-rolled webpack setup from the README.
- Pinned
@formatjs/ts-transformer,chalk,nodemonandyargsto exact versions instead of^ranges, as newer releases of these particular packages are known to cause issues. - Added titles to
@exampleblocks indefineConfig(),build(),dev(), andBaseAppConfig.backendTSDoc strings. This ensures multiple examples render distinctly on the same API, as labelled sections instead of being merged together untitled.
Fixed
- Upgraded
css-loaderto7.1.4so its@rspack/corepeer range covers2.x, fixing brokennpm install/npm ciresolution for consumers on Rspack 2. - Documented the
webpackoverload ofdefineConfig()separately from thersbuildone, so its generated API reference no longer shows the Rsbuild-specific description and example.
v1.0.0 - 2026-08-12
Changed
@canva/app-scriptsis now generally available, releases now use standard semver versions published to thelatestnpm 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 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,HarnessConfigandCommandare now part of the public API.
v0.0.0-beta.4 - 2026-08-05
Fixed
- Fixed an issue where
.envwas not loaded for API-only consumers. Environment variables such asCANVA_APP_IDare now loaded from the.envatrootDir, alongsidecanva-app.config.ts.
v0.0.0-beta.3 - 2026-08-03
Changed
- Changed
BuildResult.assetsto objects withpathandsizeBytes, and replacedExtractTranslationsResult.fileswith a singleoutputFilereported 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.23webpack-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.