javascript/rive-react
1
0
Fork 0
mirror of https://github.com/rive-app/rive-react.git synced 2026-03-13 08:22:30 +08:00
Code Issues Packages Projects Releases Wiki Activity

update comments

Browse Source
This commit is contained in:
Hernan Torrisi
2024-05-27 18:08:18 -07:00
committed by hernan
parent e1c2d108e9
commit ac9f322ccb
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/hooks/useRiveFile.ts
View File

@@ -11,9 +11,9 @@ import { EventType, RiveFile } from '@rive-app/canvas';
* It sets up a RiveFile based on provided source parameters (URL or ArrayBuffer) and ensures
* proper cleanup to avoid memory leaks when the component unmounts or inputs change.
*
* @param params - Object containing parameters accepted by the Rive file in the rive-js runtime,
* @param params - Object containing parameters accepted by the Rive file in the @rive-app/canvas runtime,
*
* @returns {RiveFile} Contains the active RiveFile instance (`riveFile`).
* @returns {RiveFileState} Contains the active RiveFile instance (`riveFile`) and the loading status.
*/
function useRiveFile(params: UseRiveFileParameters): RiveFileState {
const [riveFile, setRiveFile] = useState<RiveFile | null>(null);
@@ -42,7 +42,7 @@ function useRiveFile(params: UseRiveFileParameters): RiveFileState {
loadRiveFile();
return () => {
file?.cleanup();
file?.cleanup();
};
}, [params.src, params.buffer]);