API reference

Asset

getTemporaryUrl findFonts openColorSelector requestFontSelection upload Changelog

Design

addAudioTrack addElementAtCursor

addElementAtPoint

addPage

bulkCreate.launch createRichtextRange editContent

getCurrentPageContext getDesignColors

getDesignMetadata

getDesignTemplateMetadata getDesignToken initAppElement

openDesign

overlay.registerOnCanOpen publish.launch requestExport selection.registerOnChange setCurrentPageBackground ui.startDragToCursor ui.startDragToPoint

Changelog

Intents

Changelog

Intents: Asset

prepareUrlExpander

Intents: Content

prepareContentPublisher

Intents: data

prepareDataConnector

Intents: design

prepareDesignEditor

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

User

auth.getCanvaUserToken auth.initOauth

Changelog

App middleware

initUserTokenVerifier

initDesignTokenVerifier

Changelog

App middleware: Express

Error

getDesignColors

API reference for the getDesignColors method.

This 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.

Retrieves the colors currently used in the design.

Usage: Get design colors

import { getDesignColors } from "@canva/design";

const { colors } = await getDesignColors();

TYPESCRIPT

Returns

. This is a Promise that resolves with the following object:

colorsDesignColor[]

The colors used by elements in the current design.

Not all elements are included, and the colors returned may change. The order of colors is not guaranteed.

A solid color from the user's design.

typestring

The only valid value is "solid".

colorstring

The hexadecimal code representing the color. This is a 6 character code prefixed with the '#' symbol.

Represents a color type that is currently not supported by the SDK.

One entry is returned per unsupported color in the design (no deduplication).

typestring

The only valid value is "unsupported".