Skip to content

Update instance removal logic on component unmount #153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 23, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 33 additions & 23 deletions src/index.tsx
Original file line number Diff line number Diff line change
@@ -1,53 +1,63 @@
import diff from "microdiff";
import p5 from "p5";
import React, { createRef, FC, memo, useState } from "react";
import React, { createRef, FC, memo, MutableRefObject, useRef } from "react";
import { useIsomorphicEffect } from "rooks";

type Wrapper = HTMLDivElement;

export interface SketchProps {
export type Sketch = (instance: P5CanvasInstance) => void;
export type SketchProps = {
[key: string]: any;
}

export interface Sketch {
(instance: P5Instance): void;
}

export interface P5WrapperProps extends SketchProps {
};
export type P5WrapperProps = SketchProps & {
sketch: Sketch;
}

export interface P5Instance extends p5 {
};
export type P5CanvasInstance = p5 & {
updateWithProps?: (props: SketchProps) => void;
}
};

// @TODO: remove in next major version, keep for compatibility reasons for now.
export type P5Instance = P5CanvasInstance;

function createCanvas(sketch: Sketch, wrapper: Wrapper): P5Instance {
function createCanvasInstance(
sketch: Sketch,
wrapper: Wrapper
): P5CanvasInstance {
return new p5(sketch, wrapper);
}

function removeCanvasInstance(
canvasInstanceRef: MutableRefObject<P5CanvasInstance | undefined>
) {
canvasInstanceRef.current?.remove();
canvasInstanceRef.current = undefined;
}

const ReactP5WrapperComponent: FC<P5WrapperProps> = ({
sketch,
children,
...props
}) => {
const wrapperRef = createRef<Wrapper>();
const [instance, setInstance] = useState<P5Instance>();
const canvasInstanceRef = useRef<P5CanvasInstance>();

useIsomorphicEffect(() => {
if (wrapperRef.current === null) {
return;
}

instance?.remove();
const canvas = createCanvas(sketch, wrapperRef.current);
setInstance(canvas);
removeCanvasInstance(canvasInstanceRef);
canvasInstanceRef.current = createCanvasInstance(
sketch,
wrapperRef.current
);
}, [sketch]);

useIsomorphicEffect(() => {
instance?.updateWithProps?.(props);
}, [props, instance]);
useIsomorphicEffect(
() => canvasInstanceRef.current?.updateWithProps?.(props),
[props]
);

useIsomorphicEffect(() => () => instance?.remove(), []);
useIsomorphicEffect(() => () => removeCanvasInstance(canvasInstanceRef), []);

return <div ref={wrapperRef}>{children}</div>;
};
Expand Down