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
initTestEnvironment
API reference for the initTestEnvironment method.
Initializes a test environment for the @canva/error package, enabling unit tests to mock Canva's APIs.
This method should only be called once in a test environment, such as in a Jest setup file.
Usage: Setting up a test environment
// Import testing sub-packageimport * as error from "@canva/error/test";// Initialize the test environmenterror.initTestEnvironment();// The `@canva/error` package does not need to be mocked.
TYPESCRIPT
Returns
void