DraggableVideo
The DraggableVideo
component has been deprecated. Instead, use the VideoCard
(opens in a new tab or window) component.
Usage
import React from "react";import { DraggableVideo } from "components/draggable_video";import { upload } from "@canva/asset";export function App() {return (<DraggableVideomimeType="video/mp4"durationInSeconds={7}thumbnailImageSrc="https://www.canva.dev/example-assets/video-import/thumbnail-image.jpg"thumbnailVideoSrc="https://www.canva.dev/example-assets/video-import/thumbnail-video.mp4"resolveVideoRef={() => {return 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",aiDisclosure: "none",});}}/>);}
Props
mimeType
string
RequiredThe MIME type of the full-size video file.
The supported MIME types include:
"video/avi"
"image/gif"
"video/x-m4v"
"video/x-matroska"
"video/quicktime"
"video/mp4"
"video/mpeg"
"video/webm"
resolveVideoRef
function
RequiredA function that returns the result of the upload
method.
thumbnailImageSrc
string
RequiredA thumbnail image to display in the object panel of the Canva editor.
thumbnailVideoSrc
string
OptionalA low-resolution version of the full video with a maximum duration of 10 seconds. This can be omitted when the mimeType
is "video/gif"
.
duration
number
OptionalThe duration of the full video, in seconds.
width
number
OptionalThe width of the thumbnail, in pixels.
height
number
OptionalThe height of the thumbnail, in pixels.
previewSrc
string
OptionalThe URL or data URL of the image to use for the drag preview. This image will appear under the user's cursor as they during the drag event.
If omitted, thumbnailImageSrc
will be used as a fallback.
previewSize
object
OptionalThe dimensions of the drag preview. The dimensions should have the same aspect ratio as the full-size video.
If omitted, the width
and height
will be used as a fallback.
previewSize.width
number
RequiredThe width of the drag preview, in pixels.
previewSize.height
number
RequiredThe height of the drag preview, in pixels.
fullSize
object
OptionalThe dimensions of the full-size video, in pixels.
If omitted, the dimensions of the drag preview will be used.
fullSize.width
number
RequiredThe width of the full-size video, in pixels.
fullSize.height
number
RequiredThe height of the full-size video, in pixels.