Codemods

The American Express Design System provides a unified language for designing American Express websites and experiences. The design system provides design resources that match our coded components and are aligned with the American Express brand. Included are colors, components, icons and glyphs, type styles, and graphic assets to get you up and running quickly.

Back to All Codemods

ProgressCircle Transform

Converts a v6 ProgressCircle component to a v7 ProgressCircular component.

Automatic Changes

  • Attempts to transform the deprecated theme prop to the className prop. If it cannot, deletes the theme prop.
  • Renames the import and usages of ProgressCircle to ProgressCircular.
  • Renames the determinate prop to isDeterminate.
  • Renames the label prop to labelOverrides.screenReaderLabel.
  • Removes the percent prop, which has been deprecated, since the % sign is shown by default.

For example:

import { ProgressCircle } from '@americanexpress/dls-react6';

export default function Page() {

return (

<ProgressCircle

size="sm"

determinate={true}

value={50}

percent={true}

label="label"

aria-describedby="aria-describedby"

theme={{ color: 'red' }}

{...otherProps}

/>

);

}

Transforms into:

import { ProgressCircular } from '@americanexpress/dls-react';

export default function Page() {

return (

<ProgressCircular

size={'sm'}

isDeterminate={true}

value={50}

aria-describedby={'aria-describedby'}

labelOverrides={{

screenReaderLabel: 'label',

}}

{...otherProps}

/>

);

}

Questions?

Connect with the DLS Team on Slack or by email.

Resources

Check out additional resources.