Fixes read receipt avatar offset (#11483)

* Fixes read receipt avatar offset Fixes element-hq/element-web#26059 * Fix avatar collapsing in thread list Fixes element-hq/element-web#26064 * Make composer pills use new avatar design Fixes element-hq/element-web#26067 * Update snapshots * Update UserInfo snapshot * Update HTMLExport snapshot * Fixes avatar placeholder font Fixes element-hq/element-web#26061
matrix-org · Aug 30, 2023 · 6aa86a8 · 6aa86a8
1 parent 6cc42b7
commit 6aa86a8
Show file tree

Hide file tree

Showing 25 changed files with 132 additions and 20 deletions.
diff --git a/res/css/views/avatars/_BaseAvatar.pcss b/res/css/views/avatars/_BaseAvatar.pcss
@@ -22,3 +22,10 @@ limitations under the License.
         color: white !important;
     }
 }
+
+button.mx_BaseAvatar {
+    /* The user agent stylesheet overrides the font-size in this scenario
+       And that breaks the alignment, emojis, and all sorts of things
+     */
+    font-size: inherit;
+}
diff --git a/res/css/views/rooms/_BasicMessageComposer.pcss b/res/css/views/rooms/_BasicMessageComposer.pcss
@@ -79,7 +79,7 @@ limitations under the License.
                     height: $font-16px;
                     margin-inline-end: 0.24rem;
                     background: var(--avatar-background), $background;
-                    color: $avatar-initial-color;
+                    color: var(--avatar-color, $avatar-initial-color);
                     background-repeat: no-repeat;
                     background-size: $font-16px;
                     border-radius: $font-16px;

diff --git a/res/css/views/rooms/_ReadReceiptGroup.pcss b/res/css/views/rooms/_ReadReceiptGroup.pcss
@@ -49,13 +49,11 @@ limitations under the License.
         height: 100%;
 
         .mx_BaseAvatar {
+            box-sizing: content-box;
             position: absolute;
-            display: inline-block;
-            height: 14px;
-            width: 14px;
             border: 1px solid $background;
-            border-radius: 100%;
-
+            width: 14px;
+            height: 14px;
             will-change: left, top;
             transition: left var(--transition-short) ease-out, top var(--transition-standard) ease-out;
         }

diff --git a/res/css/views/rooms/_ThreadSummary.pcss b/res/css/views/rooms/_ThreadSummary.pcss
@@ -123,6 +123,7 @@ limitations under the License.
 
 .mx_ThreadSummary_avatar {
     margin-inline-end: $spacing-8;
+    flex-shrink: 0;
 }
 
 .mx_ThreadSummary_icon {

diff --git a/res/css/views/rooms/wysiwyg_composer/components/_Editor.pcss b/res/css/views/rooms/wysiwyg_composer/components/_Editor.pcss
@@ -148,8 +148,8 @@ limitations under the License.
                 background-size: $font-16px;
                 border-radius: $font-16px;
 
-                color: $avatar-initial-color;
-                font-weight: normal;
+                color: var(--avatar-color, $avatar-initial-color);
+                font-weight: bold;
                 font-size: $font-10-4px;
             }
         }

diff --git a/src/Avatar.ts b/src/Avatar.ts
@@ -15,12 +15,21 @@ limitations under the License.
 */
 
 import { RoomMember, User, Room, ResizeMethod } from "matrix-js-sdk/src/matrix";
+import { useIdColorHash } from "@vector-im/compound-web";
 
 import DMRoomMap from "./utils/DMRoomMap";
 import { mediaFromMxc } from "./customisations/Media";
 import { isLocalRoom } from "./utils/localRoom/isLocalRoom";
 import { getFirstGrapheme } from "./utils/strings";
 
+/**
+ * Hardcoded from the Compound colors.
+ * Shade for background as defined in the compound web implementation
+ * https://github.com/vector-im/compound-web/blob/main/src/components/Avatar
+ */
+const AVATAR_BG_COLORS = ["#e9f2ff", "#faeefb", "#e3f7ed", "#ffecf0", "#ffefe4", "#e3f5f8", "#f1efff", "#e0f8d9"];
+const AVATAR_TEXT_COLORS = ["#043894", "#671481", "#004933", "#7e0642", "#850000", "#004077", "#4c05b5", "#004b00"];
+
 // Not to be used for BaseAvatar urls as that has similar default avatar fallback already
 export function avatarUrlForMember(
     member: RoomMember | undefined,
@@ -41,6 +50,18 @@ export function avatarUrlForMember(
     return url;
 }
 
+/**
+ * Determines the HEX color to use in the avatar pills
+ * @param id the user or room ID
+ * @returns the text color to use on the avatar
+ */
+export function getAvatarTextColor(id: string): string {
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    const index = useIdColorHash(id);
+
+    return AVATAR_TEXT_COLORS[index - 1];
+}
+
 export function avatarUrlForUser(
     user: Pick<User, "avatarUrl">,
     width: number,
@@ -85,16 +106,12 @@ const colorToDataURLCache = new Map<string, string>();
 
 export function defaultAvatarUrlForString(s: string): string {
     if (!s) return ""; // XXX: should never happen but empirically does by evidence of a rageshake
-    const defaultColors = ["#0DBD8B", "#368bd6", "#ac3ba8"];
-    let total = 0;
-    for (let i = 0; i < s.length; ++i) {
-        total += s.charCodeAt(i);
-    }
-    const colorIndex = total % defaultColors.length;
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    const colorIndex = useIdColorHash(s);
     // overwritten color value in custom themes
     const cssVariable = `--avatar-background-colors_${colorIndex}`;
     const cssValue = getComputedStyle(document.body).getPropertyValue(cssVariable);
-    const color = cssValue || defaultColors[colorIndex];
+    const color = cssValue || AVATAR_BG_COLORS[colorIndex - 1];
     let dataUrl = colorToDataURLCache.get(color);
     if (!dataUrl) {
         // validate color as this can come from account_data

diff --git a/src/components/views/avatars/BaseAvatar.tsx b/src/components/views/avatars/BaseAvatar.tsx
@@ -99,7 +99,7 @@ const BaseAvatar: React.FC<IProps> = (props) => {
     const {
         name,
         idName,
-        title,
+        title = "",
         url,
         urls,
         size = "40px",

diff --git a/src/components/views/rooms/wysiwyg_composer/utils/autocomplete.ts b/src/components/views/rooms/wysiwyg_composer/utils/autocomplete.ts
@@ -84,6 +84,25 @@ export function getMentionDisplayText(completion: ICompletion, client: MatrixCli
     return "";
 }
 
+function getCSSProperties({
+    url,
+    initialLetter,
+    id = "",
+}: {
+    url: string;
+    initialLetter?: string;
+    id: string;
+}): string {
+    const cssProperties = [`--avatar-background: url(${url})`, `--avatar-letter: '${initialLetter}'`];
+
+    const textColor = Avatar.getAvatarTextColor(id);
+    if (textColor) {
+        cssProperties.push(textColor);
+    }
+
+    return cssProperties.join("; ");
+}
+
 /**
  * For a given completion, the attributes will change depending on the completion type
  *
@@ -118,7 +137,14 @@ export function getMentionAttributes(
         }
 
         attributes.set("data-mention-type", completion.type);
-        attributes.set("style", `--avatar-background: url(${avatarUrl}); --avatar-letter: '${initialLetter}'`);
+        attributes.set(
+            "style",
+            getCSSProperties({
+                url: avatarUrl,
+                initialLetter,
+                id: mentionedMember.userId,
+            }),
+        );
     } else if (completion.type === "room") {
         // logic as used in RoomPillPart.setAvatar in parts.ts
         const mentionedRoom = getRoomFromCompletion(completion, client);
@@ -132,7 +158,14 @@ export function getMentionAttributes(
         }
 
         attributes.set("data-mention-type", completion.type);
-        attributes.set("style", `--avatar-background: url(${avatarUrl}); --avatar-letter: '${initialLetter}'`);
+        attributes.set(
+            "style",
+            getCSSProperties({
+                url: avatarUrl,
+                initialLetter,
+                id: mentionedRoom?.roomId ?? aliasFromCompletion,
+            }),
+        );
     } else if (completion.type === "at-room") {
         // logic as used in RoomPillPart.setAvatar in parts.ts, but now we know the current room
         // from the arguments passed
@@ -145,7 +178,14 @@ export function getMentionAttributes(
         }
 
         attributes.set("data-mention-type", completion.type);
-        attributes.set("style", `--avatar-background: url(${avatarUrl}); --avatar-letter: '${initialLetter}'`);
+        attributes.set(
+            "style",
+            getCSSProperties({
+                url: avatarUrl,
+                initialLetter,
+                id: room.roomId,
+            }),
+        );
     }
 
     return attributes;

diff --git a/test/components/structures/__snapshots__/RoomView-test.tsx.snap b/test/components/structures/__snapshots__/RoomView-test.tsx.snap
@@ -24,6 +24,7 @@ exports[`RoomView for a local room in state CREATING should match the snapshot 1
               data-type="round"
               role="presentation"
               style="--cpd-avatar-size: 24px;"
+              title=""
             >
               u
             </span>
@@ -106,6 +107,7 @@ exports[`RoomView for a local room in state ERROR should match the snapshot 1`]
               data-type="round"
               role="presentation"
               style="--cpd-avatar-size: 24px;"
+              title=""
             >
               u
             </span>
@@ -185,6 +187,7 @@ exports[`RoomView for a local room in state ERROR should match the snapshot 1`]
                   data-type="round"
                   role="button"
                   style="--cpd-avatar-size: 52px;"
+                  title=""
                 >
                   u
                 </button>
@@ -273,6 +276,7 @@ exports[`RoomView for a local room in state NEW should match the snapshot 1`] =
               data-type="round"
               role="presentation"
               style="--cpd-avatar-size: 24px;"
+              title=""
             >
               u
             </span>
@@ -352,6 +356,7 @@ exports[`RoomView for a local room in state NEW should match the snapshot 1`] =
                   data-type="round"
                   role="button"
                   style="--cpd-avatar-size: 52px;"
+                  title=""
                 >
                   u
                 </button>
@@ -515,6 +520,7 @@ exports[`RoomView for a local room in state NEW that is encrypted should match t
               data-type="round"
               role="presentation"
               style="--cpd-avatar-size: 24px;"
+              title=""
             >
               u
             </span>
@@ -593,6 +599,7 @@ exports[`RoomView for a local room in state NEW that is encrypted should match t
                   data-type="round"
                   role="button"
                   style="--cpd-avatar-size: 52px;"
+                  title=""
                 >
                   u
                 </button>

diff --git a/test/components/structures/__snapshots__/SpaceHierarchy-test.tsx.snap b/test/components/structures/__snapshots__/SpaceHierarchy-test.tsx.snap
@@ -77,6 +77,7 @@ exports[`SpaceHierarchy <SpaceHierarchy /> renders 1`] = `
               data-type="round"
               role="presentation"
               style="--cpd-avatar-size: 20px;"
+              title=""
             >
               U
             </span>
@@ -147,6 +148,7 @@ exports[`SpaceHierarchy <SpaceHierarchy /> renders 1`] = `
               data-type="round"
               role="presentation"
               style="--cpd-avatar-size: 20px;"
+              title=""
             >
               U
             </span>
@@ -218,6 +220,7 @@ exports[`SpaceHierarchy <SpaceHierarchy /> renders 1`] = `
               data-type="round"
               role="presentation"
               style="--cpd-avatar-size: 20px;"
+              title=""
             >
               N
             </span>
@@ -295,6 +298,7 @@ exports[`SpaceHierarchy <SpaceHierarchy /> renders 1`] = `
               data-type="round"
               role="presentation"
               style="--cpd-avatar-size: 20px;"
+              title=""
             >
               N
             </span>

diff --git a/test/components/structures/__snapshots__/UserMenu-test.tsx.snap b/test/components/structures/__snapshots__/UserMenu-test.tsx.snap
@@ -24,6 +24,7 @@ exports[`<UserMenu> when rendered should render as expected 1`] = `
           data-type="round"
           role="presentation"
           style="--cpd-avatar-size: 32px;"
+          title=""
         >
           u
         </span>

diff --git a/test/components/views/avatars/__snapshots__/RoomAvatar-test.tsx.snap b/test/components/views/avatars/__snapshots__/RoomAvatar-test.tsx.snap
@@ -9,6 +9,7 @@ exports[`RoomAvatar should render as expected for a DM room 1`] = `
     data-type="round"
     role="presentation"
     style="--cpd-avatar-size: 36px;"
+    title=""
   >
     D
   </span>
@@ -24,6 +25,7 @@ exports[`RoomAvatar should render as expected for a LocalRoom 1`] = `
     data-type="round"
     role="presentation"
     style="--cpd-avatar-size: 36px;"
+    title=""
   >
     l
   </span>
@@ -39,6 +41,7 @@ exports[`RoomAvatar should render as expected for a Room 1`] = `
     data-type="round"
     role="presentation"
     style="--cpd-avatar-size: 36px;"
+    title=""
   >
     t
   </span>

diff --git a/test/components/views/beacon/__snapshots__/DialogSidebar-test.tsx.snap b/test/components/views/beacon/__snapshots__/DialogSidebar-test.tsx.snap
@@ -38,6 +38,7 @@ exports[`<DialogSidebar /> renders sidebar correctly with beacons 1`] = `
           data-type="round"
           role="presentation"
           style="--cpd-avatar-size: 32px;"
+          title=""
         >
           
         </span>

diff --git a/test/components/views/dialogs/__snapshots__/ManageRestrictedJoinRuleDialog-test.tsx.snap b/test/components/views/dialogs/__snapshots__/ManageRestrictedJoinRuleDialog-test.tsx.snap
@@ -77,6 +77,7 @@ exports[`<ManageRestrictedJoinRuleDialog /> should list spaces which are not par
                 data-type="round"
                 role="presentation"
                 style="--cpd-avatar-size: 20px;"
+                title=""
               >
                 O
               </span>

diff --git a/test/components/views/elements/__snapshots__/AppTile-test.tsx.snap b/test/components/views/elements/__snapshots__/AppTile-test.tsx.snap
@@ -109,6 +109,7 @@ exports[`AppTile for a pinned widget should render 1`] = `
             data-testid="avatar-img"
             data-type="round"
             style="--cpd-avatar-size: 20px;"
+            title=""
           >
             <img
               alt=""
@@ -197,6 +198,7 @@ exports[`AppTile for a pinned widget should render permission request 1`] = `
             data-testid="avatar-img"
             data-type="round"
             style="--cpd-avatar-size: 20px;"
+            title=""
           >
             <img
               alt=""
@@ -277,6 +279,7 @@ exports[`AppTile for a pinned widget should render permission request 1`] = `
               data-type="round"
               role="presentation"
               style="--cpd-avatar-size: 38px;"
+              title=""
             >
               u
             </span>
@@ -352,6 +355,7 @@ exports[`AppTile preserves non-persisted widget on container move 1`] = `
                   data-testid="avatar-img"
                   data-type="round"
                   style="--cpd-avatar-size: 20px;"
+                  title=""
                 >
                   <img
                     alt=""

diff --git a/test/components/views/elements/__snapshots__/FacePile-test.tsx.snap b/test/components/views/elements/__snapshots__/FacePile-test.tsx.snap
@@ -17,6 +17,7 @@ exports[`<FacePile /> renders with a tooltip 1`] = `
         data-type="round"
         role="presentation"
         style="--cpd-avatar-size: 36px;"
+        title=""
       >
         4
       </span>
-Original file line number
+Diff line change
@@ Expand Up / @@ -99,7 +99,7 @@ const BaseAvatar: React.FC<IProps> = (props) => { @@
         const {
             name,
             idName,
-            title,
+            title = "",
             url,
             urls,
             size = "40px",
@@ Expand Down @@