David LangleyandGitHub
69ee8fd96a
* Add commercial licence and update config files * Update license in headers * Revert "Update license in headers" This reverts commit 7ed7949485e88889a9ffc8075a9df1f8e936777e. * Update only spdx id * Remove LicenseRef- from package.json LicenseRef- no longer allowed in npm v3 package.json This fixes the warning in the logs and failing build check.
33 lines
1.1 KiB
TypeScript
33 lines
1.1 KiB
TypeScript
/*
|
|
Copyright 2024 New Vector Ltd.
|
|
Copyright 2020 The Matrix.org Foundation C.I.C.
|
|
|
|
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
|
|
Please see LICENSE files in the repository root for full details.
|
|
*/
|
|
|
|
import { useEffect, useRef } from "react";
|
|
|
|
import { ActionPayload } from "../dispatcher/payloads";
|
|
import { MatrixDispatcher } from "../dispatcher/dispatcher";
|
|
|
|
// Hook to simplify listening to event dispatches
|
|
export const useDispatcher = (dispatcher: MatrixDispatcher, handler: (payload: ActionPayload) => void): void => {
|
|
// Create a ref that stores handler
|
|
const savedHandler = useRef((payload: ActionPayload) => {});
|
|
|
|
// Update ref.current value if handler changes.
|
|
useEffect(() => {
|
|
savedHandler.current = handler;
|
|
}, [handler]);
|
|
|
|
useEffect(() => {
|
|
// Create event listener that calls handler function stored in ref
|
|
const ref = dispatcher.register((payload) => savedHandler.current(payload));
|
|
// Remove event listener on cleanup
|
|
return () => {
|
|
dispatcher.unregister(ref);
|
|
};
|
|
}, [dispatcher]);
|
|
};
|