🎥 Make videos programmatically with React
Report browser context in HTML-in-canvas errors
Jonny Burger64de7eed5157
diff --git a/packages/core/src/HtmlInCanvas.tsx b/packages/core/src/HtmlInCanvas.tsxindex 5eb355dc4a..ad8a485a15 100644--- a/packages/core/src/HtmlInCanvas.tsx+++ b/packages/core/src/HtmlInCanvas.tsx@@ -244,9 +244,59 @@ export const isHtmlInCanvasSupported = (): boolean => {return cachedSupport;};-/** Shown when {@link isHtmlInCanvasSupported} is false: APIs are absent (old Chrome and/or flag off). */+/** Generic fallback for consumers that cannot inspect the current browser. */export const HTML_IN_CANVAS_UNSUPPORTED_MESSAGE =- 'HTML in Canvas is not supported. Two common causes: Chrome is older than version 148 (update Chrome), or the HTML-in-Canvas flag is disabled at chrome://flags/#canvas-draw-element (enable it and restart Chrome).';+ 'HTML in Canvas requires Chrome 149 or newer with Canvas Draw Element enabled at chrome://flags/#canvas-draw-element.';++export const getHtmlInCanvasUnsupportedMessage = (): string => {+ if (typeof document === 'undefined') {+ return `HTML in Canvas is unavailable because there is no browser document. ${HTML_IN_CANVAS_UNSUPPORTED_MESSAGE}`;+ }++ const userAgent = typeof navigator === 'undefined' ? '' : navigator.userAgent;+ const chromiumVersion = userAgent.match(/(?:Chrome|Chromium)\/(\d+)/)?.[1];+ let browser = 'this browser';+ if (userAgent.includes('Edg/')) {+ browser = 'Microsoft Edge';+ } else if (userAgent.includes('Chromium/')) {+ browser = 'Chromium';+ } else if (chromiumVersion) {+ browser = 'Chrome';+ } else if (userAgent.includes('Firefox/')) {+ browser = 'Firefox';+ } else if (userAgent.includes('Safari/')) {+ browser = 'Safari';+ }++ if (chromiumVersion && Number(chromiumVersion) < 149) {+ return `HTML in Canvas is unavailable in ${browser} ${chromiumVersion}. It requires a Chromium-based browser running version 149 or newer. Update your browser.`;+ }++ if (!chromiumVersion) {+ return `HTML in Canvas is unavailable in ${browser}. Use Chrome 149 or newer, enable Canvas Draw Element at chrome://flags/#canvas-draw-element, and restart Chrome.`;+ }++ const canvas = document.createElement('canvas');+ const ctx = canvas.getContext('2d');+ const missingApis = [+ typeof ctx?.drawElementImage !== 'function' &&+ 'CanvasRenderingContext2D.drawElementImage()',+ typeof canvas.requestPaint !== 'function' && 'canvas.requestPaint()',+ typeof canvas.captureElementImage !== 'function' &&+ 'canvas.captureElementImage()',+ !('transferControlToOffscreen' in HTMLCanvasElement.prototype) &&+ 'canvas.transferControlToOffscreen()',+ ].filter(Boolean);+ const flagUrl =+ browser === 'Microsoft Edge'+ ? 'edge://flags/#canvas-draw-element'+ : 'chrome://flags/#canvas-draw-element';+ if (missingApis.length === 0) {+ return `HTML in Canvas is unavailable in ${browser} ${chromiumVersion}. Check that Canvas Draw Element is enabled at ${flagUrl}, then fully restart the browser.`;+ }++ return `HTML in Canvas is unavailable in ${browser} ${chromiumVersion}: ${missingApis.join(', ')} ${missingApis.length === 1 ? 'is' : 'are'} missing. Check that Canvas Draw Element is enabled at ${flagUrl}, then fully restart the browser.`;+};export type HtmlInCanvasOnPaint = (params: HtmlInCanvasOnPaintParams,@@ -415,7 +465,7 @@ const HtmlInCanvasContent = forwardRef<onPaint === undefined && onInit === undefined;if (!isHtmlInCanvasSupported()) {- cancelRender(new Error(HTML_IN_CANVAS_UNSUPPORTED_MESSAGE));+ cancelRender(new Error(getHtmlInCanvasUnsupportedMessage()));}const canvas2dRef = useRef<HTMLCanvasElement | null>(null);diff --git a/packages/core/src/index.ts b/packages/core/src/index.tsindex 1b9413b324..85de6a2000 100644--- a/packages/core/src/index.ts+++ b/packages/core/src/index.ts@@ -170,6 +170,7 @@ export {Solid} from './effects/Solid.js';export type {SolidProps} from './effects/Solid.js';export {HTML_IN_CANVAS_UNSUPPORTED_MESSAGE,+ getHtmlInCanvasUnsupportedMessage,HtmlInCanvas,isHtmlInCanvasSupported,type HtmlInCanvasOnInit,diff --git a/packages/transitions/src/html-in-canvas-presentation.tsx b/packages/transitions/src/html-in-canvas-presentation.tsxindex fe94431c1a..6d8d8fb529 100644--- a/packages/transitions/src/html-in-canvas-presentation.tsx+++ b/packages/transitions/src/html-in-canvas-presentation.tsx@@ -1,7 +1,7 @@import {useCallback, useLayoutEffect, useMemo, useRef, useState} from 'react';import {AbsoluteFill,- HTML_IN_CANVAS_UNSUPPORTED_MESSAGE,+ getHtmlInCanvasUnsupportedMessage,HtmlInCanvas,Internals,useDelayRender,@@ -30,7 +30,7 @@ export const HtmlInCanvasPresentation = <readonly effects?: EffectsProp;}) => {if (!HtmlInCanvas.isSupported()) {- throw new Error(HTML_IN_CANVAS_UNSUPPORTED_MESSAGE);+ throw new Error(getHtmlInCanvasUnsupportedMessage());}const canvasRef = useRef<HTMLCanvasElement>(null);