Files
outline/shared/editor/components/PDF.tsx
T
Tom Moor 9e405b50a4 refactor: Attach observers in ref callbacks instead of effects (#13881)
* refactor: Attach observers in ref callbacks instead of effects

Use React 19 ref callback cleanup for the ResizeObserver in Scrollable and
PDF and the IntersectionObserver in useOnScreen, which now returns a ref
callback rather than taking a ref object.

* fix: Remove unused ts-expect-error directives
2026-09-25 07:30:34 -04:00

164 lines
4.8 KiB
TypeScript

import React, { useCallback, useRef } from "react";
import { useMergeRefs } from "react-merge-refs";
import styled from "styled-components";
import useDragResize from "./hooks/useDragResize";
import { ResizeLeft, ResizeRight } from "./ResizeHandle";
import type { ComponentProps } from "../types";
import { isFirefox } from "../../utils/browser";
import { sanitizeUrl } from "../../utils/urls";
import Flex from "../../components/Flex";
import { s } from "../../styles";
import { Preview, Subtitle, Title } from "./Widget";
import { EditorStyleHelper } from "../styles/EditorStyleHelper";
import { pdfNaturalHeight, pdfNaturalWidth } from "../lib/pdf";
type Props = ComponentProps & {
/** Icon to display on the left side of the widget */
icon: React.ReactNode;
/** Title of the widget */
title: React.ReactNode;
/** Context, displayed to right of title */
context?: React.ReactNode;
/** Callback triggered when the pdf is resized */
onChangeSize?: (props: { width: number; height?: number }) => void;
};
export default function PdfViewer(props: Props) {
const { node, isEditable, onChangeSize, isSelected } = props;
const { href, name } = node.attrs;
const ref = useRef<HTMLDivElement>(null);
const embedRef = useRef<HTMLEmbedElement>(null);
const debounceTimerRef = useRef<NodeJS.Timeout | null>(null);
const { width, handlePointerDown, dragging } = useDragResize({
width: node.attrs.width,
height: node.attrs.height,
naturalWidth: pdfNaturalWidth,
naturalHeight: pdfNaturalHeight,
onChangeSize,
ref,
});
// force embed to reload, so the content fits the new size.
const observeRef = useCallback(
(element: HTMLDivElement | null) => {
// firefox handles resizing on its own
// and forced reload causes the parent to collapse while resizing
if (isFirefox || !element) {
return;
}
const observer = new ResizeObserver(() => {
if (dragging) {
return;
}
if (debounceTimerRef.current) {
clearTimeout(debounceTimerRef.current);
}
debounceTimerRef.current = setTimeout(() => {
if (embedRef.current) {
embedRef.current.src = "";
requestAnimationFrame(() => {
if (embedRef.current) {
embedRef.current.src = sanitizeUrl(href) ?? "";
}
});
}
}, 250);
});
observer.observe(element);
return () => {
observer.disconnect();
if (debounceTimerRef.current) {
clearTimeout(debounceTimerRef.current);
}
};
},
[dragging, href]
);
const mergedRef = useMergeRefs([ref, observeRef]);
return (
<PDFWrapper
contentEditable={false}
ref={mergedRef}
className={
isSelected || dragging
? "pdf-wrapper ProseMirror-selectednode"
: "pdf-wrapper"
}
style={{ width: width ?? "100%" }}
$dragging={!!dragging}
>
<Flex gap={6} align="center">
{props.icon}
<Preview>
<Title>{props.title}</Title>
<Subtitle>{props.context}</Subtitle>
</Preview>
</Flex>
<embed
title={name}
src={sanitizeUrl(href)}
ref={embedRef}
style={{
width: "100%",
height: "auto",
aspectRatio: `${pdfNaturalWidth} / ${pdfNaturalHeight}`,
pointerEvents:
!isEditable || (isSelected && !dragging) ? "initial" : "none",
marginTop: 6,
}}
/>
{isEditable && !!props.onChangeSize && (
<>
<ResizeLeft
onPointerDown={handlePointerDown("left")}
$dragging={!!(isSelected || dragging)}
/>
<ResizeRight
onPointerDown={handlePointerDown("right")}
$dragging={!!(isSelected || dragging)}
/>
</>
)}
</PDFWrapper>
);
}
const PDFWrapper = styled.div<{ $dragging: boolean }>`
line-height: 0;
position: relative;
margin-left: auto;
margin-right: auto;
max-width: 100%;
transition-property: width, height;
transition-duration: ${(props) => (props.$dragging ? "0ms" : "120ms")};
transition-timing-function: ease-in-out;
overflow: hidden;
will-change: ${(props) => (props.$dragging ? "width, height" : "auto")};
box-shadow: 0 0 0 1px ${s("divider")};
border-radius: ${EditorStyleHelper.blockRadius};
padding: ${EditorStyleHelper.blockRadius};
embed {
display: block;
max-width: 100%;
transition-property: width, height;
transition-duration: ${(props) => (props.$dragging ? "0ms" : "120ms")};
transition-timing-function: ease-in-out;
will-change: ${(props) => (props.$dragging ? "width, height" : "auto")};
}
&:hover {
${ResizeLeft}, ${ResizeRight} {
opacity: 1;
}
}
`;