Skip to content

🎥 Make videos programmatically with React

Elements: Hide drag handle inside Studio

Igor Samokhovets6d541bd0ee9e
diff --git a/packages/docs/src/components/Elements/ElementPage.tsx b/packages/docs/src/components/Elements/ElementPage.tsx
index 3f84ac90b7..a12f89d538 100644
--- a/packages/docs/src/components/Elements/ElementPage.tsx
+++ b/packages/docs/src/components/Elements/ElementPage.tsx
@@ -52,6 +52,7 @@ export const ElementPage: React.FC<ElementPageProps> = ({
const [isSourceVisible, setIsSourceVisible] = useState(false);
const [isBrowserStudioActionVisible, setIsBrowserStudioActionVisible] =
useState(false);
+ const [isEmbeddedInStudio, setIsEmbeddedInStudio] = useState(false);
const posterRef = useRef<HTMLImageElement>(null);
const sourceId = useId();
const {height: previewHeight, width: previewWidth} =
@@ -66,6 +67,13 @@ export const ElementPage: React.FC<ElementPageProps> = ({
}, [definition, sourceCode]);
useEffect(() => {
+ // Internal navigation may drop the query parameter, but the page remains
+ // inside the same Studio iframe.
+ setIsEmbeddedInStudio(
+ new URLSearchParams(window.location.search).get('remotion-studio') ===
+ 'true' || window.parent !== window,
+ );
+
const onKeyDown = (event: KeyboardEvent) => {
if (
event.repeat ||
@@ -227,25 +235,27 @@ export const ElementPage: React.FC<ElementPageProps> = ({
</PlainButton>
) : null}
</div>
- <div
- className={styles.dragHandle}
- draggable
- onDragStart={(event) => {
- setStudioDragData({
- dataTransfer: event.dataTransfer,
- payload: elementPayload,
- });
- setElementDragImage(event.dataTransfer, posterRef.current);
- }}
- title="Drag into your Studio browser tab to choose where the element is placed on the canvas or timeline"
- >
- <span aria-hidden="true" className={styles.dragHandleIcon}>
- â ¿
- </span>
- <span className={styles.dragHandleText}>
- <strong>Drag into Studio</strong>
- </span>
- </div>
+ {isEmbeddedInStudio ? null : (
+ <div
+ className={styles.dragHandle}
+ draggable
+ onDragStart={(event) => {
+ setStudioDragData({
+ dataTransfer: event.dataTransfer,
+ payload: elementPayload,
+ });
+ setElementDragImage(event.dataTransfer, posterRef.current);
+ }}
+ title="Drag into your Studio browser tab to choose where the element is placed on the canvas or timeline"
+ >
+ <span aria-hidden="true" className={styles.dragHandleIcon}>
+ â ¿
+ </span>
+ <span className={styles.dragHandleText}>
+ <strong>Drag into Studio</strong>
+ </span>
+ </div>
+ )}
{installStatus.type === 'success' ||
installStatus.type === 'error' ? (
<p
diff --git a/packages/example/e2e/studio-protocol.test.mts b/packages/example/e2e/studio-protocol.test.mts
index c6dc6f2ba2..3dd04185c7 100644
--- a/packages/example/e2e/studio-protocol.test.mts
+++ b/packages/example/e2e/studio-protocol.test.mts
@@ -173,20 +173,26 @@ export const MyComponent = () => {
const officialLibraryRequests: string[] = [];
const externalLibraryRequests: string[] = [];
const context = await browser.newContext();
- await context.route('https://www.remotion.dev/elements', async (route) => {
- officialLibraryRequests.push(route.request().url());
- await route.fulfill({
- status: 302,
- headers: {Location: senderUrl},
- });
- });
- await context.route(externalLibraryUrl, async (route) => {
- externalLibraryRequests.push(route.request().url());
- await route.fulfill({
- status: 302,
- headers: {Location: senderUrl},
- });
- });
+ await context.route(
+ 'https://www.remotion.dev/elements?remotion-studio=true',
+ async (route) => {
+ officialLibraryRequests.push(route.request().url());
+ await route.fulfill({
+ status: 302,
+ headers: {Location: senderUrl},
+ });
+ },
+ );
+ await context.route(
+ `${externalLibraryUrl}?remotion-studio=true`,
+ async (route) => {
+ externalLibraryRequests.push(route.request().url());
+ await route.fulfill({
+ status: 302,
+ headers: {Location: senderUrl},
+ });
+ },
+ );
try {
await waitForUrl(studioUrl, studioProcess);
const studioPage = await context.newPage();
@@ -247,7 +253,7 @@ export const MyComponent = () => {
);
await expect(officialElementsIframe).toBeVisible();
expect(officialLibraryRequests).toEqual([
- 'https://www.remotion.dev/elements',
+ 'https://www.remotion.dev/elements?remotion-studio=true',
]);
expect(context.pages()).toHaveLength(2);
await studioPage.keyboard.press('Escape');
@@ -274,7 +280,9 @@ export const MyComponent = () => {
'local-network-access; loopback-network',
);
await expect(elementsIframe).toHaveAttribute('credentialless', '');
- expect(externalLibraryRequests).toEqual([externalLibraryUrl]);
+ expect(externalLibraryRequests).toEqual([
+ `${externalLibraryUrl}?remotion-studio=true`,
+ ]);
expect(context.pages()).toHaveLength(2);
const elementsFrame = studioPage.frameLocator(
`iframe[title="${externalLibraryLabel} library"]`,
diff --git a/packages/studio/src/components/ElementLibraryModal.tsx b/packages/studio/src/components/ElementLibraryModal.tsx
index 86e8bae890..d58c77b53b 100644
--- a/packages/studio/src/components/ElementLibraryModal.tsx
+++ b/packages/studio/src/components/ElementLibraryModal.tsx
@@ -33,7 +33,9 @@ export const ElementLibraryModal: React.FC<{
// Studio is cross-origin isolated. A credentialless iframe may embed a
// library that does not set Cross-Origin-Resource-Policy headers.
iframe.setAttribute('credentialless', '');
- iframe.src = url;
+ const iframeUrl = new URL(url);
+ iframeUrl.searchParams.set('remotion-studio', 'true');
+ iframe.src = iframeUrl.toString();
}, [url]);
return (