UseCreateAutoDisposedViewModel for audio player (#31503)

* refactor: useCreateAutoDisposedViewModel for audio player

* Update src/viewmodels/audio/AudioPlayerViewModel.ts

Co-authored-by: Michael Telatynski <7t3chguy@gmail.com>

---------

Co-authored-by: Michael Telatynski <7t3chguy@gmail.com>
This commit is contained in:
Florian Duros
2025-12-11 16:41:27 +01:00
committed by GitHub
parent cd71c109d3
commit 23fbe9cef6
3 changed files with 22 additions and 8 deletions

View File

@@ -6,11 +6,11 @@ SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Com
Please see LICENSE files in the repository root for full details.
*/
import React, { type JSX, useEffect, useMemo } from "react";
import React, { type JSX, useEffect } from "react";
import { logger } from "matrix-js-sdk/src/logger";
import { type IContent } from "matrix-js-sdk/src/matrix";
import { type MediaEventContent } from "matrix-js-sdk/src/types";
import { AudioPlayerView } from "@element-hq/web-shared-components";
import { AudioPlayerView, useCreateAutoDisposedViewModel } from "@element-hq/web-shared-components";
import { type Playback } from "../../../audio/Playback";
import InlineSpinner from "../elements/InlineSpinner";
@@ -132,13 +132,10 @@ interface AudioPlayerProps {
* AudioPlayer component that initializes the AudioPlayerViewModel and renders the AudioPlayerView.
*/
function AudioPlayer({ playback, mediaName }: AudioPlayerProps): JSX.Element {
const vm = useMemo(() => new AudioPlayerViewModel({ playback, mediaName }), [playback, mediaName]);
const vm = useCreateAutoDisposedViewModel(() => new AudioPlayerViewModel({ playback, mediaName }));
useEffect(() => {
return () => {
vm.dispose();
};
}, [vm]);
vm.setProps({ playback, mediaName });
}, [playback, mediaName, vm]);
return <AudioPlayerView vm={vm} />;
}

View File

@@ -141,4 +141,13 @@ export class AudioPlayerViewModel
public onSeekbarChange = async (ev: ChangeEvent<HTMLInputElement>): Promise<void> => {
await this.props.playback.skipTo((Number(ev.target.value) / 100) * this.props.playback.durationSeconds);
};
/**
* Updates the properties of the view model and recomputes the snapshot.
* @param newProps
*/
public setProps(newProps: Partial<Props>): void {
this.props = { ...this.props, ...newProps };
this.setSnapshot();
}
}

View File

@@ -64,4 +64,12 @@ describe("AudioPlayerViewModel", () => {
vm.onKeyDown(event);
expect(playback.skipTo).toHaveBeenCalledWith(10 + 5); // 5 seconds forward
});
it("should update snapshot when setProps is called with new mediaName", () => {
const vm = new AudioPlayerViewModel({ playback, mediaName: "oldName" });
expect(vm.getSnapshot().mediaName).toBe("oldName");
vm.setProps({ mediaName: "newName" });
expect(vm.getSnapshot().mediaName).toBe("newName");
});
});