Codemods

FilterPersistent Transform

Converts a v6 FilterPersistent component to a v7 FilterPersistent component.

Automatic Changes

• Attempts to transform the deprecated theme prop to the className prop. If it cannot, deletes the theme prop.
• Renames the filtersLabel prop to labelOverrides.menuHeadingLabel.
• Renames the resetButtonLabel prop to labelOverrides.resetButtonLabel.
• Renames the applyButtonLabel prop to labelOverrides.applyButtonLabel.
• Deletes the showCloseButton prop, since close button is never shown.
• Deletes the closeButtonLabel prop, since close button is never shown.
• Deletes the closeButtonProps prop, since close button is never shown.
• Deletes the onCloseClick prop, since close button is never shown.

For example:

1import { FilterPersistent } from '@americanexpress/dls-react6';
2
3export default function Page() {
4  return (
5    <FilterPersistent
6      filtersLabel="Filters"
7      resetButtonLabel="Reset"
8      applyButtonLabel="Apply"
9      showCloseButton={true}
10      closeButtonLabel="Close"
11      closeButtonProps={{ ariaLabel: 'Close' }}
12      onCloseClick={() => {}}
13      theme={{ color: 'red' }}
14      {...otherProps}
15    >
16      {/** Children */}
17    </FilterPersistent>
18  );
19}

Transforms into:

1import { FilterPersistent } from '@americanexpress/dls-react';
2
3export default function Page() {
4  return (
5    <FilterPersistent
6      labelOverrides={{
7        menuHeadingLabel: 'Filters',
8        resetButtonLabel: 'Reset',
9        applyButtonLabel: 'Apply',
10      }}
11      {...otherProps}
12    >
13      {/** Children */}
14    </FilterPersistent>
15  );
16}