Skip to content

Pr05 Typescript Migration #19: client/common/icons #3703

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

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Pr05 Typescript Migration #19: client/common/icons #3703

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f175c03
client/common/icons: update to ts, no-verify
clairep94 Oct 26, 2025
69018f0
client/common/icons: add types & update snapshot test
clairep94 Oct 26, 2025
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: 26 additions & 14 deletions client/common/icons.jsx → client/common/icons.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,25 @@ import Filter from '../images/filter.svg';
import Cross from '../images/cross.svg';
import Copy from '../images/copy.svg';

export interface IconColors {
default?: string;
hover?: string;
}

export interface IconProps extends React.SVGProps<SVGSVGElement> {
'aria-label'?: string;
Icon?: IconColors;
}

// HOC that adds the right web accessibility props
// https://www.scottohara.me/blog/2019/05/22/contextual-images-svgs-and-a11y.html

// could also give these a default size, color, etc. based on the theme
// Need to add size to these - like small icon, medium icon, large icon. etc.
function withLabel(SvgComponent) {
const StyledIcon = styled(SvgComponent)`
function withLabel(
SvgComponent: React.ComponentType<React.SVGProps<SVGSVGElement>>
) {
const StyledIcon = styled(SvgComponent)<IconProps>`
&&& {
color: ${(props) => props.Icon?.default};
& g,
Expand All @@ -53,27 +65,27 @@ function withLabel(SvgComponent) {
}
`;

const Icon = (props) => {
const { 'aria-label': ariaLabel } = props;
// Necessary because styled components inject a different type for the ref prop
type StyledIconProps = Omit<
React.ComponentProps<typeof StyledIcon>,
'ref'
> & {
ref?: React.Ref<SVGSVGElement>;
};

const Icon = (props: StyledIconProps) => {
const { 'aria-label': ariaLabel, ...rest } = props;
if (ariaLabel) {
return (
<StyledIcon
{...props}
{...rest}
aria-label={ariaLabel}
role="img"
focusable="false"
/>
);
}
return <StyledIcon {...props} aria-hidden focusable="false" />;
};

Icon.propTypes = {
'aria-label': PropTypes.string
};

Icon.defaultProps = {
'aria-label': null
return <StyledIcon {...rest} aria-hidden focusable="false" />;
};

return Icon;
Expand Down
8 changes: 4 additions & 4 deletions client/modules/IDE/components/Header/__snapshots__/Nav.unit.test.jsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ exports[`Nav renders dashboard version for mobile 1`] = `
>
<test-file-stub
aria-hidden="true"
classname="icons__StyledIcon-sc-xmer15-0 kjSZIe"
classname="icons__StyledIcon-sc-1rmv3zl-0 bKwKVB"
focusable="false"
/>
</button>
Expand All @@ -367,7 +367,7 @@ exports[`Nav renders dashboard version for mobile 1`] = `
>
<test-file-stub
aria-hidden="true"
classname="icons__StyledIcon-sc-xmer15-0 kjSZIe"
classname="icons__StyledIcon-sc-1rmv3zl-0 bKwKVB"
focusable="false"
/>
</button>
Expand Down Expand Up @@ -971,7 +971,7 @@ exports[`Nav renders editor version for mobile 1`] = `
>
<test-file-stub
aria-hidden="true"
classname="icons__StyledIcon-sc-xmer15-0 kjSZIe"
classname="icons__StyledIcon-sc-1rmv3zl-0 bKwKVB"
focusable="false"
/>
</button>
Expand All @@ -987,7 +987,7 @@ exports[`Nav renders editor version for mobile 1`] = `
>
<test-file-stub
aria-hidden="true"
classname="icons__StyledIcon-sc-xmer15-0 kjSZIe"
classname="icons__StyledIcon-sc-1rmv3zl-0 bKwKVB"
focusable="false"
/>
</button>
Expand Down
Loading