App embed elements

Create embed elements inside app elements.

Running this example

To run this example locally:

  1. 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.

  2. 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.

  3. Clone the starter kit:

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

    npm install
    SHELL
  5. Run the example:

    npm run start app_embed_elements
    SHELL
  6. 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 { type AppElementOptions, initAppElement } from "@canva/design";
import {
Button,
FormField,
NumberInput,
Rows,
Text,
TextInput,
} from "@canva/app-ui-kit";
import * as styles from "styles/components.css";
import { useEffect, useState } from "react";
type AppElementData = {
url: string;
width: number;
height: number;
};
// The state of the user interface. In this example,
// we have data representing AppElementData, but it could be different.
// We also store an update function that can be used to update the app element.
type AppElementChangeEvent = {
data: AppElementData;
update?: (opts: AppElementOptions<AppElementData>) => Promise<void>;
};
const initialState: AppElementChangeEvent = {
data: {
url: "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
width: 640,
height: 360,
},
};
const appElementClient = initAppElement<AppElementData>({
render: (data) => {
return [{ type: "embed", ...data, top: 0, left: 0 }];
},
});
export const App = () => {
const [state, setState] = useState<AppElementChangeEvent>(initialState);
const {
data: { url, width, height },
} = state;
const disabled = url?.trim().length < 1 || !width || !height;
useEffect(() => {
appElementClient.registerOnElementChange((appElement) => {
setState(
appElement
? {
data: appElement.data,
update: appElement.update,
}
: initialState,
);
});
}, []);
return (
<div className={styles.scrollContainer}>
<Rows spacing="2u">
<Text>
This example demonstrates how apps can create embed elements inside
app elements. This makes the element re-editable and lets apps control
additional properties, such as the width and height.
</Text>
<FormField
label="URL"
value={url}
control={(props) => (
<TextInput
{...props}
onChange={(value) => {
setState((prevState) => {
return {
...prevState,
data: {
...prevState.data,
url: value,
},
};
});
}}
/>
)}
/>
<FormField
label="Width"
value={width}
control={(props) => (
<NumberInput
{...props}
min={1}
onChange={(value) => {
setState((prevState) => {
return {
...prevState,
data: {
...prevState.data,
width: Number(value || 0),
},
};
});
}}
/>
)}
/>
<FormField
label="Height"
value={height}
control={(props) => (
<NumberInput
{...props}
min={1}
onChange={(value) => {
setState((prevState) => {
return {
...prevState,
data: {
...prevState.data,
height: Number(value || 0),
},
};
});
}}
/>
)}
/>
<Button
variant="primary"
stretch
onClick={() => {
if (state.update) {
state.update({ data: state.data });
} else {
appElementClient.addElement({ data: state.data });
}
}}
disabled={disabled}
>
{`${state.update ? "Update" : "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
# App embed elements
Demonstrates how to create embed elements inside app elements, making embeds re-editable with customizable properties like URL, width, and height. Shows how to wrap embed functionality in an app element for enhanced control.
For API reference docs and instructions on running this example, see: https://www.canva.dev/docs/apps/examples/app-embed-elements/.
Related examples: See design_elements/embed_elements for direct embed insertion, or app_video_elements for video-specific app elements.
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
- Input validation and sanitization is simplified for demonstration. Production apps must implement comprehensive URL validation and error handling for invalid embed URLs
- 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

Need Help?