Skip to content

An open source design system that's fully customizable and agent ready

TypeScript

fix(ProgressBar): add isDisabled state and neutral variant (#2296)

Andrey Goderc34c18e21a4c
diff --git a/apps/storybook/stories/ProgressBar.stories.tsx b/apps/storybook/stories/ProgressBar.stories.tsx
index 6149cae04d..30d9fa499e 100644
--- a/apps/storybook/stories/ProgressBar.stories.tsx
+++ b/apps/storybook/stories/ProgressBar.stories.tsx
@@ -22,7 +22,7 @@ const meta: Meta<typeof XDSProgressBar> = {
},
variant: {
control: 'select',
- options: ['accent', 'success', 'warning', 'error'],
+ options: ['accent', 'success', 'warning', 'error', 'neutral'],
description: 'Semantic color variant',
},
isLabelHidden: {
@@ -33,6 +33,10 @@ const meta: Meta<typeof XDSProgressBar> = {
control: 'boolean',
description: 'Show formatted value',
},
+ isDisabled: {
+ control: 'boolean',
+ description: 'Disabled state (grayed out)',
+ },
},
};
@@ -81,7 +85,7 @@ export const Variants: Story = {
/>
<XDSProgressBar
value={80}
- label="Positive"
+ label="Success"
variant="success"
hasValueLabel
/>
@@ -91,12 +95,7 @@ export const Variants: Story = {
variant="warning"
hasValueLabel
/>
- <XDSProgressBar
- value={92}
- label="Negative"
- variant="error"
- hasValueLabel
- />
+ <XDSProgressBar value={92} label="Error" variant="error" hasValueLabel />
<XDSProgressBar
value={35}
label="Neutral"
@@ -107,6 +106,26 @@ export const Variants: Story = {
),
};
+export const Disabled: Story = {
+ render: () => (
+ <div
+ style={{
+ display: 'flex',
+ flexDirection: 'column',
+ gap: '16px',
+ width: '300px',
+ }}>
+ <XDSProgressBar
+ value={30}
+ label="Upload canceled"
+ isDisabled
+ hasValueLabel
+ />
+ <XDSProgressBar isIndeterminate label="Processing disabled" isDisabled />
+ </div>
+ ),
+};
+
export const ComposedWithDescription: Story = {
name: 'Composed: with description',
render: () => (
@@ -188,9 +207,9 @@ export const IndeterminateVariants: Story = {
width: '300px',
}}>
<XDSProgressBar isIndeterminate label="Accent" variant="accent" />
- <XDSProgressBar isIndeterminate label="Positive" variant="success" />
+ <XDSProgressBar isIndeterminate label="Success" variant="success" />
<XDSProgressBar isIndeterminate label="Warning" variant="warning" />
- <XDSProgressBar isIndeterminate label="Negative" variant="error" />
+ <XDSProgressBar isIndeterminate label="Error" variant="error" />
<XDSProgressBar isIndeterminate label="Neutral" variant="neutral" />
</div>
),
diff --git a/packages/core/src/ProgressBar/ProgressBar.doc.mjs b/packages/core/src/ProgressBar/ProgressBar.doc.mjs
index 1f41330f96..27ff35e2d9 100644
--- a/packages/core/src/ProgressBar/ProgressBar.doc.mjs
+++ b/packages/core/src/ProgressBar/ProgressBar.doc.mjs
@@ -44,7 +44,7 @@ export const docs = {
},
{
name: 'variant',
- type: "'accent' | 'success' | 'warning' | 'error'",
+ type: "'accent' | 'success' | 'warning' | 'error' | 'neutral'",
description: 'Semantic color variant.',
default: "'accent'",
},
@@ -54,6 +54,12 @@ export const docs = {
description: 'Animated loading indicator for unknown progress.',
default: 'false',
},
+ {
+ name: 'isDisabled',
+ type: 'boolean',
+ description: 'Visually disabled state — grays out the fill and text. Use for canceled or inactive operations.',
+ default: 'false',
+ },
{
name: 'xstyle',
type: 'StyleXStyles',
@@ -123,7 +129,7 @@ export const docsZh = {
},
{
name: 'variant',
- type: "'accent' | 'success' | 'warning' | 'error'",
+ type: "'accent' | 'success' | 'warning' | 'error' | 'neutral'",
description: '语义颜色变体。',
default: "'accent'",
},
@@ -133,6 +139,12 @@ export const docsZh = {
description: '用于未知进度的动画加载指示器。',
default: 'false',
},
+ {
+ name: 'isDisabled',
+ type: 'boolean',
+ description: '视觉禁用状态——使填充条和文本变灰。用于已取消或不活跃的操作。',
+ default: 'false',
+ },
{
name: 'xstyle',
type: 'StyleXStyles',
@@ -185,6 +197,7 @@ export const docsDense = {
formatValueLabel: 'Custom value label formatter; defaults to percentage string.',
variant: 'Semantic color variant.',
isIndeterminate: 'Animated loading indicator for unknown progress.',
+ isDisabled: 'Visually disabled — grays out fill and text.',
xstyle: 'StyleX styles for layout customization. Must be stylex.create() value.',
},
};
diff --git a/packages/core/src/ProgressBar/XDSProgressBar.test.tsx b/packages/core/src/ProgressBar/XDSProgressBar.test.tsx
index e48dace571..9be49a4235 100644
--- a/packages/core/src/ProgressBar/XDSProgressBar.test.tsx
+++ b/packages/core/src/ProgressBar/XDSProgressBar.test.tsx
@@ -21,10 +21,8 @@ describe('XDSProgressBar', () => {
it('hides label visually when isLabelHidden is true', () => {
render(<XDSProgressBar value={50} label="Hidden label" isLabelHidden />);
- // Label should still be in the DOM for a11y
const label = screen.getByText('Hidden label');
expect(label).toBeInTheDocument();
- // The meter should still be labelled
const meter = screen.getByRole('meter');
expect(meter).toHaveAttribute('aria-labelledby');
});
@@ -88,7 +86,13 @@ describe('XDSProgressBar', () => {
});
it('renders with all variant options', () => {
- const variants = ['accent', 'success', 'warning', 'error'] as const;
+ const variants = [
+ 'accent',
+ 'success',
+ 'warning',
+ 'error',
+ 'neutral',
+ ] as const;
for (const variant of variants) {
const {unmount} = render(
<XDSProgressBar value={50} label={variant} variant={variant} />,
@@ -108,7 +112,6 @@ describe('XDSProgressBar', () => {
<XDSProgressBar value={60} label="Hidden" isLabelHidden hasValueLabel />,
);
expect(screen.getByText('60%')).toBeInTheDocument();
- // Label is still in DOM for a11y
expect(screen.getByText('Hidden')).toBeInTheDocument();
});
@@ -119,6 +122,22 @@ describe('XDSProgressBar', () => {
expect(meter).toHaveAttribute('aria-valuemax', '0');
});
+ // Disabled state
+ describe('disabled state', () => {
+ it('renders with isDisabled', () => {
+ render(
+ <XDSProgressBar value={50} label="Canceled" isDisabled hasValueLabel />,
+ );
+ expect(screen.getByRole('meter')).toBeInTheDocument();
+ expect(screen.getByText('50%')).toBeInTheDocument();
+ });
+
+ it('still renders label when disabled', () => {
+ render(<XDSProgressBar value={50} label="Canceled upload" isDisabled />);
+ expect(screen.getByText('Canceled upload')).toBeInTheDocument();
+ });
+ });
+
// Indeterminate mode tests
describe('indeterminate mode', () => {
it('renders with role="progressbar" when isIndeterminate', () => {
@@ -160,7 +179,13 @@ describe('XDSProgressBar', () => {
});
it('renders with all variants in indeterminate mode', () => {
- const variants = ['accent', 'success', 'warning', 'error'] as const;
+ const variants = [
+ 'accent',
+ 'success',
+ 'warning',
+ 'error',
+ 'neutral',
+ ] as const;
for (const variant of variants) {
const {unmount} = render(
<XDSProgressBar isIndeterminate label={variant} variant={variant} />,
diff --git a/packages/core/src/ProgressBar/XDSProgressBar.tsx b/packages/core/src/ProgressBar/XDSProgressBar.tsx
index c5361926a2..239b2bf60a 100644
--- a/packages/core/src/ProgressBar/XDSProgressBar.tsx
+++ b/packages/core/src/ProgressBar/XDSProgressBar.tsx
@@ -105,6 +105,12 @@ export interface XDSProgressBarProps extends XDSBaseProps<HTMLDivElement> {
* @default false
*/
isIndeterminate?: boolean;
+ /**
+ * When true, the progress bar is visually disabled — the fill bar and
+ * text use disabled colors. Use for canceled or inactive operations.
+ * @default false
+ */
+ isDisabled?: boolean;
/**
* Test ID for testing utilities.
*/
@@ -147,12 +153,18 @@ const styles = stylex.create({
fontWeight: fontWeightVars['--font-weight-medium'],
color: colorVars['--color-text-primary'],
},
+ labelDisabled: {
+ color: colorVars['--color-text-disabled'],
+ },
valueLabel: {
fontSize: typeScaleVars['--text-body-size'],
lineHeight: typeScaleVars['--text-body-leading'],
fontWeight: fontWeightVars['--font-weight-normal'],
color: colorVars['--color-text-secondary'],
},
+ valueLabelDisabled: {
+ color: colorVars['--color-text-disabled'],
+ },
visuallyHidden: {
position: 'absolute',
width: '1px',
@@ -208,6 +220,9 @@ const variantStyles = stylex.create({
neutral: {
backgroundColor: colorVars['--color-text-disabled'],
},
+ disabled: {
+ backgroundColor: colorVars['--color-text-disabled'],
+ },
});
function defaultFormatValueLabel(value: number, max: number): string {
@@ -221,19 +236,20 @@ function defaultFormatValueLabel(value: number, max: number): string {
* disk usage, etc). In indeterminate mode, shows an animated loading indicator
* for unknown progress.
*
- * Styles use XDS theme tokens via StyleX.
- * Wrap your app in <Theme> to apply a theme.
- *
* ProgressBar is intentionally minimal — compose additional labels, status
* icons, and descriptions alongside the bar using layout components rather
* than adding props to ProgressBar itself.
*
+ * Styles use XDS theme tokens via StyleX.
+ * Wrap your app in <Theme> to apply a theme.
+ *
* @example
* ```
* <XDSProgressBar value={75} label="Upload progress" />
* <XDSProgressBar isIndeterminate label="Loading..." />
* <XDSProgressBar value={3.2} max={5} label="Disk usage" hasValueLabel
* formatValueLabel={(v, m) => `${v} GB / ${m} GB`} />
+ * <XDSProgressBar value={30} label="Canceled" isDisabled hasValueLabel />
* ```
*/
export function XDSProgressBar({
@@ -245,6 +261,7 @@ export function XDSProgressBar({
formatValueLabel = defaultFormatValueLabel,
variant = 'accent',
isIndeterminate = false,
+ isDisabled = false,
xstyle,
className,
style,
@@ -257,9 +274,10 @@ export function XDSProgressBar({
const percentage = max > 0 ? (clampedValue / max) * 100 : 0;
const valueText = formatValueLabel(clampedValue, max);
- // In indeterminate mode, don't show value label
const showValueLabel = hasValueLabel && !isIndeterminate;
+ const fillVariant = isDisabled ? 'disabled' : variant;
+
return (
<div
ref={ref}
@@ -279,11 +297,18 @@ export function XDSProgressBar({
{...stylex.props(
styles.label,
isLabelHidden && styles.visuallyHidden,
+ isDisabled && styles.labelDisabled,
)}>
{label}
</span>
{showValueLabel && (
- <span {...stylex.props(styles.valueLabel)}>{valueText}</span>
+ <span
+ {...stylex.props(
+ styles.valueLabel,
+ isDisabled && styles.valueLabelDisabled,
+ )}>
+ {valueText}
+ </span>
)}
</div>
) : (
@@ -307,15 +332,18 @@ export function XDSProgressBar({
{isIndeterminate ? (
<div
{...mergeProps(
- xdsClassName('progressbar-fill', {variant}),
- stylex.props(styles.indeterminateFill, variantStyles[variant]),
+ xdsClassName('progressbar-fill', {variant: fillVariant}),
+ stylex.props(
+ styles.indeterminateFill,
+ variantStyles[fillVariant],
+ ),
)}
/>
) : (
<div
{...mergeProps(
- xdsClassName('progressbar-fill', {variant}),
- stylex.props(styles.fill, variantStyles[variant]),
+ xdsClassName('progressbar-fill', {variant: fillVariant}),
+ stylex.props(styles.fill, variantStyles[fillVariant]),
)}
style={{width: `${percentage}%`}}
/>