Skip to content

fix: prevent alt text from appearing if OIDC icon fail to load #10792

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 20, 2023
Merged

fix: prevent alt text from appearing if OIDC icon fail to load #10792

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
49e58f8
fix: update alt text issue
Parkreiner Nov 20, 2023
50113f2
fix: add visually hidden CSS
Parkreiner Nov 20, 2023
8b91898
fix: remove useless import
Parkreiner Nov 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 29 additions & 11 deletions site/src/pages/LoginPage/OAuthSignInForm.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,27 @@ import Button from "@mui/material/Button";
import GitHubIcon from "@mui/icons-material/GitHub";
import KeyIcon from "@mui/icons-material/VpnKey";
import Box from "@mui/material/Box";
import { type FC } from "react";
import { useId, type FC } from "react";
import { Language } from "./SignInForm";
import { type AuthMethods } from "api/typesGenerated";
import { visuallyHidden } from "@mui/utils";

type OAuthSignInFormProps = {
isSigningIn: boolean;
redirectTo: string;
authMethods?: AuthMethods;
};

const iconStyles = {
width: 16,
height: 16,
};

export const OAuthSignInForm: FC<OAuthSignInFormProps> = ({
isSigningIn,
redirectTo,
authMethods,
}) => {
const iconStyles = {
width: 16,
height: 16,
};

return (
<Box display="grid" gap="16px">
{authMethods?.github.enabled && (
Expand Down Expand Up @@ -51,11 +52,7 @@ export const OAuthSignInForm: FC<OAuthSignInFormProps> = ({
size="xlarge"
startIcon={
authMethods.oidc.iconUrl ? (
<img
alt="Open ID Connect icon"
src={authMethods.oidc.iconUrl}
css={iconStyles}
/>
<OidcIcon iconUrl={authMethods.oidc.iconUrl} />
) : (
<KeyIcon css={iconStyles} />
)
Expand All @@ -70,3 +67,24 @@ export const OAuthSignInForm: FC<OAuthSignInFormProps> = ({
</Box>
);
};

type OidcIconProps = {
iconUrl: string;
};

function OidcIcon({ iconUrl }: OidcIconProps) {
const hookId = useId();
const oidcId = `${hookId}-oidc`;

// Even if the URL is defined, there is a chance that the request for the
// image fails. Have to use blank alt text to avoid button from getting ugly
// if that happens, but also still need a way to inject accessible text
return (
<>
<img alt="" src={iconUrl} css={iconStyles} aria-labelledby={oidcId} />
<div id={oidcId} css={{ ...visuallyHidden }}>
Open ID Connect
</div>
</>
);
}