addElementAtCursor
Add element to responsive documents, which slot things into a text stream
Usage
Insert an image at cursor position
import { addElementAtCursor } from "@canva/design";import type { ImageElement } from "@canva/design";import type { ImageRef } from "@canva/asset";const exampleImageRef = "YOUR_IMAGE_REF" as ImageRef;const imageElement: ImageElement = {type: 'image',ref: exampleImageRef,altText: { text: 'Product image', decorative: false }};await addElementAtCursor(imageElement);
Insert a video at cursor position
import { addElementAtCursor } from "@canva/design";import type { VideoElement } from "@canva/design";import type { VideoRef } from "@canva/asset";const exampleVideoRef = "YOUR_VIDEO_REF" as VideoRef;const videoElement: VideoElement = {type: 'video',ref: exampleVideoRef,altText: { text: 'Product demo', decorative: false }};await addElementAtCursor(videoElement);
Insert embedded content at cursor position
import { addElementAtCursor } from "@canva/design";import type { EmbedElement } from "@canva/design";const embedElement: EmbedElement = {type: 'embed',url: 'https://www.youtube.com/watch?v=...'};await addElementAtCursor(embedElement);
Insert text at cursor position
import { addElementAtCursor } from "@canva/design";import type { TextElement } from "@canva/design";const textElement: TextElement = {type: 'text',children: ['Hello World'],fontSize: 24,color: '#000000'};await addElementAtCursor(textElement);
Insert formatted text at cursor position
import { addElementAtCursor, createRichtextRange } from "@canva/design";import type { RichtextElement } from "@canva/design";const range = createRichtextRange();range.appendText('Rich Text Content', { color: '#000000' });const richtextElement: RichtextElement = {type: 'richtext',range};await addElementAtCursor(richtextElement);
Insert a table at cursor position
import { addElementAtCursor } from "@canva/design";import type { TableElement } from "@canva/design";const tableElement: TableElement = {type: 'table',rows: [{cells: [{ type: 'string', value: 'Header 1' },{ type: 'string', value: 'Header 2' }]},{cells: [{ type: 'string', value: 'Data 1' },{ type: 'string', value: 'Data 2' }]}]};await addElementAtCursor(tableElement);
Parameters
element
ElementAtCursor
Elements targeting a cursor are a subset of the base Element
An element that renders image content.
type
string
The type of element.
This must be "image"
.
altText
AltText | undefined
A description of the image content.
Use undefined
for content with no description.
text
string
The text content.
decorative
boolean | undefined
Indicates where the alternative text should be displayed.
- If
true
, the alternative text will only be displayed in the editor. - If
false
, the alternative text will be displayed in the editor and in view-only mode.
dataUrl
string
A data URL that contains the image data.
ref
ImageRef
A unique identifier that points to an image asset in Canva's backend.
An element that renders video content.
type
string
The type of element.
This must be "video"
.
ref
VideoRef
A unique identifier that points to a video asset in Canva's backend.
altText
AltText | undefined
A description of the video content.
Use undefined
for content with no description.
text
string
The text content.
decorative
boolean | undefined
Indicates where the alternative text should be displayed.
- If
true
, the alternative text will only be displayed in the editor. - If
false
, the alternative text will be displayed in the editor and in view-only mode.
An element that renders rich media, such as a YouTube video.
type
string
The type of element.
This must be "embed"
.
url
string
The URL of the rich media.
This URL must be supported by the Iframely API.
An element that renders text content.
type
string
The type of element.
This must be "text"
.
children
string[]
The text content.
Only the first element in this array is used.
fontSize
number
The size of the text.
Minimum: 1
Maximum: 100
Default value: 16
textAlign
string
The alignment of the text.
Default value: "start"
Available values:
"start"
"center"
"end"
"justify"
color
string
The color of the text as a hex code.
The hex code must include all six characters and be prefixed with a #
symbol.
Example
"#ff0099"
fontRef
FontRef
A unique identifier that points to a font asset in Canva's backend.
fontWeight
FontWeight
The weight (thickness) of the font.
Default value: "normal"
Available values:
"normal"
"thin"
"extralight"
"light"
"medium"
"semibold"
"bold"
"ultrabold"
"heavy"
fontStyle
string
The style of the font.
Default value: "normal"
Available values:
"normal"
"italic"
decoration
string
The decoration of the font.
Default value: "none"
Available values:
"none"
"underline"
An element that renders richtext content.
type
string
The type of element.
This must be "richtext"
.
range
RichtextRange
The richtext content.
formatParagraph
function
Formats all of the paragraphs that overlap the given bounds.
- The
\n
character indicates the end of a paragraph. - All paragraphs that overlap the provided bounds will be formatted in their entirety.
Parameters
bounds
Bounds
The segment of the range on which to apply the formatting.
index
number
The starting position of the segment.
This is zero-based, meaning the first character of the range is at index 0.
length
number
The number of characters in the segment, starting from the index.
formatting
RichtextFormatting
The formatting to apply to the paragraph(s).
color
string
The color of the text as a hex code.
The hex code must include all six characters and be prefixed with a #
symbol.
Example
"#ff0099"
fontWeight
FontWeight
The weight (thickness) of the font.
The available font weights depend on the font.
Default value: "normal"
Available values:
"normal"
"thin"
"extralight"
"light"
"medium"
"semibold"
"bold"
"ultrabold"
"heavy"
fontStyle
string
The style of the font.
Default value: "normal"
Available values:
"normal"
"italic"
decoration
string
The decoration of the text.
Default value: "none"
Available values:
"none"
"underline"
strikethrough
string
The strikethrough of the text.
Default value: "none"
Available values:
"none"
"strikethrough"
link
string
An external URL that the text links to.
fontRef
FontRef
A unique identifier that points to a font asset in Canva's backend.
fontSize
number
The size of the text, in pixels.
- In the Canva editor, this number is shown as points (pts), not pixels.
Minimum: 1
Maximum: 100
textAlign
string
The alignment of the text.
Default value: "start"
Available values:
"start"
"center"
"end"
"justify"
listLevel
number
The list indentation level of the paragraph.
listMarker
string
The appearance of list item markers.
This property only has an effect if listLevel
is greater than 0.
Default value: "none"
Available values:
"none"
"disc"
"circle"
"square"
"decimal"
"lower-alpha"
"lower-roman"
"checked"
"unchecked"
Returns
void
Examples
Format paragraph as a heading
import { createRichtextRange } from "@canva/design";const range = createRichtextRange();range.appendText("Heading Text\nRegular paragraph text.");// Format just the first paragraph as a headingrange.formatParagraph({ index: 0, length: 12 }, // Only need to include part of the paragraph{fontSize: 24,fontWeight: 'bold',textAlign: 'center'});
Create a bulleted list
import { createRichtextRange } from "@canva/design";const range = createRichtextRange();const text = "Item 1\nItem 2\nItem 3";range.appendText(text);// Format all paragraphs as a bulleted listrange.formatParagraph({ index: 0, length: text.length },{listLevel: 1,listMarker: 'disc'});
formatText
function
Formats a region of text with inline formatting properties.
Parameters
bounds
Bounds
The segment of the range on which to apply the formatting.
index
number
The starting position of the segment.
This is zero-based, meaning the first character of the range is at index 0.
length
number
The number of characters in the segment, starting from the index.
formatting
InlineFormatting
The formatting to apply to the text.
color
string
The color of the text as a hex code.
The hex code must include all six characters and be prefixed with a #
symbol.
Example
"#ff0099"
fontWeight
FontWeight
The weight (thickness) of the font.
The available font weights depend on the font.
Default value: "normal"
Available values:
"normal"
"thin"
"extralight"
"light"
"medium"
"semibold"
"bold"
"ultrabold"
"heavy"
fontStyle
string
The style of the font.
Default value: "normal"
Available values:
"normal"
"italic"
decoration
string
The decoration of the text.
Default value: "none"
Available values:
"none"
"underline"
strikethrough
string
The strikethrough of the text.
Default value: "none"
Available values:
"none"
"strikethrough"
link
string
An external URL that the text links to.
Returns
void
Examples
Format specific words in a paragraph
import { createRichtextRange } from "@canva/design";const range = createRichtextRange();range.appendText("This text contains important information.");// Format just the word "important"range.formatText({ index: 16, length: 9 },{fontWeight: 'bold',color: '#FF0000'});
Add a link to text
import { createRichtextRange } from "@canva/design";const range = createRichtextRange();range.appendText("Visit our website for more information.");// Add a link to "our website"range.formatText({ index: 6, length: 11 },{link: "https://www.example.com",decoration: 'underline',color: '#0066CC'});
appendText
function
Appends the specified characters to the end of the range.
Parameters
characters
string
The characters to append to the richtext range.
formatting
InlineFormatting
Optional formatting to apply to the appended text.
color
string
The color of the text as a hex code.
The hex code must include all six characters and be prefixed with a #
symbol.
Example
"#ff0099"
fontWeight
FontWeight
The weight (thickness) of the font.
The available font weights depend on the font.
Default value: "normal"
Available values:
"normal"
"thin"
"extralight"
"light"
"medium"
"semibold"
"bold"
"ultrabold"
"heavy"
fontStyle
string
The style of the font.
Default value: "normal"
Available values:
"normal"
"italic"
decoration
string
The decoration of the text.
Default value: "none"
Available values:
"none"
"underline"
strikethrough
string
The strikethrough of the text.
Default value: "none"
Available values:
"none"
"strikethrough"
link
string
An external URL that the text links to.
Returns
bounds
Bounds
A segment of a richtext range.
index
number
The starting position of the segment.
This is zero-based, meaning the first character of the range is at index 0.
length
number
The number of characters in the segment, starting from the index.
Examples
Append plain text
import { createRichtextRange } from "@canva/design";const range = createRichtextRange();range.appendText("First paragraph. ");// Append more text to the existing contentconst result = range.appendText("This is additional text.");// The bounds of the newly added text are returned// Do something with the bounds - result.bounds, e.g. { index: 17, length: 24 }
Append formatted text
import { createRichtextRange } from "@canva/design";const range = createRichtextRange();range.appendText("Normal text followed by ");// Append formatted textrange.appendText("bold red text", {fontWeight: 'bold',color: '#FF0000'});// Append a new paragraphrange.appendText("\nThis is a new paragraph.");
replaceText
function
Replaces a region of text with the specified characters.
Parameters
bounds
Bounds
The segment of the range to replace.
index
number
The starting position of the segment.
This is zero-based, meaning the first character of the range is at index 0.
length
number
The number of characters in the segment, starting from the index.
characters
string
The replacement characters.
formatting
InlineFormatting
The formatting to apply to the replaced text.
color
string
The color of the text as a hex code.
The hex code must include all six characters and be prefixed with a #
symbol.
Example
"#ff0099"
fontWeight
FontWeight
The weight (thickness) of the font.
The available font weights depend on the font.
Default value: "normal"
Available values:
"normal"
"thin"
"extralight"
"light"
"medium"
"semibold"
"bold"
"ultrabold"
"heavy"
fontStyle
string
The style of the font.
Default value: "normal"
Available values:
"normal"
"italic"
decoration
string
The decoration of the text.
Default value: "none"
Available values:
"none"
"underline"
strikethrough
string
The strikethrough of the text.
Default value: "none"
Available values:
"none"
"strikethrough"
link
string
An external URL that the text links to.
Returns
bounds
Bounds
The bounds of the replacement characters within the updated range.
index
number
The starting position of the segment.
This is zero-based, meaning the first character of the range is at index 0.
length
number
The number of characters in the segment, starting from the index.
Examples
Replace text while maintaining some formatting
import { createRichtextRange } from "@canva/design";const range = createRichtextRange();range.appendText("This text needs correction.");// Replace "needs correction" with "is correct"const result = range.replaceText({ index: 10, length: 16 },"is correct");// The bounds of the replaced text are returned// Do something with the bounds - result.bounds, e.g. { index: 10, length: 10 }
Replace text with formatted text
import { createRichtextRange } from "@canva/design";const range = createRichtextRange();range.appendText("Regular text that needs emphasis.");// Replace "needs emphasis" with formatted textrange.replaceText({ index: 17, length: 15 },"is important",{fontWeight: 'bold',fontStyle: 'italic',color: '#0066CC'});
readPlaintext
function
Returns the current state of the richtext as plaintext.
Returns
string
Examples
Extract plain text content
import { createRichtextRange } from "@canva/design";const range = createRichtextRange();range.appendText("First paragraph.\n", { fontWeight: 'bold' });range.appendText("Second paragraph with formatting.", { color: '#FF0000' });// Get plain text content without formattingconst plainText = range.readPlaintext();// Do something with the plain text - plainText, e.g. "First paragraph.\nSecond paragraph with formatting."
Search within text content
import { createRichtextRange } from "@canva/design";const range = createRichtextRange();range.appendText("This text contains a searchable term.");// Search for a specific wordconst plainText = range.readPlaintext();const searchTerm = "searchable";const index = plainText.indexOf(searchTerm);if (index !== -1) {// Format the found termrange.formatText({ index, length: searchTerm.length },{ fontWeight: 'bold', decoration: 'underline' });}
readTextRegions
function
Returns the current state of the richtext as one or more text regions. Each region is an object that contains the text content and its formatting.
Returns
text
string
The plaintext content of the region.
formatting
Partial<RichtextFormatting>
The formatting of the region.
color
string
The color of the text as a hex code.
The hex code must include all six characters and be prefixed with a #
symbol.
Example
"#ff0099"
fontWeight
FontWeight
The weight (thickness) of the font.
The available font weights depend on the font.
Default value: "normal"
Available values:
"normal"
"thin"
"extralight"
"light"
"medium"
"semibold"
"bold"
"ultrabold"
"heavy"
fontStyle
string
The style of the font.
Default value: "normal"
Available values:
"normal"
"italic"
decoration
string
The decoration of the text.
Default value: "none"
Available values:
"none"
"underline"
strikethrough
string
The strikethrough of the text.
Default value: "none"
Available values:
"none"
"strikethrough"
link
string
An external URL that the text links to.
fontRef
FontRef
A unique identifier that points to a font asset in Canva's backend.
fontSize
number
The size of the text, in pixels.
- In the Canva editor, this number is shown as points (pts), not pixels.
Minimum: 1
Maximum: 100
textAlign
string
The alignment of the text.
Default value: "start"
Available values:
"start"
"center"
"end"
"justify"
listLevel
number
The list indentation level of the paragraph.
listMarker
string
The appearance of list item markers.
This property only has an effect if listLevel
is greater than 0.
Default value: "none"
Available values:
"none"
"disc"
"circle"
"square"
"decimal"
"lower-alpha"
"lower-roman"
"checked"
"unchecked"
Examples
Get text with formatting information
import { createRichtextRange } from "@canva/design";const range = createRichtextRange();range.appendText("Normal text ", {});range.appendText("bold text", { fontWeight: 'bold' });range.appendText(" and ", {});range.appendText("red text", { color: '#FF0000' });// Get formatted regionsconst regions = range.readTextRegions();// Do something with the regions, e.g.// [// { text: "Normal text ", formatting: {} },// { text: "bold text", formatting: { fontWeight: 'bold' } },// { text: " and ", formatting: {} },// { text: "red text", formatting: { color: '#FF0000' } }// ]
Analyze formatting variations
import { createRichtextRange } from "@canva/design";const range = createRichtextRange();range.appendText("Mixed ", {});range.appendText("formatted ", { fontWeight: 'bold' });range.appendText("text", { color: '#0066CC' });// Analyze formatting variationsconst regions = range.readTextRegions();const formattingTypes = regions.map(region => {const formatting = region.formatting || {};return {text: region.text,hasWeight: !!formatting.fontWeight,hasColor: !!formatting.color};});
An element that renders a table.
type
string
The type of element.
This must be "table"
.
rows
object[]
The rows of the table.
cells
Array<Cell | null | undefined>
The cells (columns) of the row.
Each row must have the same number of cells.
This should be either the following object, null
, or undefined
.
attributes
CellAttributes
The attributes of the cell.
backgroundColor
string
The background color of the cell, as a hex code.
fontSize
number
The size of the text.
Minimum: 1
Maximum: 100
Default value: 16
textAlign
string
The alignment of the text.
Default value: "start"
Available values:
"start"
"center"
"end"
"justify"
color
string
The color of the text as a hex code.
The hex code must include all six characters and be prefixed with a #
symbol.
Example
"#ff0099"
fontRef
FontRef
A unique identifier that points to a font asset in Canva's backend.
fontWeight
FontWeight
The weight (thickness) of the font.
Default value: "normal"
Available values:
"normal"
"thin"
"extralight"
"light"
"medium"
"semibold"
"bold"
"ultrabold"
"heavy"
fontStyle
string
The style of the font.
Default value: "normal"
Available values:
"normal"
"italic"
decoration
string
The decoration of the font.
Default value: "none"
Available values:
"none"
"underline"
colSpan
number
The number of columns that the cell occupies.
rowSpan
number
The number of rows that the cell occupies.
type
string
Available values:
"empty"
"string"
value
string
The plaintext content of the cell.
If an empty string is provided, the type
will change to "empty"
.
Returns
Promise<void>