API reference

Asset

getTemporaryUrl findFonts openColorSelector requestFontSelection upload

Design

addAudioTrack addElementAtCursor addElementAtPoint addNativeElement addPage createRichtextRange editContent getCurrentPageContext getDefaultPageDimensions getDesignMetadata getDesignToken initAppElement openDesign overlay.registerOnCanOpen requestExport selection.registerOnChange setCurrentPageBackground ui.startDragToCursor ui.startDragToPoint ui.startDrag

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

User

auth.getCanvaUserToken auth.initOauth

API reference

requestFontSelection

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

Opens a font picker.

Usage

Open a font picker

import { requestFontSelection } from "@canva/asset";

const response = await requestFontSelection();

TYPESCRIPT

Open a font picker with a preselected font

import { type FontRef, requestFontSelection } from "@canva/asset";

const placeholderFontRef = "PLACEHOLDER_FONT_REF" as FontRef;

const response = await requestFontSelection({
  selectedFontRef: placeholderFontRef
});

TYPESCRIPT

Handle font selection response

import { requestFontSelection } from "@canva/asset";

const response = await requestFontSelection();

if (response.type === "completed") {
  const { ref, name, weights } = response.font;
} else {
  // Handle selection cancelled if needed
}

TYPESCRIPT

Parameters

requestFontSelectionRequest

Optional

Options for configuring a font picker.

selectedFontRefFontRef

Optional

The ref of a font to display as selected when the font picker is opened.

Returns

The result of selecting a font from a font picker. This is a Promise that resolves with the following object:

typestring

The type of result.

This must be "completed".

fontFont

The selected font.

refFontRef

A unique identifier that points to a font asset in Canva's backend.

namestring

The name of the font.

weightsFontWeight[]

The available font weights for the font.

weightFontWeightName

The name of the font weight.

Available values:

"normal"
"thin"
"extralight"
"light"
"medium"
"semibold"
"bold"
"ultrabold"
"heavy"

stylesFontStyle[]

The font styles available for this specific font weight.

Available values:

"normal"
"italic"

previewUrlstring

Optional

The URL of an image that renders a preview of the font.

typestring

The type of result.

This must be "aborted".