> ## Documentation Index > Fetch the complete documentation index at: https://www.canva.dev/docs/apps/llms.txt > Use this file to discover all available pages before exploring further. # createRichtextRange API reference for the createRichtextRange method. Creates a new RichtextRange object, which contains methods to manipulate text. ## Usage ### Create formatted text range ```typescript import { createRichtextRange } from "@canva/design"; import type { InlineFormatting } from "@canva/design"; const range = createRichtextRange(); range.appendText('Hello World', { color: '#000000', fontWeight: 'bold' } as InlineFormatting); ``` ### Format paragraph styles ```typescript import { createRichtextRange } from "@canva/design"; import type { RichtextFormatting } from "@canva/design"; const range = createRichtextRange(); const bounds = range.appendText('Centered Title\n'); range.formatParagraph(bounds.bounds, { fontSize: 32, textAlign: 'center' } as RichtextFormatting); ``` ### Create bulleted list ```typescript import { createRichtextRange } from "@canva/design"; const range = createRichtextRange(); const item = range.appendText('List item\n'); range.formatParagraph(item.bounds, { fontSize: 16, listLevel: 1, listMarker: 'disc' }); ``` ### Extract text content ```typescript import { createRichtextRange } from "@canva/design"; const range = createRichtextRange(); range.appendText('Sample text'); // Get plain text content const text = range.readPlaintext(); // Get formatted regions const regions = range.readTextRegions(); ``` ### Replace text with formatting ```typescript import { createRichtextRange } from "@canva/design"; const range = createRichtextRange(); range.appendText('Original text'); // Replace text while adding formatting range.replaceText( { index: 0, length: range.readPlaintext().length }, 'Modified', { color: '#0066CC', decoration: 'underline' } ); ``` ## Returns Provides methods for interacting with a range of formatted text. 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** The segment of the range on which to apply the formatting. Properties of bounds}> The starting position of the segment. This is zero-based, meaning the first character of the range is at index 0. The number of characters in the segment, starting from the index. The formatting to apply to the paragraph(s). Properties of formatting}> The color of the text as a hex code. The hex code must include all six characters and be prefixed with a `#` symbol. **Example** ```ts "#ff0099" ``` 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"` The style of the font. **Default value**: `"normal"` **Available values**: * `"normal"` * `"italic"` The decoration of the text. **Default value**: `"none"` **Available values**: * `"none"` * `"underline"` The strikethrough of the text. **Default value**: `"none"` **Available values**: * `"none"` * `"strikethrough"` An external URL that the text links to. A unique identifier that points to a font asset in Canva's backend. The size of the text, in pixels. * In the Canva editor, this number is shown as points (pts), not pixels. **Minimum**: `1` **Maximum**: `1000` The alignment of the text. **Default value**: `"start"` **Available values**: * `"start"` * `"center"` * `"end"` * `"justify"` The list indentation level of the paragraph. 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"` The line height of the paragraph, relative to the font size expressed in Em. **Minimum**: `0.5` **Maximum**: `2.5` **Default value**: `1.4` The spacing between characters, relative to the font size expressed in Em. * In the Canva editor, this number is shown as a multiple of 1000. **Minimum**: `-0.2` **Maximum**: `0.8` **Default value**: `0` **Returns** `void` **Examples** **Format paragraph as a heading** ```typescript import { createRichtextRange } from "@canva/design"; const range = createRichtextRange(); range.appendText("Heading Text\nRegular paragraph text."); // Format just the first paragraph as a heading range.formatParagraph( { index: 0, length: 12 }, // Only need to include part of the paragraph { fontSize: 24, fontWeight: 'bold', textAlign: 'center' } ); ``` **Create a bulleted list** ```typescript 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 list range.formatParagraph( { index: 0, length: text.length }, { listLevel: 1, listMarker: 'disc' } ); ``` Formats a region of text with inline formatting properties. **Parameters** The segment of the range on which to apply the formatting. Properties of bounds}> The starting position of the segment. This is zero-based, meaning the first character of the range is at index 0. The number of characters in the segment, starting from the index. The formatting to apply to the text. Properties of formatting}> The color of the text as a hex code. The hex code must include all six characters and be prefixed with a `#` symbol. **Example** ```ts "#ff0099" ``` 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"` The style of the font. **Default value**: `"normal"` **Available values**: * `"normal"` * `"italic"` The decoration of the text. **Default value**: `"none"` **Available values**: * `"none"` * `"underline"` The strikethrough of the text. **Default value**: `"none"` **Available values**: * `"none"` * `"strikethrough"` An external URL that the text links to. **Returns** `void` **Examples** **Format specific words in a paragraph** ```typescript 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** ```typescript 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' } ); ``` Appends the specified characters to the end of the range. **Parameters** The characters to append to the richtext range. Optional formatting to apply to the appended text. Properties of formatting}> The color of the text as a hex code. The hex code must include all six characters and be prefixed with a `#` symbol. **Example** ```ts "#ff0099" ``` 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"` The style of the font. **Default value**: `"normal"` **Available values**: * `"normal"` * `"italic"` The decoration of the text. **Default value**: `"none"` **Available values**: * `"none"` * `"underline"` The strikethrough of the text. **Default value**: `"none"` **Available values**: * `"none"` * `"strikethrough"` An external URL that the text links to. **Returns** A segment of a richtext range. Properties of bounds}> The starting position of the segment. This is zero-based, meaning the first character of the range is at index 0. The number of characters in the segment, starting from the index. **Examples** **Append plain text** ```typescript import { createRichtextRange } from "@canva/design"; const range = createRichtextRange(); range.appendText("First paragraph. "); // Append more text to the existing content const 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** ```typescript import { createRichtextRange } from "@canva/design"; const range = createRichtextRange(); range.appendText("Normal text followed by "); // Append formatted text range.appendText("bold red text", { fontWeight: 'bold', color: '#FF0000' }); // Append a new paragraph range.appendText("\nThis is a new paragraph."); ``` Replaces a region of text with the specified characters. **Parameters** The segment of the range to replace. Properties of bounds}> The starting position of the segment. This is zero-based, meaning the first character of the range is at index 0. The number of characters in the segment, starting from the index. The replacement characters. The formatting to apply to the replaced text. Properties of formatting}> The color of the text as a hex code. The hex code must include all six characters and be prefixed with a `#` symbol. **Example** ```ts "#ff0099" ``` 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"` The style of the font. **Default value**: `"normal"` **Available values**: * `"normal"` * `"italic"` The decoration of the text. **Default value**: `"none"` **Available values**: * `"none"` * `"underline"` The strikethrough of the text. **Default value**: `"none"` **Available values**: * `"none"` * `"strikethrough"` An external URL that the text links to. **Returns** The bounds of the replacement characters within the updated range. Properties of bounds}> The starting position of the segment. This is zero-based, meaning the first character of the range is at index 0. The number of characters in the segment, starting from the index. **Examples** **Replace text while maintaining some formatting** ```typescript 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** ```typescript import { createRichtextRange } from "@canva/design"; const range = createRichtextRange(); range.appendText("Regular text that needs emphasis."); // Replace "needs emphasis" with formatted text range.replaceText( { index: 17, length: 15 }, "is important", { fontWeight: 'bold', fontStyle: 'italic', color: '#0066CC' } ); ``` Returns the current state of the richtext as plaintext. **Returns** `string` **Examples** **Extract plain text content** ```typescript 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 formatting const plainText = range.readPlaintext(); // Do something with the plain text - plainText, e.g. "First paragraph.\nSecond paragraph with formatting." ``` **Search within text content** ```typescript import { createRichtextRange } from "@canva/design"; const range = createRichtextRange(); range.appendText("This text contains a searchable term."); // Search for a specific word const plainText = range.readPlaintext(); const searchTerm = "searchable"; const index = plainText.indexOf(searchTerm); if (index !== -1) { // Format the found term range.formatText( { index, length: searchTerm.length }, { fontWeight: 'bold', decoration: 'underline' } ); } ``` 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** The plaintext content of the region. The formatting of the region. Properties of formatting}> The color of the text as a hex code. The hex code must include all six characters and be prefixed with a `#` symbol. **Example** ```ts "#ff0099" ``` 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"` The style of the font. **Default value**: `"normal"` **Available values**: * `"normal"` * `"italic"` The decoration of the text. **Default value**: `"none"` **Available values**: * `"none"` * `"underline"` The strikethrough of the text. **Default value**: `"none"` **Available values**: * `"none"` * `"strikethrough"` An external URL that the text links to. A unique identifier that points to a font asset in Canva's backend. The size of the text, in pixels. * In the Canva editor, this number is shown as points (pts), not pixels. **Minimum**: `1` **Maximum**: `1000` The alignment of the text. **Default value**: `"start"` **Available values**: * `"start"` * `"center"` * `"end"` * `"justify"` The list indentation level of the paragraph. 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"` The line height of the paragraph, relative to the font size expressed in Em. **Minimum**: `0.5` **Maximum**: `2.5` **Default value**: `1.4` The spacing between characters, relative to the font size expressed in Em. * In the Canva editor, this number is shown as a multiple of 1000. **Minimum**: `-0.2` **Maximum**: `0.8` **Default value**: `0` **Examples** **Get text with formatting information** ```typescript 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 regions const 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** ```typescript import { createRichtextRange } from "@canva/design"; const range = createRichtextRange(); range.appendText("Mixed ", {}); range.appendText("formatted ", { fontWeight: 'bold' }); range.appendText("text", { color: '#0066CC' }); // Analyze formatting variations const regions = range.readTextRegions(); const formattingTypes = regions.map(region => { const formatting = region.formatting || {}; return { text: region.text, hasWeight: !!formatting.fontWeight, hasColor: !!formatting.color }; }); ```