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

ModalHeader Transform

Converts a v6 ModalHeader component to a v7 ModalHeader component.

Automatic Changes

  • Renames the dismissible prop to hideCloseButton and inverts its value.
  • Deletes the onClose prop. Use the onClose on the Modal component instead.
  • Renames the closeButtonLabel prop to labelOverrides.closeButtonScreenReaderLabel.
  • Attempts to transform the deprecated theme prop to the className prop. If it cannot, deletes the theme prop.

For example:

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

export default function Page() {

return (

<ModalHeader

onClose={onClose}

dismissible={dismissible}

closeButtonLabel="Close"

theme={{ color: 'red' }}

{...otherProps}

>

{/** Children */}

</ModalHeader>

);

}

Transforms into:

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

export default function Page() {

return (

<ModalHeader

hideCloseButton={!dismissible}

{...otherProps}

labelOverrides={{

closeButtonScreenReaderLabel: 'Close',

}}

>

{/** Children */}

</ModalHeader>

);

}

Manual Changes

onClose

If you previously supplied the onClose prop, move that to the Modal component.

Questions?

Connect with the DLS Team on Slack or by email.

Resources

Check out additional resources.