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

IconBadge Transform

Converts a v6 IconBadge component to a v7 Badge component.

Automatic Changes

  • Renames the import and usages of IconBadge to Badge.
  • Renames the icon prop to anchorElement.
  • Renames the label prop to screenReaderLabel.
  • Updates the type prop to have value of "number". type="outline" and type="outlineFilled" are deprecated and will be converted to type="number".
  • Attempts to transform the deprecated theme prop to the className prop. If it cannot, deletes the theme prop.

For example:

import { IconBadge, IconEmail } from '@americanexpress/dls-react6';

export default function Page() {

return (

<IconBadge

icon={<IconEmail />}

label="Unread messages"

theme={{ color: 'red' }}

{...otherProps}

>

1

</IconBadge>

);

}

Transforms into:

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

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

export default function Page() {

return (

<Badge

anchorElement={<IconEmail />}

screenReaderLabel="Unread messages"

{...otherProps}

>

1

</Badge>

);

}

Questions?

Connect with the DLS Team on Slack or by email.

Resources

Check out additional resources.