Skip to content
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

Jump to bottom

feat(RadialProgress): updated with option to render outline around progress indicator #2761

Merged
merged 11 commits into from
Aug 7, 2023
Merged

feat(RadialProgress): updated with option to render outline around progress indicator #2761

Changes from 10 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
2a00831
updated RadialProgress with option to render outline around progress …
vinnie-olsen Jul 28, 2023
3a7d4d0
Merge branch 'main' into vo_en-2344_radial-progress-outline
vinnie-olsen Jul 28, 2023
2b500d3
Merge branch 'main' into vo_en-2344_radial-progress-outline
dreamwasp Aug 1, 2023
0a5a81f
Modified RadialProgress to optionally adjust for excess stroke width
vinnie-olsen Aug 1, 2023
e1a6ec2
Merge branch 'main' into vo_en-2344_radial-progress-outline
vinnie-olsen Aug 2, 2023
156a26d
Merge branch 'main' into vo_en-2344_radial-progress-outline
vinnie-olsen Aug 3, 2023
d374799
Merge branch 'main' into vo_en-2344_radial-progress-outline
dreamwasp Aug 3, 2023
a7e2fd9
Added 'baseColor' prop/logic to 'RadialProgress' component
vinnie-olsen Aug 3, 2023
65175ce
Refactored RadialProgress progressOutline props
vinnie-olsen Aug 7, 2023
12e3521
Merge branch 'main' of github.com:Codecademy/gamut into vo_en-2344_ra…
vinnie-olsen Aug 7, 2023
59a2a78
Changed progressOutlineColor prop default to 'background-current' for…
vinnie-olsen Aug 7, 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
78 changes: 73 additions & 5 deletions packages/gamut/src/RadialProgress/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { theme } from '@codecademy/gamut-styles';
import cx from 'classnames';
import { SVGProps } from 'react';
import * as React from 'react';
Expand All @@ -12,6 +13,9 @@ export interface RadialProgressProps extends SVGProps<SVGSVGElement> {
value: number | number[];
strokeWidth?: number | string;
strokeLinecap?: 'round' | 'butt' | 'square';
progressOutlineSize?: number;
progressOutlineColor?: string;
baseColor?: string;
}

const offsetForEmptyProgress = 290;
Expand All @@ -34,10 +38,45 @@ export const RadialProgress: React.FC<RadialProgressProps> = ({
value,
strokeLinecap = 'round',
strokeWidth = 10,
progressOutlineSize,
progressOutlineColor = theme.colors.black,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just b/c our previous conversation was resolved. i think this could be theme.colors['background-current'] so that it automatically matches the background 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gotcha I'll change it over to theme.colors['background-current'] then - thanks!

baseColor,
...props
}) => {
let startingValue;
let finalValue;
const MAX_VIEWABLE_STROKE_WIDTH = 10;
const strokeWidthParsed =
typeof strokeWidth === 'number' ? strokeWidth : parseFloat(strokeWidth);
let strokeWidthForOutline = 0;
const circleRadius = 45;
const viewBox = {
minX: 0,
minY: 0,
width: 100,
height: 100,
};

if (progressOutlineSize && !Number.isNaN(strokeWidthParsed)) {
strokeWidthForOutline = strokeWidthParsed + progressOutlineSize;
}

if (
!Number.isNaN(strokeWidthParsed) &&
(strokeWidthParsed > MAX_VIEWABLE_STROKE_WIDTH ||
strokeWidthForOutline > MAX_VIEWABLE_STROKE_WIDTH)
) {
const largestStrokeWidth =
strokeWidthForOutline > strokeWidthParsed
? strokeWidthForOutline
: strokeWidthParsed;
const excessStrokeWidth = largestStrokeWidth - MAX_VIEWABLE_STROKE_WIDTH;
const halfOfExcessStrokeWidth = excessStrokeWidth / 2;
viewBox.minX -= halfOfExcessStrokeWidth;
viewBox.minY -= halfOfExcessStrokeWidth;
viewBox.width += excessStrokeWidth;
viewBox.height += excessStrokeWidth;
}

if (Array.isArray(value)) {
startingValue = convertPercentToOffset(value[0]);
Expand All @@ -47,26 +86,55 @@ export const RadialProgress: React.FC<RadialProgressProps> = ({
}
const labelPercent = Array.isArray(value) ? value[1] : value;

const svgViewBoxStr = `${viewBox.minX} ${viewBox.minY} ${viewBox.width} ${viewBox.height}`;

return (
<figure
className={cx(styles.radialProgress, className)}
style={{ height: size, width: size }}
>
<Text as="figcaption" screenreader>{`${labelPercent}% progress`}</Text>
<svg viewBox="0 0 100 100" height={size} width={size} {...props}>
<svg viewBox={svgViewBoxStr} height={size} width={size} {...props}>
<circle
cx="50"
cy="50"
r="45"
stroke="currentColor"
r={`${circleRadius}`}
stroke={baseColor || 'currentColor'}
strokeWidth={strokeWidth}
fill="none"
opacity=".2"
opacity={baseColor ? '1' : '.2'}
/>
{progressOutlineSize && strokeWidthForOutline && (
<circle
cx="50"
cy="50"
r={`${circleRadius}`}
stroke={progressOutlineColor}
strokeWidth={strokeWidthForOutline}
strokeLinecap={strokeLinecap}
fill="none"
opacity="1"
strokeDashoffset={finalValue}
strokeDasharray={offsetForEmptyProgress}
transform="rotate(-90 50 50)"
>
{startingValue !== finalValue && (
<animate
attributeType="CSS"
attributeName="stroke-dashoffset"
from={startingValue}
to={finalValue}
dur={`${duration}ms`}
begin="0"
fill="freeze"
/>
)}
</circle>
)}
<circle
cx="50"
cy="50"
r="45"
r={`${circleRadius}`}
stroke="currentColor"
strokeWidth={strokeWidth}
strokeLinecap={strokeLinecap}
Expand Down
Loading