If you haven't already, create a new app in the Developer Portal⁠(opens in a new tab or window). For more information, refer to our Quickstart guide.
In your app's configuration on the Developer Portal⁠(opens in a new tab or window), ensure the "Development URL" is set to http://localhost:8080.

Clone the starter kit:

git clone https://github.com/canva-sdks/canva-apps-sdk-starter-kit.git
cd canva-apps-sdk-starter-kit

SHELL

Install dependencies:
```
npm install
```
SHELL
Run the example:
```
npm run start embed_elements
```
SHELL
Click the Preview URL link shown in the terminal to open the example in the Canva editor.

Example app source code

// For usage information, see the README.md file.
import { useCallback, useState } from "react";
import * as styles from "styles/components.css";
import { Button, FormField, Rows, Text, TextInput } from "@canva/app-ui-kit";
import { useAddElement } from "utils/use_add_element";

export const App = () => {
  const [url, setUrl] = useState("https://www.youtube.com/watch?v=o-YBDTqX_ZU");
  const addElement = useAddElement();

  const disabled = url.trim().length < 1;

  const addEmbed = useCallback(() => {
    addElement({
      type: "embed",
      url,
    });
  }, [url, addElement]);

  return (
    <div className={styles.scrollContainer}>
      <Rows spacing="3u">
        <Text>
          This example demonstrates how apps can add embed elements to a design.
        </Text>
        <FormField
          label="URL"
          value={url}
          control={(props) => (
            <TextInput
              {...props}
              onChange={(value) => {
                setUrl(value);
              }}
            />
          )}
        />
        <Button
          variant="primary"
          onClick={addEmbed}
          disabled={disabled}
          stretch
        >
          Add element
        </Button>
      </Rows>
    </div>
  );
};

TYPESCRIPT

import { AppUiProvider } from "@canva/app-ui-kit";
import { createRoot } from "react-dom/client";
import { App } from "./app";
import "@canva/app-ui-kit/styles.css";

const root = createRoot(document.getElementById("root") as Element);
function render() {
  root.render(
    <AppUiProvider>
      <App />
    </AppUiProvider>,
  );
}

render();

if (module.hot) {
  module.hot.accept("./app", render);
}

TYPESCRIPT

# Embed elements

Demonstrates how to add embed elements to designs using URLs from supported platforms. Shows embed creation, URL input handling, and embed insertion patterns.

For API reference docs and instructions on running this example, see: https://www.canva.dev/docs/apps/examples/embed-elements/.

Related examples: See app_embed_elements for embeds within app elements, or drag_and_drop/drag_and_drop_embed for drag-and-drop embed insertion.

NOTE: This example differs from what is expected for public apps to pass a Canva review:

- Content is hardcoded for demonstration purposes only. Production apps should provide user input interfaces for URL entry and dynamic content loading
- URL validation and sanitization is simplified for demonstration. Production apps must implement comprehensive URL validation and support multiple embed platforms
- Error handling is simplified for demonstration. Production apps must implement comprehensive error handling with clear user feedback and graceful failure modes
- Internationalization is not implemented. Production apps must support multiple languages using the `@canva/app-i18n-kit` package to pass Canva review requirements

MARKDOWN

API Reference

App UI Kit

Need Help?

Join our Community Forum⁠(opens in a new tab or window)
Report issues with this example on GitHub⁠(opens in a new tab or window)