Skip to content

🎥 Make videos programmatically with React

9.5 KB
Raw Blame
import React, {useCallback, useContext, useState} from 'react';
import {StudioServerConnectionCtx} from '../helpers/client-id';
import {CURRENT_COLOR, LIGHT_TEXT, WHITE} from '../helpers/colors';
import {BookIcon} from '../icons/book';
import {BrowseElementsIcon} from '../icons/browse-elements';
import {LinkIcon} from '../icons/link';
import {TrashIcon} from '../icons/trash';
import {SetSelectedModalContext} from '../state/modals';
import {ActionTooltip} from './ActionTooltip';
import {Button} from './Button';
import {callApi} from './call-api';
import {InlineAction} from './InlineAction';
import {sectionHeader} from './InspectorPanel/styles';
import {RemotionInput} from './NewComposition/RemInput';
import {ValidationMessage} from './NewComposition/ValidationMessage';
import {useSettings} from './SettingsContext';
import {Spinner} from './Spinner';

const REMOTION_ELEMENTS_URL = 'https://www.remotion.dev/elements';
const THIRD_PARTY_ELEMENTS_URL = 'https://www.remotion.dev/elements/libraries';

const container: React.CSSProperties = {
	alignSelf: 'flex-start',
	boxSizing: 'border-box',
	flex: 1,
	minWidth: 0,
	width: '100%',
};

const description: React.CSSProperties = {
	color: LIGHT_TEXT,
	fontSize: 13,
	lineHeight: 1.5,
	margin: '16px 16px 12px',
};

const addLibraryHeading: React.CSSProperties = {
	...sectionHeader,
	margin: '12px 0 0',
	padding: '4px 16px',
};

const addLibraryActions: React.CSSProperties = {
	display: 'flex',
	gap: 8,
	padding: '4px 16px 4px 6px',
};

const addLibraryButtonContent: React.CSSProperties = {
	alignItems: 'center',
	display: 'flex',
	gap: 6,
};

const addLibraryButtonIcon: React.CSSProperties = {
	flexShrink: 0,
	height: 14,
	width: 14,
};

const libraryRow: React.CSSProperties = {
	alignItems: 'center',
	display: 'flex',
	gap: 10,
	minHeight: 38,
	padding: '4px 16px',
};

const libraryIcon: React.CSSProperties = {
	flexShrink: 0,
	height: 22,
	width: 22,
};

const libraryDetails: React.CSSProperties = {
	alignItems: 'flex-start',
	display: 'flex',
	flex: 1,
	flexDirection: 'column',
	minWidth: 0,
};

const libraryName: React.CSSProperties = {
	fontSize: 13,
	maxWidth: '100%',
	overflow: 'hidden',
	textOverflow: 'ellipsis',
	whiteSpace: 'nowrap',
};

const libraryUrlStyle: React.CSSProperties = {
	cursor: 'pointer',
	fontSize: 12,
	maxWidth: '100%',
	minWidth: 0,
	outline: 'none',
	overflow: 'hidden',
	textDecoration: 'none',
	textOverflow: 'ellipsis',
	whiteSpace: 'nowrap',
};

const inputRow: React.CSSProperties = {
	display: 'flex',
	gap: 8,
	padding: '4px 16px',
};

const input: React.CSSProperties = {
	flex: 1,
	minWidth: 0,
};

const message: React.CSSProperties = {
	padding: '4px 16px',
};

const trashIcon: React.CSSProperties = {
	height: 14,
	width: 14,
};

export const ElementLibrariesSettings: React.FC = () => {
	const {setSelectedModal} = useContext(SetSelectedModalContext);
	const {studioRuntimeConfig} = useSettings();
	const {previewServerState} = useContext(StudioServerConnectionCtx);
	const [url, setUrl] = useState('');
	const [displayName, setDisplayName] = useState('');
	const [busy, setBusy] = useState<string | null>(null);
	const [error, setError] = useState<string | null>(null);
	const [hoveredUrl, setHoveredUrl] = useState<string | null>(null);
	const [isAddByUrlVisible, setIsAddByUrlVisible] = useState(false);
	const libraries = (studioRuntimeConfig?.elementLibraries ?? []).filter(
		(library) => library.url !== REMOTION_ELEMENTS_URL,
	);
	let normalizedUrl: string | null = null;
	try {
		const parsedUrl = new URL(url.trim());
		if (parsedUrl.protocol === 'http:' || parsedUrl.protocol === 'https:') {
			normalizedUrl = parsedUrl.href;
		}
	} catch {
		// Keep the Add button disabled until a valid URL is entered.
	}

	const duplicate =
		normalizedUrl === REMOTION_ELEMENTS_URL ||
		libraries.some((library) => library.url === normalizedUrl);
	const canSave = previewServerState.type === 'connected' && busy === null;
	const addLibrary = useCallback(async () => {
		if (!canSave || normalizedUrl === null || duplicate) {
			return;
		}

		setBusy('add');
		setError(null);
		try {
			const response = await callApi('/api/update-config', {
				clientId: previewServerState.clientId,
				updates: [
					{
						setter: 'addElementLibrary',
						type: 'set',
						value: displayName.trim()
							? {url: normalizedUrl, displayName: displayName.trim()}
							: {url: normalizedUrl},
					},
				],
			});
			if (!response.success) {
				setError(response.reason);
				return;
			}

			setUrl('');
			setDisplayName('');
		} catch (err) {
			setError((err as Error).message);
		} finally {
			setBusy(null);
		}
	}, [canSave, displayName, duplicate, normalizedUrl, previewServerState]);

	const removeLibrary = useCallback(
		async (libraryUrl: string) => {
			if (previewServerState.type !== 'connected' || busy !== null) {
				return;
			}

			setBusy(libraryUrl);
			setError(null);
			try {
				const response = await callApi('/api/update-config', {
					clientId: previewServerState.clientId,
					updates: [
						{
							setter: 'addElementLibrary',
							type: 'delete',
							value: libraryUrl,
						},
					],
				});
				if (!response.success) {
					setError(response.reason);
				}
			} catch (err) {
				setError((err as Error).message);
			} finally {
				setBusy(null);
			}
		},
		[busy, previewServerState],
	);

	const renderTrash = useCallback((color: string) => {
		return <TrashIcon color={color} style={trashIcon} />;
	}, []);
	const discoverThirdPartyElements = useCallback(() => {
		setSelectedModal({
			type: 'element-library',
			name: 'Third-party Elements',
			url: THIRD_PARTY_ELEMENTS_URL,
		});
	}, [setSelectedModal]);

	return (
		<section style={container}>
			<p style={description}>
				Add libraries to browse their elements in Studio.
			</p>
			<div role="list" aria-label="Element Libraries">
				<div role="listitem" style={libraryRow}>
					<BrowseElementsIcon
						aria-hidden
						color={LIGHT_TEXT}
						style={libraryIcon}
					/>
					<div style={libraryDetails}>
						<div style={libraryName}>Remotion Elements</div>
						<a
							href={REMOTION_ELEMENTS_URL}
							target="_blank"
							rel="noopener noreferrer"
							style={{
								...libraryUrlStyle,
								color:
									hoveredUrl === REMOTION_ELEMENTS_URL ? WHITE : LIGHT_TEXT,
							}}
							onMouseEnter={() => setHoveredUrl(REMOTION_ELEMENTS_URL)}
							onMouseLeave={() => setHoveredUrl(null)}
						>
							{REMOTION_ELEMENTS_URL.replace(/^https?:\/\//, '')}
						</a>
					</div>
				</div>
				{libraries.map((library) => (
					<div key={library.url} role="listitem" style={libraryRow}>
						<BrowseElementsIcon
							aria-hidden
							color={LIGHT_TEXT}
							style={libraryIcon}
						/>
						<div style={libraryDetails}>
							<div style={libraryName}>
								{library.displayName ?? new URL(library.url).host}
							</div>
							<a
								href={library.url}
								target="_blank"
								rel="noopener noreferrer"
								style={{
									...libraryUrlStyle,
									color: hoveredUrl === library.url ? WHITE : LIGHT_TEXT,
								}}
								onMouseEnter={() => setHoveredUrl(library.url)}
								onMouseLeave={() => setHoveredUrl(null)}
							>
								{library.url.replace(/^https?:\/\//, '')}
							</a>
						</div>
						{busy === library.url ? (
							<Spinner duration={0.5} size={14} />
						) : (
							<ActionTooltip
								label="Remove"
								shortcut={null}
								delay={800}
								dismissOnClick
							>
								<InlineAction
									aria-label={`Remove ${library.displayName ?? library.url}`}
									disabled={!canSave}
									onClick={() => removeLibrary(library.url)}
									renderAction={renderTrash}
									variant={null}
								/>
							</ActionTooltip>
						)}
					</div>
				))}
			</div>
			<h3 style={addLibraryHeading}>Add new library</h3>
			<div style={addLibraryActions}>
				<Button
					onClick={discoverThirdPartyElements}
					size="default"
					buttonContainerStyle={addLibraryButtonContent}
				>
					<BookIcon
						aria-hidden
						color={CURRENT_COLOR}
						style={addLibraryButtonIcon}
					/>
					Explore libraries
				</Button>
				<Button
					onClick={() => setIsAddByUrlVisible(true)}
					size="default"
					buttonContainerStyle={addLibraryButtonContent}
				>
					<LinkIcon
						aria-hidden
						color={CURRENT_COLOR}
						style={addLibraryButtonIcon}
					/>
					Add by URL
				</Button>
			</div>
			{isAddByUrlVisible ? (
				<>
					<div style={inputRow}>
						<RemotionInput
							aria-label="Element Library URL"
							placeholder="https://example.com/elements"
							status="ok"
							rightAlign={false}
							style={input}
							value={url}
							onChange={(event) => setUrl(event.target.value)}
						/>
						<RemotionInput
							aria-label="Element Library name"
							placeholder="Name (optional)"
							status="ok"
							rightAlign={false}
							style={input}
							value={displayName}
							onChange={(event) => setDisplayName(event.target.value)}
						/>
					</div>
					<div style={inputRow}>
						<Button
							disabled={!canSave || normalizedUrl === null || duplicate}
							onClick={addLibrary}
							size="compact"
						>
							{busy === 'add' ? 'Adding…' : '+ Add Element Library'}
						</Button>
					</div>
					{duplicate ? (
						<div style={message}>
							<ValidationMessage
								align="flex-start"
								type="warning"
								message="This library is already added."
							/>
						</div>
					) : null}
				</>
			) : null}
			{error ? (
				<div style={message}>
					<ValidationMessage align="flex-start" type="error" message={error} />
				</div>
			) : null}
		</section>
	);
};