Examples
App elements
Assets and media
Fundamentals
Intents
Design interaction
Drag and drop
Design elements
Localization
Content replacement
Shape elements with asset
Create shape elements with image and video fills.
Running this example
To run this example locally:
-
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.gitcd canva-apps-sdk-starter-kitSHELL -
Install dependencies:
npm installSHELL -
Run the example:
npm run start shape_elements_with_assetSHELL -
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 { addElementAtPoint } from "@canva/design";import { upload } from "@canva/asset";import { Alert, Button, Rows, Text } from "@canva/app-ui-kit";import * as styles from "styles/components.css";import { useFeatureSupport } from "utils/use_feature_support";const HEART_PATH ="M 20 10 C 20.97 5 22.911 0 29.702 0 C 36.494 0 41.83 5 39.405 15 C 36.979 25 25.821 30 20 40 C 14.179 30 3.021 25 0.595 15 C -1.8304 5 3.5059 0 10.298 0 C 17.089 0 19.03 5 20 10 Z";export const App = () => {const isSupported = useFeatureSupport();const isRequiredFeatureSupported = isSupported(addElementAtPoint);const addShapeWithImageFill = async () => {// Start uploading the imageconst image = await upload({type: "image",mimeType: "image/jpeg",url: "https://www.canva.dev/example-assets/image-import/image.jpg",thumbnailUrl:"https://www.canva.dev/example-assets/image-import/thumbnail.jpg",width: 540,height: 720,aiDisclosure: "none",});// Add the image to the designawait addElementAtPoint({type: "shape",paths: [{d: HEART_PATH,fill: {dropTarget: true,asset: {type: "image",ref: image.ref,},},},],viewBox: {width: 40,height: 40,top: 0,left: 0,},});// Wait for the upload to finish so we can report errors if it fails to// uploadawait image.whenUploaded();// upload is completed// eslint-disable-next-line no-consoleconsole.log("Upload complete!");};const addShapeWithVideoFill = async () => {// Start uploading the videoconst video = await upload({type: "video",mimeType: "video/mp4",url: "https://www.canva.dev/example-assets/video-import/video.mp4",thumbnailImageUrl:"https://www.canva.dev/example-assets/video-import/thumbnail-image.jpg",thumbnailVideoUrl:"https://www.canva.dev/example-assets/video-import/thumbnail-video.mp4",width: 405,height: 720,aiDisclosure: "none",});// Add the video to the designawait addElementAtPoint({type: "shape",paths: [{d: HEART_PATH,fill: {dropTarget: true,asset: {type: "video",ref: video.ref,},},},],viewBox: {width: 40,height: 40,top: 0,left: 0,},});// Wait for the upload to finish so we can report errors if it fails to// uploadawait video.whenUploaded();// upload is completed// eslint-disable-next-line no-consoleconsole.log("Upload complete!");};return (<div className={styles.scrollContainer}><Rows spacing="3u"><Text>This example demonstrates how apps can add shape elements with imageand video fill.</Text><Rows spacing="1.5u"><ButtononClick={addShapeWithImageFill}variant="secondary"// ShapeElement is not supported in certain design types such as docs.disabled={!isRequiredFeatureSupported}stretch>Add shape element with image fill</Button><ButtononClick={addShapeWithVideoFill}variant="secondary"// ShapeElement is not supported in certain design types such as docs.disabled={!isRequiredFeatureSupported}stretch>Add shape element with video fill</Button></Rows>{!isRequiredFeatureSupported && <UnsupportedAlert />}</Rows></div>);};const UnsupportedAlert = () => (<Alert tone="warn">Sorry, the required features are not supported in the current design.</Alert>);
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
# Shape elements with asset fillDemonstrates how to create custom shape elements filled with image assets. Shows combining vector paths with image fills to create unique design elements with both shape and image properties.For API reference docs and instructions on running this example, see: https://www.canva.dev/docs/apps/examples/shape-elements-with-asset/.Related examples: See design_elements/shape_elements for solid color shapes, or design_elements/image_elements for standalone image insertion.NOTE: This example differs from what is expected for public apps to pass a Canva review:- Static assets are used for demonstration purposes only. Production apps should host assets on a CDN/hosting service and use the `upload` function from the `@canva/asset` package- Asset format validation is not implemented. Production apps should validate asset formats and handle unsupported formats gracefully- 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?
- 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)