Codemods

CarouselItem Transform

Converts a v6 CarouselItem component to a v7 CarouselItem component.

Automatic Changes

• Removes the overlayColor prop, which has been deprecated.
• Removes the backgroundImageUrl prop, which has been deprecated.
• Attempts to transform the deprecated theme prop to the className prop. If it cannot, deletes the theme prop.

For example:

1import { CarouselItem } from '@americanexpress/dls-react6';
2
3export default function Page() {
4  return (
5    <CarouselItem
6      overlayColor={overlayColor}
7      backgroundImageUrl={backgroundImageUrl}
8      theme={{ color: 'red' }}
9      {...otherProps}
10    >
11      Some Content
12    </CarouselItem>
13  );
14}

Transforms into:

1import { CarouselItem } from '@americanexpress/dls-react';
2
3export default function Page() {
4  return <CarouselItem {...otherProps}>Some Content</CarouselItem>;
5}

Manual Changes

Update Carousel Styles

Since the overlayColor and backgroundImageUrl props are deprecated, the styles applied to the CarouselItem and its children will most likely need to be updated. Reference the Carousel documentation for common layout patterns.