Files
element-web/src/hooks/useRoomName.ts
David Langley 69ee8fd96a Change License: AGPL + Element Commercial (#28856)
* Add commercial licence and update config files

* Update license in headers

* Revert "Update license in headers"

This reverts commit 7ed7949485.

* 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.
2025-01-06 11:18:54 +00:00

43 lines
1.3 KiB
TypeScript

/*
Copyright 2024 New Vector Ltd.
Copyright 2021 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 { Room, RoomEvent } from "matrix-js-sdk/src/matrix";
import { useEffect, useState } from "react";
import { IOOBData } from "../stores/ThreepidInviteStore";
import { useTypedEventEmitter } from "./useEventEmitter";
import { _t } from "../languageHandler";
const getRoomName = (room?: Room, oobName = ""): string => room?.name || oobName;
/**
* Determines the room name from a combination of the room model and potential
* out-of-band information
* @param room - The room model
* @param oobData - out-of-band information about the room
* @returns {string} the room name
*/
export function useRoomName(room?: Room, oobData?: IOOBData): string {
let oobName = _t("common|unnamed_room");
if (oobData && oobData.name) {
oobName = oobData.name;
}
const [name, setName] = useState<string>(getRoomName(room, oobName));
useTypedEventEmitter(room, RoomEvent.Name, () => {
setName(getRoomName(room, oobName));
});
useEffect(() => {
setName(getRoomName(room, oobName));
}, [room, oobName]);
return name;
}