Improve avatar settings accessibility (#9985)
Co-authored-by: Germain <germain@souquet.com>pull/28217/head
parent
406edfc27d
commit
5807c64990
|
@ -14,17 +14,17 @@ See the License for the specific language governing permissions and
|
|||
limitations under the License.
|
||||
*/
|
||||
|
||||
import React, { useState } from "react";
|
||||
import React, { useRef, useState } from "react";
|
||||
import classNames from "classnames";
|
||||
|
||||
import { _t } from "../../../languageHandler";
|
||||
import AccessibleButton from "../elements/AccessibleButton";
|
||||
import AccessibleButton, { ButtonEvent } from "../elements/AccessibleButton";
|
||||
|
||||
interface IProps {
|
||||
avatarUrl?: string;
|
||||
avatarName: string; // name of user/room the avatar belongs to
|
||||
uploadAvatar?: (e: React.MouseEvent) => void;
|
||||
removeAvatar?: (e: React.MouseEvent) => void;
|
||||
uploadAvatar?: (e: ButtonEvent) => void;
|
||||
removeAvatar?: (e: ButtonEvent) => void;
|
||||
avatarAltText: string;
|
||||
}
|
||||
|
||||
|
@ -34,12 +34,16 @@ const AvatarSetting: React.FC<IProps> = ({ avatarUrl, avatarAltText, avatarName,
|
|||
onMouseEnter: () => setIsHovering(true),
|
||||
onMouseLeave: () => setIsHovering(false),
|
||||
};
|
||||
// TODO: Use useId() as soon as we're using React 18.
|
||||
// Prevents ID collisions when this component is used more than once on the same page.
|
||||
const a11yId = useRef(`hover-text-${Math.random()}`);
|
||||
|
||||
let avatarElement = (
|
||||
<AccessibleButton
|
||||
element="div"
|
||||
onClick={uploadAvatar}
|
||||
onClick={uploadAvatar ?? null}
|
||||
className="mx_AvatarSetting_avatarPlaceholder"
|
||||
aria-labelledby={a11yId.current}
|
||||
{...hoveringProps}
|
||||
/>
|
||||
);
|
||||
|
@ -50,7 +54,7 @@ const AvatarSetting: React.FC<IProps> = ({ avatarUrl, avatarAltText, avatarName,
|
|||
src={avatarUrl}
|
||||
alt={avatarAltText}
|
||||
aria-label={avatarAltText}
|
||||
onClick={uploadAvatar}
|
||||
onClick={uploadAvatar ?? null}
|
||||
{...hoveringProps}
|
||||
/>
|
||||
);
|
||||
|
@ -60,7 +64,12 @@ const AvatarSetting: React.FC<IProps> = ({ avatarUrl, avatarAltText, avatarName,
|
|||
if (uploadAvatar) {
|
||||
// insert an empty div to be the host for a css mask containing the upload.svg
|
||||
uploadAvatarBtn = (
|
||||
<AccessibleButton onClick={uploadAvatar} className="mx_AvatarSetting_uploadButton" {...hoveringProps} />
|
||||
<AccessibleButton
|
||||
onClick={uploadAvatar}
|
||||
className="mx_AvatarSetting_uploadButton"
|
||||
aria-labelledby={a11yId.current}
|
||||
{...hoveringProps}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
|
@ -80,9 +89,9 @@ const AvatarSetting: React.FC<IProps> = ({ avatarUrl, avatarAltText, avatarName,
|
|||
return (
|
||||
<div className={avatarClasses}>
|
||||
{avatarElement}
|
||||
<div className="mx_AvatarSetting_hover">
|
||||
<div className="mx_AvatarSetting_hover" aria-hidden="true">
|
||||
<div className="mx_AvatarSetting_hoverBg" />
|
||||
<span>{_t("Upload")}</span>
|
||||
<span id={a11yId.current}>{_t("Upload")}</span>
|
||||
</div>
|
||||
{uploadAvatarBtn}
|
||||
{removeAvatarBtn}
|
||||
|
|
|
@ -0,0 +1,55 @@
|
|||
/*
|
||||
Copyright 2023 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 from "react";
|
||||
import { render } from "@testing-library/react";
|
||||
|
||||
import AvatarSetting from "../../../../src/components/views/settings/AvatarSetting";
|
||||
|
||||
describe("<AvatarSetting />", () => {
|
||||
it("renders avatar with specified alt text", async () => {
|
||||
const { queryByAltText } = render(
|
||||
<AvatarSetting
|
||||
avatarName="Peter Fox"
|
||||
avatarAltText="Avatar of Peter Fox"
|
||||
avatarUrl="https://avatar.fictional/my-avatar"
|
||||
/>,
|
||||
);
|
||||
|
||||
const imgElement = queryByAltText("Avatar of Peter Fox");
|
||||
expect(imgElement).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("renders avatar with remove button", async () => {
|
||||
const { queryByText } = render(
|
||||
<AvatarSetting
|
||||
avatarName="Peter Fox"
|
||||
avatarAltText="Avatar of Peter Fox"
|
||||
avatarUrl="https://avatar.fictional/my-avatar"
|
||||
removeAvatar={jest.fn()}
|
||||
/>,
|
||||
);
|
||||
|
||||
const removeButton = queryByText("Remove");
|
||||
expect(removeButton).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("renders avatar without remove button", async () => {
|
||||
const { queryByText } = render(<AvatarSetting avatarName="Peter Fox" avatarAltText="Avatar of Peter Fox" />);
|
||||
|
||||
const removeButton = queryByText("Remove");
|
||||
expect(removeButton).toBeNull();
|
||||
});
|
||||
});
|
Loading…
Reference in New Issue