This repository has been archived by the owner on Sep 11, 2024. It is now read-only.
Migrate Avatar to new Compound component #11393
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -20,33 +20,36 @@ limitations under the License. | |
| import React, { useCallback, useContext, useEffect, useState } from "react"; | ||
| import classNames from "classnames"; | ||
| import { ResizeMethod, ClientEvent } from "matrix-js-sdk/src/matrix"; | ||
| import { Avatar } from "@vector-im/compound-web"; | ||
|
|
||
| import SettingsStore from "../../../settings/SettingsStore"; | ||
| import { ButtonEvent } from "../elements/AccessibleButton"; | ||
| import RoomContext from "../../../contexts/RoomContext"; | ||
| import MatrixClientContext from "../../../contexts/MatrixClientContext"; | ||
| import { useTypedEventEmitter } from "../../../hooks/useEventEmitter"; | ||
| import { _t } from "../../../languageHandler"; | ||
|
|
||
| interface IProps { | ||
| name?: React.ComponentProps<typeof Avatar>["name"]; // The name (first initial used as default) | ||
| idName?: React.ComponentProps<typeof Avatar>["id"]; // ID for generating hash colours | ||
| title?: string; // onHover title text | ||
| url?: string | null; // highest priority of them all, shortcut to set in urls[0] | ||
| urls?: string[]; // [highest_priority, ... , lowest_priority] | ||
| type?: React.ComponentProps<typeof Avatar>["type"]; | ||
| width: number; | ||
| /** | ||
| * @deprecated use `width` only, avatars have a 1:1 aspect ratio | ||
| */ | ||
| height: number; | ||
| /** | ||
| * @deprecated only uses `crop` | ||
| */ | ||
| resizeMethod?: ResizeMethod; | ||
| onClick?: (ev: ButtonEvent) => void; | ||
| inputRef?: React.RefObject<HTMLSpanElement>; | ||
| className?: string; | ||
| tabIndex?: number; | ||
| altText?: string; | ||
| } | ||
|
|
||
| const calculateUrls = (url?: string | null, urls?: string[], lowBandwidth = false): string[] => { | ||
|
|
@@ -108,119 +111,32 @@ const BaseAvatar: React.FC<IProps> = (props) => { | |
| url, | ||
| urls, | ||
| width = 40, | ||
| resizeMethod = "crop", // eslint-disable-line @typescript-eslint/no-unused-vars | ||
| onClick, | ||
| inputRef, | ||
| className, | ||
| type = "round", | ||
| altText = _t("Avatar"), | ||
|
There was a problem hiding this comment. Losing this seems bad, this is the aria-label for the button which wraps clickable avatars |
||
| ...otherProps | ||
| } = props; | ||
|
|
||
| const [imageUrl, onError] = useImageUrl({ url, urls }); | ||
|
|
||
|
There was a problem hiding this comment. Added to element-hq/compound-web#57 There was a problem hiding this comment. Added to element-hq/compound-web#57 |
||
|
Comment on lines
-151
to
-152
|
||
|
Comment on lines
-159
to
-160
|
||
|
|
||
| return ( | ||
|
There was a problem hiding this comment. Thanks, not sure why ESLint was not shouting at me, back in use now. There was a problem hiding this comment. The rule is disabled on this block There was a problem hiding this comment. Unfortunately https://github.com/matrix-org/matrix-react-sdk/pull/11393/files#diff-f61169b723cd2eea456ca1c6fa8879aaf150f49060d77d4d8bf42257093e078fR114 applies to the whole block not just that one line |
||
| <Avatar | ||
| ref={inputRef} | ||
| src={imageUrl} | ||
| id={idName ?? ""} | ||
| name={name ?? ""} | ||
| type={type} | ||
| size={`${width}px`} | ||
| className={classNames("mx_BaseAvatar", className)} | ||
| aria-label={altText} | ||
| onError={onError} | ||
| title={title} | ||
| {...otherProps} | ||
| /> | ||
| ); | ||
| }; | ||
|
|
||
| export default BaseAvatar; | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -104,7 +104,6 @@ export default function MemberAvatar({ | |
| : props.onClick | ||
| } | ||
| altText={_t("Profile picture")} | ||
| /> | ||
| ); | ||
| } | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we just kill it? We're not a real SDK so don't need backwards compatibility, confusion is worse than bigger diffs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done! I will rename
widthtosizein a follow up PR