Skip navigation

Skip to main content

API reference
Intents: design
API reference

requestFontSelection

API reference for the requestFontSelection method.

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.

The only valid value is "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.

The only valid value is "aborted".