Live location share - beacon tooltip in maximised view (#8572) PSF-926

* pass optional tooltip prop down through markers

Signed-off-by: Kerry Archibald <kerrya@element.io>

* add beaconstatustooltip, handle overflow on beacon status label

Signed-off-by: Kerry Archibald <kerrya@element.io>

* remove debug, fix mouseout

Signed-off-by: Kerry Archibald <kerrya@element.io>

* tidy comments

Signed-off-by: Kerry Archibald <kerrya@element.io>

src/components/views/beacon/BeaconMarker.tsx

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import React, { useContext } from 'react';
+import React, { ReactNode, useContext } from 'react';
 import maplibregl from 'maplibre-gl';
 import {
     Beacon,
@@ -29,12 +29,13 @@ import SmartMarker from '../location/SmartMarker';
 interface Props {
     map: maplibregl.Map;
     beacon: Beacon;
+    tooltip?: ReactNode;
 }
 
 /**
  * Updates a map SmartMarker with latest location from given beacon
  */
-const BeaconMarker: React.FC<Props> = ({ map, beacon }) => {
+const BeaconMarker: React.FC<Props> = ({ map, beacon, tooltip }) => {
     const latestLocationState = useEventEmitterState(
         beacon,
         BeaconEvent.LocationUpdate,
@@ -58,6 +59,7 @@ const BeaconMarker: React.FC<Props> = ({ map, beacon }) => {
         id={beacon.identifier}
         geoUri={geoUri}
         roomMember={markerRoomMember}
+        tooltip={tooltip}
         useMemberColor
     />;
 };

src/components/views/beacon/BeaconStatusTooltip.tsx

@@ -0,0 +1,61 @@
+/*
+Copyright 2022 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import React, { useContext } from 'react';
+import { Beacon } from 'matrix-js-sdk/src/matrix';
+import { LocationAssetType } from 'matrix-js-sdk/src/@types/location';
+
+import MatrixClientContext from '../../../contexts/MatrixClientContext';
+import CopyableText from '../elements/CopyableText';
+import BeaconStatus from './BeaconStatus';
+import { BeaconDisplayStatus } from './displayStatus';
+
+interface Props {
+    beacon: Beacon;
+}
+
+const useBeaconName = (beacon: Beacon): string => {
+    const matrixClient = useContext(MatrixClientContext);
+
+    if (beacon.beaconInfo.assetType !== LocationAssetType.Self) {
+        return beacon.beaconInfo.description;
+    }
+    const room = matrixClient.getRoom(beacon.roomId);
+    const member = room?.getMember(beacon.beaconInfoOwner);
+
+    return member?.rawDisplayName || beacon.beaconInfoOwner;
+};
+
+const BeaconStatusTooltip: React.FC<Props> = ({ beacon }) => {
+    const label = useBeaconName(beacon);
+
+    return <div className='mx_BeaconStatusTooltip'>
+        <BeaconStatus
+            beacon={beacon}
+            label={label}
+            displayStatus={BeaconDisplayStatus.Active}
+            displayLiveTimeRemaining
+            className='mx_BeaconStatusTooltip_inner'
+        >
+            <CopyableText
+                border={false}
+                getTextToCopy={() => beacon.latestLocationState?.uri}
+            />
+        </BeaconStatus>
+    </div>;
+};
+
+export default BeaconStatusTooltip;

src/components/views/beacon/BeaconViewDialog.tsx

@@ -37,6 +37,7 @@ import { _t } from '../../../languageHandler';
 import AccessibleButton from '../elements/AccessibleButton';
 import DialogSidebar from './DialogSidebar';
 import DialogOwnBeaconStatus from './DialogOwnBeaconStatus';
+import BeaconStatusTooltip from './BeaconStatusTooltip';
 
 interface IProps extends IDialogProps {
     roomId: Room['roomId'];
@@ -103,6 +104,7 @@ const BeaconViewDialog: React.FC<IProps> = ({
                                     key={beacon.identifier}
                                     map={map}
                                     beacon={beacon}
+                                    tooltip={<BeaconStatusTooltip beacon={beacon} />}
                                 />) }
                                 <ZoomButtons map={map} />
                             </>

src/components/views/location/Marker.tsx

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import React from 'react';
+import React, { ReactNode, useState } from 'react';
 import classNames from 'classnames';
 import { RoomMember } from 'matrix-js-sdk/src/matrix';
 
@@ -28,12 +28,39 @@ interface Props {
     roomMember?: RoomMember;
     // use member text color as background
     useMemberColor?: boolean;
+    tooltip?: ReactNode;
 }
 
+/**
+ * Wrap with tooltip handlers when
+ * tooltip is truthy
+ */
+const OptionalTooltip: React.FC<{
+    tooltip?: ReactNode; children: ReactNode;
+}> = ({ tooltip, children }) => {
+    const [isVisible, setIsVisible] = useState(false);
+    if (!tooltip) {
+        return <>{ children }</>;
+    }
+
+    const show = () => setIsVisible(true);
+    const hide = () => setIsVisible(false);
+    const toggleVisibility = (e: React.MouseEvent<HTMLDivElement, MouseEvent>) => {
+        // stop map from zooming in on click
+        e.stopPropagation();
+        setIsVisible(!isVisible);
+    };
+
+    return <div onMouseEnter={show} onClick={toggleVisibility} onMouseLeave={hide}>
+        { children }
+        { isVisible && tooltip }
+    </div>;
+};
+
 /**
  * Generic location marker
  */
-const Marker = React.forwardRef<HTMLDivElement, Props>(({ id, roomMember, useMemberColor }, ref) => {
+const Marker = React.forwardRef<HTMLDivElement, Props>(({ id, roomMember, useMemberColor, tooltip }, ref) => {
     const memberColorClass = useMemberColor && roomMember ? getUserNameColorClass(roomMember.userId) : '';
     return <div
         ref={ref}
@@ -42,17 +69,21 @@ const Marker = React.forwardRef<HTMLDivElement, Props>(({ id, roomMember, useMem
             "mx_Marker_defaultColor": !memberColorClass,
         })}
     >
-        <div className="mx_Marker_border">
-            { roomMember ?
-                <MemberAvatar
-                    member={roomMember}
-                    width={36}
-                    height={36}
-                    viewUserOnClick={false}
-                />
-                : <LocationIcon className="mx_Marker_icon" />
-            }
-        </div>
+        <OptionalTooltip tooltip={tooltip}>
+            <div className="mx_Marker_border">
+                { roomMember ?
+                    <MemberAvatar
+                        member={roomMember}
+                        width={36}
+                        height={36}
+                        viewUserOnClick={false}
+                        // no mxid on hover when marker has tooltip
+                        hideTitle={!!tooltip}
+                    />
+                    : <LocationIcon className="mx_Marker_icon" />
+                }
+            </div>
+        </OptionalTooltip>
     </div>;
 });
 

src/components/views/location/SmartMarker.tsx

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import React, { useCallback, useEffect, useState } from 'react';
+import React, { ReactNode, useCallback, useEffect, useState } from 'react';
 import maplibregl from 'maplibre-gl';
 import { RoomMember } from 'matrix-js-sdk/src/matrix';
 
@@ -64,12 +64,13 @@ interface SmartMarkerProps {
     roomMember?: RoomMember;
     // use member text color as background
     useMemberColor?: boolean;
+    tooltip?: ReactNode;
 }
 
 /**
  * Generic location marker
  */
-const SmartMarker: React.FC<SmartMarkerProps> = ({ id, map, geoUri, roomMember, useMemberColor }) => {
+const SmartMarker: React.FC<SmartMarkerProps> = ({ id, map, geoUri, roomMember, useMemberColor, tooltip }) => {
     const { onElementRef } = useMapMarker(map, geoUri);
 
     return (
@@ -84,6 +85,7 @@ const SmartMarker: React.FC<SmartMarkerProps> = ({ id, map, geoUri, roomMember,
                 id={id}
                 roomMember={roomMember}
                 useMemberColor={useMemberColor}
+                tooltip={tooltip}
             />
         </span>
     );