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.

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

feat(ProgressBar): adds flat prop to progressBar #2844

Merged
merged 8 commits into from
Mar 15, 2024
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
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
4 changes: 2 additions & 2 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"editor.wordWrap": "wordWrapColumn",
"editor.wordWrapColumn": 120,
"editor.codeActionsOnSave": {
"source.fixAll": true
"source.fixAll": "explicit"
}
},
"mdx.experimentalLanguageServer": true,
Expand All @@ -37,7 +37,7 @@
},
"typescript.tsdk": "node_modules/typescript/lib",
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true
"source.fixAll.eslint": "explicit"
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this an intended change? Also is this because imports haven't been automatically sorting when you save a file on vscode? Because same lol

Copy link
Contributor Author

Choose a reason for hiding this comment

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

oh no, for some reason this keeps getting updated. i reverted as i didnt mean to push!

},
"storyExplorer.storiesGlobs": "packages/styleguide/stories/**/*.stories.mdx",
"jest.jestCommandLine": "node_modules/.bin/jest"
Expand Down
60 changes: 47 additions & 13 deletions packages/gamut/src/ProgressBar/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,16 @@ import { theme, variant } from '@codecademy/gamut-styles';
import styled from '@emotion/styled';
import * as React from 'react';

import { Box } from '../Box';
import { Text } from '../Typography';

const borderRadius = {
small: '3px',
medium: '80px',
large: '9px',
xl: '18px',
};

export type ProgressBarProps = {
className?: string;

Expand All @@ -28,12 +36,33 @@ export type ProgressBarProps = {
*/
variant: 'blue' | 'yellow' | 'default';

/**
* Whether to flatten the bottom or top of the progress bar.
*/
flat?: 'flat-bottom' | 'flat-top';

/**
* Pattern component to use as a background.
*/
pattern?: React.ComponentType<PatternProps>;
};

const progressBarFlatVariants = variant({
defaultVariant: 'default',
prop: 'flat',
variants: {
'flat-bottom': {
borderBottomRightRadius: 0,
borderBottomLeftRadius: 0,
},
'flat-top': {
borderTopRightRadius: 0,
borderTopLeftRadius: 0,
},
default: {},
},
});

const progressBarSizeVariants = variant({
defaultVariant: 'small',
prop: 'size',
Expand All @@ -45,20 +74,20 @@ const progressBarSizeVariants = variant({
variants: {
small: {
height: '6px',
borderRadius: '3px',
borderRadius: borderRadius.small,
},
medium: {
height: '8px',
borderRadius: '80px',
borderRadius: borderRadius.medium,
},
large: {
height: '18px',
borderRadius: '9px',
borderRadius: borderRadius.large,
fontSize: 14,
},
xl: {
height: '36px',
borderRadius: '18px',
borderRadius: borderRadius.xl,
},
},
});
Expand Down Expand Up @@ -101,7 +130,6 @@ const progressBarForegroundVariants = variant({
display: 'flex',
transition: 'width 0.5s',
position: 'relative',
borderRadius: 'inherit',
},
variants: {
blue: {
Expand All @@ -119,7 +147,10 @@ const progressBarForegroundVariants = variant({
},
});

type ProgressBarElementProps = Pick<ProgressBarProps, 'variant' | 'size'>;
type ProgressBarElementProps = Pick<
ProgressBarProps,
'variant' | 'size' | 'flat'
>;

type ProgressBarElementWrapperProps = ProgressBarElementProps & {
backgroundOverride: 'pattern' | 'none';
Expand All @@ -129,9 +160,10 @@ const ProgressBarWrapper = styled.div<ProgressBarElementWrapperProps>`
${progressBarBackgroundVariants};
${progressBarSizeVariants};
${progressBarBackgroundOverride};
${progressBarFlatVariants}
`;

const Bar = styled.div(progressBarForegroundVariants);
const Bar = styled(Box)(progressBarForegroundVariants);

const DisplayedPercent = styled.span`
font-weight: bold;
Expand All @@ -141,6 +173,7 @@ const DisplayedPercent = styled.span`
`;

export const ProgressBar: React.FC<ProgressBarProps> = ({
flat,
minimumPercent = 0,
percent,
pattern: Pattern,
Expand All @@ -151,6 +184,7 @@ export const ProgressBar: React.FC<ProgressBarProps> = ({
return (
<ProgressBarWrapper
aria-live="polite"
flat={flat}
size={size}
variant={variant}
backgroundOverride={Pattern ? 'pattern' : 'none'}
Expand All @@ -159,13 +193,13 @@ export const ProgressBar: React.FC<ProgressBarProps> = ({
{Pattern && <Pattern width="100%" position="absolute" zIndex={0} />}
<Bar
variant={variant}
boxShadow={
showBarBorder ? `0.5px 0 0 0.5px ${theme.colors.navy}` : 'none'
}
borderRadiusTopRight={flat ? 0 : 'inherit'}
borderRadiusBottomRight={flat ? 0 : 'inherit'}
width={`${Math.max(minimumPercent, percent)}%`}
data-testid="progress-bar-bar"
style={{
width: `${Math.max(minimumPercent, percent)}%`,
boxShadow: showBarBorder
? `0.5px 0 0 0.5px ${theme.colors.navy}`
: 'none',
}}
>
{['large', 'xl'].includes(size) && (
<DisplayedPercent aria-hidden>{percent}%</DisplayedPercent>
Expand Down
38 changes: 38 additions & 0 deletions packages/styleguide/stories/Atoms/ProgressBar/index.stories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -144,3 +144,41 @@ Here we are using the `DiagonalARegular` pattern in navy in the large ProgressBa
{(args) => <ProgressBar {...args} />}
</Story>
</Canvas>

## Flat

Use the prop flat and set it to either "flat-top" or "flat-bottom". This allows the ProgressBar to be on top or bottom of a Card.

### Flat-top

<Canvas>
<Story
name="Flat - flat-top"
args={{
size: 'xl',
pattern: DiagonalADense,
percent: 33,
variant: 'yellow',
flat: 'flat-top'
}}
>
{(args) => <ProgressBar {...args} />}
</Story>
</Canvas>

### Flat-bottom

<Canvas>
<Story
name="Flat - flat-bottom"
args={{
size: 'xl',
pattern: DiagonalADense,
percent: 33,
variant: 'yellow',
flat: 'flat-bottom'
}}
>
{(args) => <ProgressBar {...args} />}
</Story>
</Canvas>
Loading