pf-codemods

Hey PatternFly-React devs! pf-codemods is an eslint wrapper to update @patternfly/[email protected] code to 6.x.x.

We hope these rules and their autofixers will help you more quickly adopt our breaking changes. These rules are not designed to fix all build errors, but they can help to fix easy ones as well as point out the more complicated ones and offer suggestions on how you might go about fixing them.

If you have any hardcoded Patternfly class names in your project (i.e. pf-c-button) you also might want to see if our class-name-updater package would be helpful for you.

Usage

Simple case

Requires Node.js >= 10.

npx @patternfly/pf-codemods ./path-to-src

Note: when updating from PatternFly 5 to 6, add the --v6 flag.

npx @patternfly/pf-codemods --v6 ./path-to-src

Giving node more RAM can help for large codebases.

NODE_OPTIONS=--max-old-space-size=4096 npx @patternfly/pf-codemods ./path-to-src

These commands will show you places in your code that may have issues with our breaking changes similar to linting. Add the --fix flag to allow us to autofix issues where possible.

Options

Usage: pf-codemods [options] <path> [otherPaths...]

Run codemods on path using eslint.

Options:
  -V, --version      output the version number
  --only <rules>     Comma-seperated list of rules to run
  --exclude <rules>  Run recommended rules EXCLUDING this comma-seperated list
  --fix              Whether to run fixer
  --format <format>  What eslint report format to use (default: "stylish")
  --no-cache         Disables eslint caching
  --v4               Run v3 to v4 codemods
  --v6               Run v5 to v6 codemods
  -h, --help         display help for command

Rules

These rules are based off the breaking change notes for React. Each rule links the breaking change patternfly-react PR in case you want to better understand the change. Also, each rule makes sure you're using a PatternFly component before running.

Some rules will add either a comment (/* data-codemods */) or data attribute (data-codemods="true") in order to prevent certain other rules from applying an unnecessary fix. These data-codemods attributes and comments can be removed by our data-codemods-cleanup rule. You should run this rule only once, after you finish running the general codemods, by adding the --only data-codemods-cleanup option.

accordionContent-remove-isHidden-prop (#9876)

The isHidden prop has been removed from AccordionContent, as its visibility will now be set automatically based on the isExpanded prop on AccordionItem.

Examples

In:

import { AccordionContent } from "@patternfly/react-core";

export const AccordionContentRemoveIsHiddenPropInput = () => (
  <AccordionContent isHidden />
);

Out:

import { AccordionContent } from "@patternfly/react-core";

export const AccordionContentRemoveIsHiddenPropInput = () => (
  <AccordionContent  />
);

accordionItem-warn-update-markup (#9876)

The markup for AccordionItem has been updated, and it now renders a div element as a wrapper.

accordionToggle-move-isExpanded-prop (#9876)

The isExpanded prop for AccordionToggle has been moved to AccordionItem.

Examples

In:

import { AccordionItem, AccordionToggle } from "@patternfly/react-core";

export const AccordionToggleMoveIsExpandedPropInput = () => (
  <AccordionItem>
    <AccordionToggle isExpanded />
  </AccordionItem>
);

Out:

import { AccordionItem, AccordionToggle } from "@patternfly/react-core";

export const AccordionToggleMoveIsExpandedPropInput = () => (
  <AccordionItem isExpanded>
    <AccordionToggle  />
  </AccordionItem>
);

avatar-replace-border-for-isBordered

(#9881) (#9954)

border prop has been removed from Avatar since theming is not longer handled React-side. We recommend using the isBordered prop instead to add a border to Avatar.

Examples

In:

import { Avatar } from '@patternfly/react-core';

export const AvatarReplaceBorderForIsBorderedInput = () => (
  <Avatar border={'dark'} />
);

Out:

import { Avatar } from '@patternfly/react-core';

export const AvatarReplaceBorderForIsBorderedInput = () => (
  <Avatar isBordered />
);

banner-replace-variantProp (#9891)

The variant property has been removed from Banner. We recommend using our new color or status properties, depending on the original intent of the variant property.

Running the fix for this rule will either replace the variant property with the color property, or remove the variant property entirely, but additional updates may need to be made.

Examples

In:

import { Banner } from "@patternfly/react-core";

export const BannerReplaceVariantPropInput = () => (
  <>
    <Banner variant='default' />
    <Banner variant='red' />
  </>
);

Out:

import { Banner } from "@patternfly/react-core";

export const BannerReplaceVariantPropInput = () => (
  <>
    <Banner  />
    <Banner color='red' />
  </>
);

button-moveIcons-icon-prop (#10663)

Icons must now be passed to the icon prop of Button instead of as children. This rule will only update instances of a Button with variant="plain" passed in, but you must ensure you are only passing an icon in such instances before running the fix.

Examples

In:

import { Button, Icon } from "@patternfly/react-core";
import { SomeIcon } from "@patternfly/react-icons";

export const ButtonMoveIconsIconPropInput = () => (
  <>
    <Button variant="plain">
      <span>Icon</span>
    </Button>
    <Button>
      <Icon>
        <SomeIcon />
      </Icon>
    </Button>
    <Button>
      <SomeIcon />
    </Button>
  </>
);

Out:

import { Button, Icon } from "@patternfly/react-core";
import { SomeIcon } from "@patternfly/react-icons";

export const ButtonMoveIconsIconPropInput = () => (
  <>
    <Button icon={<span>Icon</span>} variant="plain"></Button>
    <Button icon={<Icon>
        <SomeIcon />
      </Icon>}>
      
    </Button>
    <Button icon={<SomeIcon />}>
      
    </Button>
  </>
);

button-rename-isActive (#9934)

isActive prop for Button has been renamed to isClicked

Examples

In:

import { Button } from "@patternfly/react-core";

export const ButtonRenameIsActiveInput = () => <Button isActive />;

Out:

import { Button } from "@patternfly/react-core";

export const ButtonRenameIsActiveInput = () => <Button isClicked />;

card-remove-various-props (#10056)

The following props have been removed from Card:

isSelectableRaised
isDisabledRaised
hasSelectableInput
selectableInputAriaLabel
onSelectableInputChange
isFlat
isRounded

Examples

In:

import { Card } from "@patternfly/react-core";

export const CardRemoveVariousPropsInput = () => (
  <Card
    isSelectableRaised
    isDisabledRaised
    hasSelectableInput
    selectableInputAriaLabel="aria label"
    onSelectableInputChange={() => {}}
  />
);

Out:

import { Card } from "@patternfly/react-core";

export const CardRemoveVariousPropsInput = () => (
  <Card
    
    
    
    
    
  />
);

card-updated-clickable-markup (#10859)

The markup for clickable-only cards has been updated. Additionally, the selectableActions.selectableActionId and selectableActions.name props are no longer necessary to pass to CardHeader for clickable-only cards. Passing them in will not cause any errors, but running the fix for this rule will remove them.

Examples

In:

import { Card, CardHeader } from "@patternfly/react-core";

export const CardUpdatedClickableMarkupInput = () => {
  const selectableActionsObj = { name: "Test2", selectableActionId: "Id2" };
  const selectableActionsObjMany = {
    to: "#",
    name: "Test2",
    selectableActionProps: {},
    selectableActionId: "Id2",
  };

  return (
    <>
      <Card isClickable>
        <CardHeader
          selectableActions={{
            to: "#",
            name: "Test",
            selectableActionId: () => {},
          }}
        />
      </Card>
      <Card isClickable>
        <CardHeader selectableActions={selectableActionsObj} />
      </Card>
      <Card isClickable>
        <CardHeader selectableActions={selectableActionsObjMany} />
      </Card>
    </>
  );
};

Out:

import { Card, CardHeader } from "@patternfly/react-core";

export const CardUpdatedClickableMarkupInput = () => {
  const selectableActionsObj = {};
  const selectableActionsObjMany = {to: "#", selectableActionProps: {}};

  return (
    <>
      <Card isClickable>
        <CardHeader
          selectableActions={{to: "#"}}
        />
      </Card>
      <Card isClickable>
        <CardHeader selectableActions={selectableActionsObj} />
      </Card>
      <Card isClickable>
        <CardHeader selectableActions={selectableActionsObjMany} />
      </Card>
    </>
  );
};

chartsImport-moved (#11091)

In order to support multiple chart libraries, Victory based charts have moved. This rule will update import paths to our victory directory.

Additionally, Victory has become a peer dependency.

Examples

In:

import { Chart } from "@patternfly/react-charts";

Out:

import {
  Chart
} from '@patternfly/react-charts/victory';

checkbox-radio-replace-isLabelBeforeButton (#10016)

The isLabelBeforeButton prop in Checkbox and Radio has been replaced with labelPosition="start"

Examples

In:

import { Checkbox, Radio } from "@patternfly/react-core";

export const CheckboxReplaceIsLabelBeforeButtonInput = () => (
  <Checkbox isLabelBeforeButton />
);
export const RadioReplaceIsLabelBeforeButtonInput = () => (
  <Radio isLabelBeforeButton />
);

Out:

import { Checkbox, Radio } from "@patternfly/react-core";

export const CheckboxReplaceIsLabelBeforeButtonInput = () => (
  <Checkbox labelPosition="start" />
);
export const RadioReplaceIsLabelBeforeButtonInput = () => (
  <Radio labelPosition="start" />
);

chip-deprecated (#)

Chip has been deprecated. Running the fix flag will update your imports to our deprecated package, but we suggest using Label instead.

Examples

In:

import { Chip } from '@patternfly/react-core';

Out:

import { Chip } from '@patternfly/react-core/deprecated';

chip-replace-with-label (#10049)

Chip has been deprecated. Running the fix flag will replace Chip and ChipGroup components with Label and LabelGroup components respectively.

Examples

In:

import { Chip } from '@patternfly/react-core/deprecated';

export const ChipReplaceWithLabelInput = () => (
  <Chip onClick={handleClick} badge={badge}>
    This is a chip
  </Chip>
);

Out:

import { Label } from '@patternfly/react-core';

export const ChipReplaceWithLabelInput = () => (
  <Label variant="outline" onClose={handleClick}>
    This is a chip
    {badge}
  </Label>
);

colorProps-replaced-colors (#10661)

The color prop on Banner and Label has been updated to replace "cyan" with "teal" and "gold" with "yellow".

Examples

In:

import { Banner, Label } from "@patternfly/react-core";

export const ColorPropsReplacedColorsInput = () => (
  <>
    <Banner color='gold' />
    <Banner color='cyan' />
    <Label color='gold' />
    <Label color='cyan' />
  </>
);

Out:

import { Banner, Label } from "@patternfly/react-core";

export const ColorPropsReplacedColorsInput = () => (
  <>
    <Banner color="yellow" />
    <Banner color="teal" />
    <Label color="yellow" />
    <Label color="teal" />
  </>
);

componentGroups-logSnippet-rename-leftBorderVariant (react-component-groups/#145)

In react-component-groups, we've renamed LogSnippet's prop leftBorderVariant to variant and replaced LogSnippetBorderVariant enum with PatternFly's AlertVariant enum.

Examples

In:

import {
  LogSnippet,
  LogSnippetBorderVariant,
} from "@patternfly/react-component-groups";

export const LogSnippetRenameLeftBorderVariantInput = () => (
  <LogSnippet
    message="Failure - check logs for details"
    logSnippet="code"
    leftBorderVariant={LogSnippetBorderVariant.success}
  />
);

Out:

import { LogSnippet } from "@patternfly/react-component-groups";

export const LogSnippetRenameLeftBorderVariantInput = () => (
  <LogSnippet
    message="Failure - check logs for details"
    logSnippet="code"
    variant={"success"}
  />
);

component-groups-contentHeader-rename-to-pageHeader (react-component-groups/#313)

In react-component-groups, we've renamed ContentHeader component to PageHeader

Examples

In:

import { ContentHeader } from "@patternfly/react-component-groups";

export const ComponentGroupsContentHeaderRenameToPageHeaderInput = () => (
  <ContentHeader />
);

Out:

import { PageHeader } from "@patternfly/react-component-groups";

export const ComponentGroupsContentHeaderRenameToPageHeaderInput = () => (
  <PageHeader data-codemods />
);

componentGroups-errorState-rename-props (react-component-groups/#145)

In react-component-groups, we've renamed some ErrorState props to comply with its base component - EmptyState.

Examples

In:

import { ErrorState } from "@patternfly/react-component-groups";

export const ComponentGroupsErrorStateRenamePropsInput = () => (
  <ErrorState
    errorTitle="Sample error title"
    errorDescription="Sample error description"
    defaultErrorDescription="Sample default error description"
  />
);

Out:

import { ErrorState } from "@patternfly/react-component-groups";

export const ComponentGroupsErrorStateRenamePropsInput = () => (
  <ErrorState
    titleText="Sample error title"
    bodyText="Sample error description"
    defaultBodyText="Sample default error description"
  />
);

component-groups-invalidObject-rename-props (react-component-groups/#145)

In react-component-groups, we've renamed InvalidObject's props invalidObjectTitleText to titleText and invalidObjectBodyText to bodyText.

Examples

In:

import { InvalidObject } from "@patternfly/react-component-groups";

export const ComponentGroupsInvalidObjectRenamePropsInput = () => (
  <InvalidObject
    invalidObjectTitleText="Sample title"
    invalidObjectBodyText="Sample description"
  />
);

Out:

import { InvalidObject } from "@patternfly/react-component-groups";

export const ComponentGroupsInvalidObjectRenamePropsInput = () => (
  <InvalidObject
    titleText="Sample title"
    bodyText="Sample description"
  />
);

component-groups-invalidObject-rename-to-missingPage (react-component-groups/#313)

In react-component-groups, we've renamed InvalidObject component to MissingPage

Examples

In:

import { InvalidObject } from "@patternfly/react-component-groups";

export const ComponentGroupsInvalidObjectRenameToMissingPageInput =
  () => <InvalidObject />;

Out:

import { MissingPage } from "@patternfly/react-component-groups";

export const ComponentGroupsInvalidObjectRenameToMissingPageInput =
  () => <MissingPage data-codemods />;

component-groups-multi-content-card-remove-props (react-component-groups/#145)

The leftBorderVariant and withHeaderBorder props have been removed from MultiContentCard.

Examples

In:

import { MultiContentCard } from "@patternfly/react-component-groups";

export const ComponentGroupsMultiContentCardRemovePropsInput = () => <MultiContentCard leftBorderVariant="danger" withHeaderBorder />

Out:

import { MultiContentCard } from "@patternfly/react-component-groups";

export const ComponentGroupsMultiContentCardRemovePropsInput = () => <MultiContentCard   />

component-groups-notAuthorized-rename-props (react-component-groups/#145)

In react-component-groups, we've renamed NotAuthorized's props description to bodyText and title to titleText.

Examples

In:

import { NotAuthorized } from "@patternfly/react-component-groups";

export const ComponentGroupsNotAuthorizedRenamePropsInput = () => (
  <NotAuthorized description="Description text" title="Title text" />
);

Out:

import { NotAuthorized } from "@patternfly/react-component-groups";

export const ComponentGroupsNotAuthorizedRenamePropsInput = () => (
  <NotAuthorized bodyText="Description text" titleText="Title text" />
);

component-groups-notAuthorized-rename-to-unauthorizedAccess (react-component-groups/#313)

In react-component-groups, we've renamed NotAuthorized component to UnauthorizedAccess

Examples

In:

import { NotAuthorized } from "@patternfly/react-component-groups";

export const ComponentGroupsNotAuthorizedRenameToUnauthorizedAccessInput =
  () => <NotAuthorized />;

Out:

import { UnauthorizedAccess } from "@patternfly/react-component-groups";

export const ComponentGroupsNotAuthorizedRenameToUnauthorizedAccessInput =
  () => <UnauthorizedAccess data-codemods />;

component-groups-unavailableContent-bodyText-props-update (react-component-groups/#244)

In react-component-groups, we have replaced UnavailableContent's props unavailableBodyPreStatusLinkText and unavailableBodyPostStatusLinkText with one bodyText prop. Also status page link button has changed to a primary button. Consider capitalizing the statusPageLinkText prop.

Examples

In:

import { UnavailableContent } from "@patternfly/react-component-groups";

export const ComponentGroupsUnavailableContentBodyTextPropsUpdateInput = () => (
  <>
    <UnavailableContent
      unavailableBodyPreStatusLinkText="Visit our"
      unavailableBodyPostStatusLinkText="for more info."
      statusPageLinkText="custom status page"
    />
    <UnavailableContent unavailableBodyPreStatusLinkText="Visit our" />
    <UnavailableContent unavailableBodyPostStatusLinkText="for more info." />
  </>
);

Out:

import { UnavailableContent } from "@patternfly/react-component-groups";

export const ComponentGroupsUnavailableContentBodyTextPropsUpdateInput = () => (
  <>
    <UnavailableContent
      bodyText="Visit our custom status page for more info."
      statusPageLinkText="Custom status page"
    />
    <UnavailableContent bodyText="Visit our status page for known outages." />
    <UnavailableContent bodyText="Try refreshing the page. If the problem persists, contact your organization administrator or visit our status page for more info." />
  </>
);

component-groups-unavailable-content-rename-props (react-component-groups/#145)

The UnavailableContent component of React Component Groups has had the unavailableTitleText prop renamed to titleText.

Examples

In:

import { UnavailableContent } from "@patternfly/react-component-groups";

export const ComponentGroupsUnavailableContentRenamePropsInput = () => (
  <UnavailableContent unavailableTitleText="foo" />
);

Out:

import { UnavailableContent } from "@patternfly/react-component-groups";

export const ComponentGroupsUnavailableContentRenamePropsInput = () => (
  <UnavailableContent titleText="foo" />
);

data-codemods-cleanup

This rule will remove data-codemods attributes and comments, which were introduced by our codemods in order to work correctly. You should run this rule only once, after you finish running the codemods.

This rule can only run using the --only data-codemods-cleanup option.

Examples

In:

import {
  DualListSelector /* data-codemods */,
  LoginMainFooterLinksItem,
  MastheadLogo,
} from "@patternfly/react-core";

export const DataCodemodsCleanupInput = () => (
  <>
    <DualListSelector />
    <LoginMainFooterLinksItem data-codemods="true" />
    <MastheadLogo data-codemods />
  </>
);

Out:

import {
  DualListSelector ,
  LoginMainFooterLinksItem,
  MastheadLogo,
} from "@patternfly/react-core";

export const DataCodemodsCleanupInput = () => (
  <>
    <DualListSelector />
    <LoginMainFooterLinksItem  />
    <MastheadLogo  />
  </>
);

dataListAction-remove-isPlainButtonAction-prop (#10939)

The isPlainButtonAction prop has been removed from DataListAction as a wrapper is no longer needed.

Examples

In:

import { DataListAction } from "@patternfly/react-core";

export const DataListActionRemoveIsPlainButtonActionPropInput = () => (
  <DataListAction isPlainButtonAction/>
);

Out:

import { DataListAction } from "@patternfly/react-core";

export const DataListActionRemoveIsPlainButtonActionPropInput = () => (
  <DataListAction />
);

dragDrop-deprecated (#10181)

DragDrop has been deprecated. Running the fix flag will update your imports to our deprecated package, but we suggest using our new drag and drop implementation (DragDropSort component), that lives in '@patternfly/react-drag-drop' package.

Examples

In:

import { DragDrop, Droppable, Draggable } from '@patternfly/react-core';

export const DragDropDeprecatedInput = () => (
  <DragDrop onDrop={onDrop}>
    <Droppable>
      <Draggable key={1}>Item 1</Draggable>
      <Draggable key={2}>Item 2</Draggable>
    </Droppable>
  </DragDrop>
);

Out:

import {
  DragDrop,
  Droppable,
  Draggable,
} from '@patternfly/react-core/deprecated';

export const DragDropDeprecatedInput = () => (
  <DragDrop onDrop={onDrop}>
    <Droppable>
      <Draggable key={1}>Item 1</Draggable>
      <Draggable key={2}>Item 2</Draggable>
    </Droppable>
  </DragDrop>
);

drawerContent-replace-noBackground-colorVariant (#10211)

The "no-background" value of the colorVariant prop on DrawerContent has been removed, and a new "primary" value has been added.

Additionally, a new DrawerContentColorVariant enum has been added and should be used instead of the DrawerColorVariant enum. The fix when the DrawerColorVariant enum is being used will replace the colorVariant prop value with a string.

Examples

In:

import { DrawerContent, DrawerColorVariant } from "@patternfly/react-core";

export const DrawerContentReplaceNoBackgroundColorVariantInput = () => {
  const stringColor = "no-background";
  const enumColor = DrawerColorVariant.default;

  return (
    <>
      <DrawerContent colorVariant='no-background' />
      <DrawerContent colorVariant={DrawerColorVariant.default} />
      <DrawerContent colorVariant={stringColor} />
      <DrawerContent colorVariant={enumColor} />
    </>
  );
};

Out:

import { DrawerContent, DrawerColorVariant } from "@patternfly/react-core";

export const DrawerContentReplaceNoBackgroundColorVariantInput = () => {
  const stringColor = "no-background";
  const enumColor = DrawerColorVariant.default;

  return (
    <>
      <DrawerContent  />
      <DrawerContent colorVariant="default" />
      <DrawerContent  />
      <DrawerContent colorVariant="default" />
    </>
  );
};

drawer-remove-props (#10036)

The hasNoPadding prop has been removed from DrawerHead.

Examples

In:

import { DrawerHead } from "@patternfly/react-core";

export const DrawerRemovePropsInput = () => <DrawerHead hasNoPadding />;

Out:

import { DrawerHead } from "@patternfly/react-core";

export const DrawerRemovePropsInput = () => <DrawerHead  />;

drawerHead-warn-updated-markup (#10036)

DrawerPanelBody is no longer rendered internally to DrawerHead. We recommend using these components independent of one another and to not pass DrawerPanelBody to DrawerHead.

drawer-replace-colorVariant-light200 (#10017) (#10036)

The "light-200" value for the colorVariant prop has been replaced with the "secondary" value for DrawerContent, DrawerPanelContent, and DrawerSection components.

Additionally, the light200 property for the DrawerColorVariant enum has been replaced with the secondary property.

Examples

In:

import { DrawerContent, DrawerColorVariant } from "@patternfly/react-core";

export const DrawerReplaceColorVariantLight200Input = () => (
  <>
    <DrawerContent colorVariant='light-200' />
    <DrawerContent colorVariant={DrawerColorVariant.light200} />
  </>
);

Out:

import { DrawerContent, DrawerColorVariant } from "@patternfly/react-core";

export const DrawerReplaceColorVariantLight200Input = () => (
  <>
    <DrawerContent colorVariant="secondary" />
    <DrawerContent colorVariant={DrawerColorVariant.secondary} />
  </>
);

dualListSelector-deprecated (#10359)

Our previous implementation of DualListSelector has been deprecated. This rule will update import paths to our deprecated directory, but we recommend using our newly promoted implementation.

Examples

In:

import { DualListSelector } from "@patternfly/react-core";

Out:

import {
	DualListSelector
} from '@patternfly/react-core/deprecated';

dualListSelectorNext-promoted (#10359)

Our Next implementation of DualListSelector has been promoted as our recommended implementation. This rule will update import paths.

Examples

In:

import { DualListSelector } from "@patternfly/react-core/next";

Out:

import {
	DualListSelector /* data-codemods */
} from '@patternfly/react-core';

emptyStateHeader-move-into-emptyState (#9947)

EmptyStateHeader and EmptyStateIcon are now rendered internally within EmptyState and should only be customized using props. Content passed to the icon prop on EmptyState will also be wrapped by EmptyStateIcon automatically.

Examples

In:

import {
  EmptyState,
  EmptyStateBody,
  EmptyStateHeader,
  EmptyStateIcon,
  CubesIcon,
  Title,
} from "@patternfly/react-core";

export const EmptyStateHeaderMoveIntoEmptyStateInput = () => (
  <EmptyState>
    <EmptyStateHeader
      titleText="Empty state"
      headingLevel="h4"
      icon={<EmptyStateIcon icon={CubesIcon} />}
    />
  </EmptyState>
);

export const EmptyStateWithoutHeaderMoveIntoEmptyStateInput = () => (
  <EmptyState>
    <Title headingLevel="h4" size="lg">
      Foo
    </Title>
    <EmptyStateIcon icon={CubesIcon} />
    <EmptyStateBody>Body</EmptyStateBody>
  </EmptyState>
);

export const EmptyStateHeaderWithoutTitleTextMoveIntoEmptyStateInput = () => (
  <EmptyState>
    <EmptyStateHeader
      className="some-class"
      icon={<EmptyStateIcon icon={CubesIcon} />}
    />
  </EmptyState>
);

export const EmptyStateWithoutHeaderAndTitleTextMoveIntoEmptyStateInput =
  () => (
    <EmptyState>
      <EmptyStateIcon icon={CubesIcon} />
      <EmptyStateBody>Body</EmptyStateBody>
    </EmptyState>
  );

Out:

import {
  EmptyState,
  EmptyStateBody,
  EmptyStateHeader,
  EmptyStateIcon,
  CubesIcon,
  Title,
} from "@patternfly/react-core";

export const EmptyStateHeaderMoveIntoEmptyStateInput = () => (
  <EmptyState  headingLevel="h4" icon={CubesIcon}  titleText="Empty state">
    </EmptyState>
);

export const EmptyStateWithoutHeaderMoveIntoEmptyStateInput = () => (
  <EmptyState titleText={<Title headingLevel="h4" size="lg">
      Foo
    </Title>} icon={CubesIcon}>
    <EmptyStateBody>Body</EmptyStateBody>
  </EmptyState>
);

export const EmptyStateHeaderWithoutTitleTextMoveIntoEmptyStateInput = () => (
  <EmptyState headerClassName="some-class"  icon={CubesIcon}  >
    </EmptyState>
);

export const EmptyStateWithoutHeaderAndTitleTextMoveIntoEmptyStateInput =
  () => (
    <EmptyState icon={CubesIcon}>
      <EmptyStateBody>Body</EmptyStateBody>
    </EmptyState>
  );

emptyState-nonExported-components (#10364)

EmptyStateHeader and EmptyStateIcon are no longer exported by PatternFly. This rule will only apply fixes for exports of these components, as our rule for unused imports will handle applying fixes for imports.

Examples

In:

import { EmptyStateHeader, EmptyStateIcon } from "@patternfly/react-core";

export { EmptyStateHeader, EmptyStateIcon };
export {
  EmptyStateHeader as CustomESHeader,
  EmptyStateIcon as CustomESIcon,
} from "@patternfly/react-core";

Out:

import { EmptyStateHeader, EmptyStateIcon } from "@patternfly/react-core";

formFiledGroupHeaderTitleTextObject-renamed (#10016)

There was a typo in FormFiledGroupHeaderTitleTextObject interface. It was renamed to the intended FormFieldGroupHeaderTitleTextObject.

Examples

In:

import { FormFiledGroupHeaderTitleTextObject } from "@patternfly/react-core";
export { FormFiledGroupHeaderTitleTextObject as HeaderTitleObject } from "@patternfly/react-core";

interface MyExtension extends FormFiledGroupHeaderTitleTextObject {}

const titleTextObject: FormFiledGroupHeaderTitleTextObject = {
  text: "Some title",
  id: "form-field-group-header-title-text",
};

Out:

import { FormFieldGroupHeaderTitleTextObject } from "@patternfly/react-core";
export { FormFieldGroupHeaderTitleTextObject as HeaderTitleObject } from "@patternfly/react-core";

interface MyExtension extends FormFieldGroupHeaderTitleTextObject {}

const titleTextObject: FormFieldGroupHeaderTitleTextObject = {
  text: "Some title",
  id: "form-field-group-header-title-text",
};

formGroup-rename-labelIcon (#10016)

The labelIcon prop for FormGroup has been renamed to labelHelp. We recommend using FormGroupLabelHelp element for the labelHelp prop. The markup has also changed, we now wrap the labelHelp element in <span className="pf-v6-c-form__group-label-help">, so there is no need to add className="pf-v6-c-form__group-label-help" to the labelHelp element.

Examples

In:

import { FormGroup } from "@patternfly/react-core";

export const FormGroupRenameLabelIconInput = () => (
  <FormGroup labelIcon={<>Help icon</>} />
);

Out:

import { FormGroup } from "@patternfly/react-core";

export const FormGroupRenameLabelIconInput = () => (
  <FormGroup labelHelp={<>Help icon</>} />
);

helperTextItem-remove-props (#10029)

The hasIcon and isDynamic props have been removed from HelperTextItem. An icon will now render automatically when the variant prop has a value other than "default" or when the icon prop is passed in.

Examples

In:

import { HelperTextItem } from "@patternfly/react-core";

export const HelperTextItemRemovePropsInput = () => (
  <HelperTextItem hasIcon isDynamic />
);

Out:

import { HelperTextItem } from "@patternfly/react-core";

export const HelperTextItemRemovePropsInput = () => (
  <HelperTextItem   />
);

helperTextItem-warn-screenReaderText-update (#10029)

The screenReaderText prop on HelperTextItem has been updated, and will now render only when the variant prop has a value other than "default". Previously the prop was rendered only when the isDynamic prop was true.

jumpLinksItem-href-required (#10027)

The href prop on JumpLinksItem is now required.

jumpLinksItem-warn-markup-change (#10027)

The markup for JumpLinksItem has changed, as it now uses our Button component internally. Additionally, the onClick prop type has been updated to just React.MouseEvent (previously React.MouseEvent<HTMLAnchorElement>).

kebabToggle-removed (#10345)

KebabToggle has been removed from PatternFly. We recommend using our MenuToggle component instead. Running the fix for this rule will replace most KebabToggle usage with a MenuToggle. Depending on the use-case, however, additional manual updates may be necessary, such as upgrading from our deprecated Dropdown implementation to our current one.

Examples

In:

import { KebabToggle } from "@patternfly/react-core/deprecated";

export const KebabToggleRemovedInput = () => (
  <>
    <KebabToggle onToggle={() => {}} />
    <Dropdown toggle={<KebabToggle onToggle={() => {}} />} />
  </>
);

Out:

import { MenuToggle } from "@patternfly/react-core";
import EllipsisVIcon from "@patternfly/react-icons/dist/esm/icons/ellipsis-v-icon";

export const KebabToggleRemovedInput = () => (
  <>
    <MenuToggle variant="plain" icon={<EllipsisVIcon aria-hidden="true" />} onClick={() => {}} />
    <Dropdown toggle={<MenuToggle variant="plain" icon={<EllipsisVIcon aria-hidden="true" />} onClick={() => {}} />} />
  </>
);

label-remove-isOverflowLabel (#10037)

The isOverflowLabel prop for Label has been replaced with variant="overflow". Running the fix for this rule will replace an existing variant prop (which had no effect if isOverflowLabel was used).

Examples

In:

import { Label } from "@patternfly/react-core";

export const LabelRemoveIsOverflowLabelInput = () => <Label isOverflowLabel />;
export const LabelRemoveIsOverflowLabelInput2 = () => (
  <Label isOverflowLabel variant="outline" />
);

Out:

import { Label } from "@patternfly/react-core";

export const LabelRemoveIsOverflowLabelInput = () => (
  <Label variant="overflow" />
);
export const LabelRemoveIsOverflowLabelInput2 = () => (
  <Label variant="overflow" />
);

loginMainFooterLinksItem-structure-updated (#10107)

LoginMainFooterLinksItem structure has changed. Instead of passing it many properties, everything is now passed in a children component directly.

Examples

In:

import { LoginMainFooterLinksItem } from "@patternfly/react-core";

export const LoginMainFooterLinksItemStructureUpdatedInput = () => (
  <LoginMainFooterLinksItem
    href="https://github.com/login"
    linkComponentProps={{ "aria-label": "Login with Github" }}
  >
    <i>GitHub icon</i>
  </LoginMainFooterLinksItem>
);

Out:

import { LoginMainFooterLinksItem, Button } from "@patternfly/react-core";

export const LoginMainFooterLinksItemStructureUpdatedInput = () => (
  <LoginMainFooterLinksItem data-codemods="true">
    <Button
      variant="link"
      component="a"
      href="https://github.com/login"
      {...{ "aria-label": "Login with Github" }}
    >
      <i>GitHub icon</i>
    </Button>
  </LoginMainFooterLinksItem>
);

loginMainHeader-warn-updated-markup (#10880)

The markup for LoginMainHeader - which is used internally within LoginPage - has been updated, now using a div wrapper instead of a header element wrapper.

logViewer-moved-styles (#70)

The stylesheet for LogViewer has been moved out of the PatternFly package and into LogViewer itself. You may need to update stylesheet imports or import the stylesheet manually.

masthead-name-changes (#10809)

Our old implementation of MastheadBrand has been renamed to MastheadLogo, which must be wrapped by our new implementation of MastheadBrand."

This rule will handle the renaming, required restructuring will be handled under a separate rule.

Examples

In:

import { MastheadBrand } from "@patternfly/react-core";

export const MastheadNameChanges = () => <MastheadBrand>Logo</MastheadBrand>;

Out:

import { MastheadLogo } from "@patternfly/react-core";

export const MastheadNameChanges = () => <MastheadLogo data-codemods>Logo</MastheadLogo>;

masthead-remove-background-color (#9774)

We've removed the backgroundColor prop from Masthead as theming is no longer handled React-side.

Examples

In:

import { Masthead } from "@patternfly/react-core";

export const MastheadRemoveBackgroundColorInput = () => <Masthead backgroundColor />

Out:

import { Masthead } from "@patternfly/react-core";

export const MastheadRemoveBackgroundColorInput = () => <Masthead  />

masthead-structure-changes (#10809)

The structure of Masthead has been updated, MastheadToggle and MastheadBrand should now be wrapped in MastheadMain.

Examples

In:

import {
  Masthead,
  MastheadBrand,
  MastheadMain,
  MastheadToggle,
  MastheadLogo
} from "@patternfly/react-core";

export const MastheadStructureChangesInputPreNameChange = () => (
  <Masthead>
    <MastheadToggle>Foo</MastheadToggle>
    <MastheadMain>
      <MastheadBrand>Bar</MastheadBrand>
    </MastheadMain>
  </Masthead>
);

export const MastheadStructureChangesInputPostNameChange = () => (
  <Masthead>
    <MastheadToggle>Foo</MastheadToggle>
    <MastheadMain>
      <MastheadLogo>Bar</MastheadLogo>
    </MastheadMain>
  </Masthead>
);

Out:

import {
  Masthead,
  MastheadBrand,
  MastheadMain,
  MastheadToggle,
  MastheadLogo,
} from "@patternfly/react-core";

export const MastheadStructureChangesInputPreNameChange = () => (
  <Masthead>
    <MastheadMain>
      <MastheadToggle>Foo</MastheadToggle>
      <MastheadBrand data-codemods>
        <MastheadBrand>Bar</MastheadBrand>
      </MastheadBrand>
    </MastheadMain>
  </Masthead>
);

export const MastheadStructureChangesInputPostNameChange = () => (
  <Masthead>
    <MastheadMain>
      <MastheadToggle>Foo</MastheadToggle>
      <MastheadBrand data-codemods>
        <MastheadLogo>Bar</MastheadLogo>
      </MastheadBrand>
    </MastheadMain>
  </Masthead>
);

menuItemAction-warn-update-markup (#10089)

The markup for MenuItemAction has been updated. It now uses our Button component internally, has a wrapper around the action button, and no longer renders an icon wrapper inside the action button.

menuToggle-remove-splitButtonOptions (#11096)

We have replaced splitButtonOptions prop on MenuToggle with splitButtonItems. SplitButtonOptions interface has been deleted, because its variant prop no longer supports the "action" option. The items prop of SplitButtonOptions will be passed directly to MenuToggle's new splitButtonItems prop.

Examples

In:

import { MenuToggle, SplitButtonOptions } from "@patternfly/react-core";

const sbOptions: SplitButtonOptions = {
  items: ["Item 1", "Item 2"],
  variant: "action",
};

export const MenuToggleRemoveSplitButtonOptionsInput = () => (
  <>
    <MenuToggle
      splitButtonOptions={{
        items: ["Item 1", "Item 2"],
        variant: "action",
      }}
    ></MenuToggle>
    <MenuToggle splitButtonOptions={sbOptions}></MenuToggle>
  </>
);

Out:

import { MenuToggle,  } from "@patternfly/react-core";

const sbOptions = {
  items: ["Item 1", "Item 2"],
  variant: "action",
};

export const MenuToggleRemoveSplitButtonOptionsInput = () => (
  <>
    <MenuToggle
      splitButtonItems={["Item 1", "Item 2"]}
    ></MenuToggle>
    <MenuToggle splitButtonItems={sbOptions.items}></MenuToggle>
  </>
);

menuToggle-warn-iconOnly-toggle (#10097)

We now recommend passing any icon to the icon prop instead of passing it as children, such as for plain, icon only toggles. Passing an icon as children will result in incorrect styling.

Examples

This rule will not provide a fix, but you can refer to the following code blocks to see what updates would need to be made manually.

Previous recommendation:

import { MenuToggle } from "@patternfly/react-core";
import EllipsisVIcon from "@patternfly/react-icons/dist/esm/icons/ellipsis-v-icon";

export const MenuToggleWarnIconOnlyToggleInput = () => (
  <MenuToggle aria-label='A descriptive aria-label' variant='plain'>
    <EllipsisVIcon />
  </MenuToggle>
);

New recommendation:

import { MenuToggle } from "@patternfly/react-core";
import EllipsisVIcon from "@patternfly/react-icons/dist/esm/icons/ellipsis-v-icon";

export const MenuToggleWarnIconOnlyToggleInput = () => (
  <MenuToggle
    icon={EllipsisVIcon}
    aria-label='A descriptive aria-label'
    variant='plain'
  />
);

modal-deprecated (#10358)

Our previous implementation of Modal has been deprecated. This rule will update import paths to our deprecated directory, but we recommend using our newly promoted implementation.

Examples

In:

import { Modal } from "@patternfly/react-core";

Out:

import {
	Modal
} from '@patternfly/react-core/deprecated';

modalNext-promoted (#10358)

Our Next implementation of Modal has been promoted as our recommended implementation. This rule will update import paths.

Examples

In:

import { Modal } from "@patternfly/react-core/next";

Out:

import {
	Modal /* data-codemods */
} from '@patternfly/react-core';

navItem-remove-hasNavLinkWrapper-prop (#10687)

The hasNavLinkWrapper prop has been removed from NavItem. Additionally, any icons for a NavItem should be passed to its new icon prop.

Examples

In:

import { NavItem } from "@patternfly/react-core";

export const NavItemRemoveHasNavLinkWrapperPropInput = () => <NavItem hasNavLinkWrapper />

Out:

import { NavItem } from "@patternfly/react-core";

export const NavItemRemoveHasNavLinkWrapperPropInput = () => <NavItem  />

nav-remove-tertiary-variant (#9948)

The "tertiary" Nav variant is no longer supported. Use variant="horizontal-subnav" instead.

Examples

In:

import { Nav } from "@patternfly/react-core";

export const NavRemoveTertiaryVariantInput = () => <Nav variant="tertiary" />;
export const NavRemoveTertiaryVariantInput2 = () => (
  <Nav variant={"tertiary"} />
);

Out:

import { Nav } from "@patternfly/react-core";

export const NavRemoveTertiaryVariantInput = () => (
  <Nav variant="horizontal-subnav" />
);
export const NavRemoveTertiaryVariantInput2 = () => (
  <Nav variant={"horizontal-subnav"} />
);

nav-remove-theme-prop (#9948)

The theme prop is no longer supported in Nav. Use light/dark mode theming instead.

Examples

In:

import { Nav } from "@patternfly/react-core";

export const NavRemoveThemePropInput = () => <Nav theme="dark" />;
export const NavRemoveThemePropInput2 = () => <Nav theme="light" />;

Out:

import { Nav } from "@patternfly/react-core";

export const NavRemoveThemePropInput = () => <Nav />;
export const NavRemoveThemePropInput2 = () => <Nav />;

no-duplicate-import-specifiers

Duplicate import specifiers should be removed. This is a cleanup rule which runs after other rules.

Examples

In:

import { Button, Button } from "@patternfly/react-core";

export const NoDuplicateImportSpecifiersInput = () => (
  <Button>Sample button</Button>
);

Out:

import { Button } from "@patternfly/react-core";

export const NoDuplicateImportSpecifiersInput = () => (
  <Button>Sample button</Button>
);

notificationBadge-warn-markup-change (#10020)

The markup for NotificationBadge has changed, as it now uses stateful button internally.

notificationDrawerHeader-warn-update-markup (#10378)

NotificationDrawerHeader no longer uses our Text component internally, and instead renders a native h1 element.

no-unused-imports-v6

PatternFly imports that are unused imports should be removed.

Examples

In:

import { Foo, Bar } from "@patternfly/react-core";

export const NoUnusedImportsInput = () => <Bar />;

Out:

import { Bar } from "@patternfly/react-core";

export const NoUnusedImportsInput = () => <Bar />;

pageBreadcrumbAndSection-warn-updated-wrapperLogic (#10650)

The isWidthLimited prop on PageBreadcrumb and PageSection will no longer determine whether the children of either component are wrapped in a PageBody. Instead the new hasBodyWrapper prop must be used. By default this new prop is set to true. Running the fix for this rule will apply hasBodyWrapper with the same value as the isWidthLimited prop or false if isWidthLimited is not passed.

Examples

In:

import { PageBreadcrumb, PageSection } from "@patternfly/react-core";

export const PageBreadcrumbAndSectionWarnUpdatedWrapperLogicInput = () => (
  <>
    <PageBreadcrumb isWidthLimited />
    <PageBreadcrumb isWidthLimited={someVar} />
    <PageBreadcrumb isWidthLimited={() => someCallback()} />
    <PageSection isWidthLimited />
    <PageSection isWidthLimited={someVar} />
    <PageSection isWidthLimited={() => someCallback()} />
  </>
);

Out:

import { PageBreadcrumb, PageSection } from "@patternfly/react-core";

export const PageBreadcrumbAndSectionWarnUpdatedWrapperLogicInput = () => (
  <>
    <PageBreadcrumb hasBodyWrapper isWidthLimited />
    <PageBreadcrumb hasBodyWrapper={someVar} isWidthLimited={someVar} />
    <PageBreadcrumb hasBodyWrapper={() => someCallback()} isWidthLimited={() => someCallback()} />
    <PageSection hasBodyWrapper isWidthLimited />
    <PageSection hasBodyWrapper={someVar} isWidthLimited={someVar} />
    <PageSection hasBodyWrapper={() => someCallback()} isWidthLimited={() => someCallback()} />
  </>
);

pageHeaderToolsItem-remove-isSelected-prop (#9774)

The isSelected prop has been removed from PageHeaderToolsItem.

Examples

In:

import { PageHeaderToolsItem } from "@patternfly/react-core/deprecated";

export const PageHeaderToolsItemRemoveIsSelectedPropInput = () => (
  <PageHeaderToolsItem isSelected />
);

Out:

import { PageHeaderToolsItem } from "@patternfly/react-core/deprecated";

export const PageHeaderToolsItemRemoveIsSelectedPropInput = () => (
  <PageHeaderToolsItem  />
);

pageNavigation-remove-component (#10650)

The PageNavigation component has been removed from PatternFly.

Examples

In:

import { PageNavigation } from "@patternfly/react-core";

export const PageNavigationRemoveComponentInput = () => (
  <div>
    <PageNavigation />
    <div>Some adjacent content</div>
    <PageNavigation>
      <div>Some internal content</div>
    </PageNavigation>
  </div>
);

export { PageNavigation } from "@patternfly/react-core";
export { PageNavigation as CustomNav };
export default PageNavigation;

Out:

import { PageNavigation } from "@patternfly/react-core";

export const PageNavigationRemoveComponentInput = () => (
  <div>
    
    <div>Some adjacent content</div>
    
      <div>Some internal content</div>
    
  </div>
);

page-rename-header (#10454)

We've renamed the header prop for Page to masthead.

Examples

In:

import { Page } from '@patternfly/react-core';

export const PageRenameHeaderInput = () => <Page header={<Masthead />} />;

Out:

import { Page } from '@patternfly/react-core';

export const PageRenameHeaderInput = () => <Page masthead={<Masthead />} />;

page-rename-isTertiaryNavGrouped (#9948)

We've renamed the `isTertiaryNavGrouped` prop to `isHorizontalSubnavGrouped`.

Examples

In:

import { Page } from '@patternfly/react-core';

export const PageRenameIsTertiaryNavGroupedInput = () => (
  <Page isTertiaryNavGrouped />
);

Out:

import { Page } from '@patternfly/react-core';

export const PageRenameIsTertiaryNavGroupedInput = () => (
  <Page isHorizontalSubnavGrouped />
);

page-rename-isTertiaryNavWidthLimited (#9948)

We've renamed the `isTertiaryNavWidthLimited` prop to `isHorizontalSubnavWidthLimited`.

Examples

In:

import { Page } from '@patternfly/react-core';

export const PageRenameIsTertiaryNavWidthLimitedInput = () => (
  <Page isTertiaryNavWidthLimited />
);

Out:

import { Page } from '@patternfly/react-core';

export const PageRenameIsTertiaryNavWidthLimitedInput = () => (
  <Page isHorizontalSubnavWidthLimited />
);

page-rename-tertiaryNav (#9948)

We've renamed the `tertiaryNav` prop to `horizontalSubnav`.

Examples

In:

import { Page } from '@patternfly/react-core';

export const PageRenameTertiaryNavInput = () => <Page tertiaryNav />;

Out:

import { Page } from '@patternfly/react-core';

export const PageRenameTertiaryNavInput = () => <Page horizontalSubnav />;

pageSection-remove-nav-type (#10650)

The "nav" type for PageSection has been removed.

Examples

In:

import { PageSection, PageSectionTypes } from "@patternfly/react-core";

const chosenType = PageSectionTypes.nav;

export const PageSectionRemoveNavTypeInput = () => (
  <>
    <PageSection type='nav' />
    <PageSection type={PageSectionTypes.nav} />
    <PageSection type={chosenType} />
  </>
);

Out:

import { PageSection, PageSectionTypes } from "@patternfly/react-core";

const chosenType = PageSectionTypes.nav;

export const PageSectionRemoveNavTypeInput = () => (
  <>
    <PageSection  />
    <PageSection  />
    <PageSection  />
  </>
);

pageSection-update-variant-values (#9774) (#9848)

The variant prop for PageSection now only accepts a value of "default" or "secondary". Running the fix for this rule will remove the prop so it uses the default value of "default".

Examples

In:

import { PageSection, PageSectionVariants } from "@patternfly/react-core";

export const PageSectionUpdateVariantValuesInput = () => (
  <>
    <PageSection variant='dark' />
    <PageSection variant={PageSectionVariants.dark} />
  </>
);

Out:

import { PageSection, PageSectionVariants } from "@patternfly/react-core";

export const PageSectionUpdateVariantValuesInput = () => (
  <>
    <PageSection  />
    <PageSection  />
  </>
);

pageSection-warn-variantClasses-applied (#9848)

Classes from the variant prop will now only be applied to PageSection when the type prop has a value of "default".

pageSidebar-remove-theme-prop (#9774)

The theme prop has been removed from PageSidebar as theming is no longer handled React-side.

Examples

In:

import { PageSidebar } from "@patternfly/react-core";

export const PageSidebarRemoveThemePropInput = () => (
  <PageSidebar theme='dark' />
);

Out:

import { PageSidebar } from "@patternfly/react-core";

export const PageSidebarRemoveThemePropInput = () => (
  <PageSidebar  />
);

page-warn-updated-markup (#10650)

The markup for Page has changed. When either the horizontalSubnav or breadcrumb props are passed, a PageBody component will always wrap the contents.

pagination-warn-markup-changed (#10662)

The markup for Pagination has changed. There is now a wrapper element rendered around the PaginationOptionsMenu toggle. This rule does not provide a fixer, but will throw a warning.

popper-update-appendTo-default (#10675)

The default value of appendTo on Dropdown, Select, and Popper has been updated to document.body.

remove-deprecated-components (#10345)

The following deprecated components have been removed from PatternFly, and must be updated accordingly:

Application Launcher: we recommmend using our custom menu application launcher example
Context Selector: we recommmend using our custom menu context selector example
Dropdown: we recommend using either our current composable Dropdown or our Dropdown template implementation
Options Menu: we recommend using either our current composable Select or our Select template implementation
Page Header: we recommend using our Masthead and Toolbar components to build a page header
Select: we recommend using either our current composable Select or our Select template implementation

Note that this rule will not provide any fixers.

simpleFileUpload-warn-changes (#10026)

The aria-describedby attribute was removed from the TextInput within the SimpleFileUpload, and the id attribute was removed from the "browse" button. Instead use the new browseButtonAriaDescribedby prop to provide a description to the browse button.

Additionally, we recommend using our FileUploadHelperText component as a child to the FileUpload, instead of using our FormHelperText (the previous recommendation).

sliderStep-warn-update-markup (#10378)

The --pf-v6-c-slider__step--Left CSS variable applied as an inline style has been updated to the --pf-v6-c-slider__step--InsetInlineStart CSS variable.

switch-remove-labelOff (#10646)

The labelOff prop has been removed from Switch. The label for a Switch should not dynamically update based on the on/off state.

Examples

In:

import { Switch } from "@patternfly/react-core";

export const SwitchRemoveLabelOffInput = () => <Switch labelOff='Some label' />;

Out:

import { Switch } from "@patternfly/react-core";

export const SwitchRemoveLabelOffInput = () => <Switch  />

tabs-renamed-isSecondary-prop (#10044)

The isSecondary prop for Tabs has been renamed to `isSubtab`.

Examples

In:

import { Tabs } from "@patternfly/react-core";

export const TabsRenamedIsSecondaryPropInput = () => <Tabs isSecondary />;

Out:

import { Tabs } from "@patternfly/react-core";

export const TabsRenamedIsSecondaryPropInput = () => <Tabs isSubtab />;

tabs-replace-variant-light300 (#9930) (#10044)

The "light300" value for the variant prop on Tabs has been replaced with the "secondary" value.

Examples

In:

import { Tabs } from "@patternfly/react-core";

export const TabsReplaceVariantLight300Input = () => (
  <Tabs variant='light300' />
);

Out:

import { Tabs } from "@patternfly/react-core";

export const TabsReplaceVariantLight300Input = () => (
  <Tabs variant="secondary" />
);

tabs-update-markup (#10044)

The markup for the Tabs scroll buttons have been updated in the following ways:

Replaced the native button HTML element internally with our Button components
Added a wrapper div around them
Removed styling when the isSubtab (previously isSecondary) prop is true

text-replace-with-content (#10643)

We have replaced Text, TextContent, TextList and TextListItem with one Content component. Running this fix will change all of those components names to Content and add a "component" prop where necessary.

Examples

In:

import {
  Text,
  TextContent,
  TextList,
  TextListVariants,
  TextListItem,
  TextListItemVariants,
  TextProps,
  TextVariants,
} from "@patternfly/react-core";

export const TextReplaceWithContentInput = () => {
  interface Foo extends TextProps {}
  const foo = TextVariants.h1;
  const bar = TextListVariants.ul;
  const baz = TextListItemVariants.li;

  return (
    <>
      <Text component="h3">Abc</Text>
      <Text>Abc</Text>
      <TextContent>Abc</TextContent>
      <TextContent>
        <Text>Some text</Text>
      </TextContent>
      <TextContent isVisited>Abc</TextContent>
      <TextList>Abc</TextList>
      <TextList isPlain>Abc</TextList>
      <TextList component="ol">Abc</TextList>
      <TextListItem>Abc</TextListItem>
      <TextListItem component="dt">Abc</TextListItem>
      <TextListItem component={TextVariants.dt}>Abc</TextListItem>
      <TextList>
        <TextListItem>A</TextListItem>
        <TextListItem>B</TextListItem>
        <TextListItem>C</TextListItem>
      </TextList>
    </>
  );
};

Out:

import {
  Content,
  Content,
  Content,
  ContentVariants,
  Content,
  ContentVariants,
  ContentProps,
  ContentVariants,
} from "@patternfly/react-core";

export const TextReplaceWithContentInput = () => {
  interface Foo extends ContentProps {}
  const foo = ContentVariants.h1;
  const bar = ContentVariants.ul;
  const baz = ContentVariants.li;

  return (
    <>
      <Content component="h3">Abc</Content>
      <Content component="p">Abc</Content>
      <Content>Abc</Content>
      <Content>
        <Content component="p">Some text</Content>
      </Content>
      <Content isVisitedLink>Abc</Content>
      <Content component="ul">Abc</Content>
      <Content component="ul" isPlainList>Abc</Content>
      <Content component="ol">Abc</Content>
      <Content component="li">Abc</Content>
      <Content component="dt">Abc</Content>
      <Content component={ContentVariants.dt}>Abc</Content>
      <Content component="ul">
        <Content component="li">A</Content>
        <Content component="li">B</Content>
        <Content component="li">C</Content>
      </Content>
    </>
  );
};

Th-Td-warn-update-markup (#10378)

The --pf-v6-c-table__sticky-cell--Left and --pf-v6-c-table__sticky-cell--Right CSS variables applied as inline styles when isStickyColumn is true have been updated to --pf-v6-c-table__sticky-cell--InsetInlineStart and --pf-v6-c-table__sticky-cell--InsetInlineEnd, respectively.

tile-deprecated (#10821)

Tile has been deprecated. Running the fix flag will update your imports to our deprecated package, but we suggest using Card instead. There is a new Card example on our documentation showcasing how to set up a Card as a Tile.

Examples

In:

import { Tile } from "@patternfly/react-core";

Out:

import { Tile } from "@patternfly/react-core/deprecated";

tokens-prefix-with-t (#11002)

React tokens, whose value is a Patternfly token variable (with prefix --pf-t), are now prefixed with t_

Examples

In:

import color_green_10 from "@patternfly/react-tokens/dist/esm/color_green_10";

color_green_10;

Out:

import t_color_green_10 from "@patternfly/react-tokens/dist/esm/t_color_green_10";

t_color_green_10;

tokens-update

We have updated our CSS tokens. About half of our tokens have been replaced with newer ones.

this rule provides an autofix for global non color tokens
global color tokens will be replaced with a temporary hot pink color token that must be manually replaced (t_temp_dev_tbd react token or --pf-t--temp--dev--tbd CSS variable)
other non-global (component or chart) tokens need to be replaced manually

To find a suitable replacement token, check our v6 token documentation.

Examples

In:

// replacements (fixable with --fix)
import global_BorderWidth_lg from "@patternfly/react-tokens/dist/esm/global_BorderWidth_lg";
import { global_FontWeight_normal } from "@patternfly/react-tokens";

global_BorderWidth_lg;
global_FontWeight_normal;

document.documentElement.style.setProperty("--pf-v5-global--ZIndex--lg", "3");
<div
  style={{
    borderWidth: "var(--pf-v5-global--BorderWidth--lg)",
    boxShadow: "var(--pf-v5-global--BoxShadow--sm)",
    marginTop: "var(--pf-v5-global--spacer--3xl)",
  }}
></div>;

// warnings (not fixable)
import c_badge_PaddingLeft from "@patternfly/react-tokens/dist/esm/c_badge_PaddingLeft";
import { c_alert__FontSize } from "@patternfly/react-tokens";

c_badge_PaddingLeft;
c_alert__FontSize;

<div
  style={{
    fontSize: "var(--pf-v5-c-alert__FontSize)",
    width: "var(--pf-v5-global--arrow--width)",
  }}
></div>;

// Colors
import global_Color_100 from "@patternfly/react-tokens/dist/esm/global_Color_100";
import { global_Color_200 } from "@patternfly/react-tokens/dist/esm/global_Color_200";
import { global_Color_300 as color300 } from "@patternfly/react-tokens/dist/esm/global_Color_300";
import { global_BorderColor_100 } from "@patternfly/react-tokens";

global_Color_100;
global_Color_200;
color300;
global_BorderColor_100;

<div
  style={{
    color: "var(--pf-v5-global--Color--100)",
    backgroundColor: "var(--pf-v5-global--Color--200)",
  }}
></div>;

Out:

// replacements (fixable with --fix)
import global_border_width_extra_strong from "@patternfly/react-tokens/dist/esm/global_border_width_extra_strong";
import { global_font_weight_body_default } from "@patternfly/react-tokens";

global_border_width_extra_strong;
global_font_weight_body_default;

document.documentElement.style.setProperty("--pf-t--global--z-index--lg", "3");
<div
  style={{
    borderWidth: "var(--pf-t--global--border--width--extra-strong)",
    boxShadow: "var(--pf-t--global--box-shadow--sm)",
    marginTop: "var(--pf-t--global--spacer--3xl)",
  }}
></div>;

// warnings (not fixable)
import c_badge_PaddingLeft from "@patternfly/react-tokens/dist/esm/c_badge_PaddingLeft";
import { c_alert__FontSize } from "@patternfly/react-tokens";

c_badge_PaddingLeft;
c_alert__FontSize;

<div
  style={{
    fontSize: "var(--pf-v5-c-alert__FontSize)",
    width: "var(--pf-v5-global--arrow--width)",
  }}
></div>;

// Colors
import global_Color_100/* CODEMODS: you should update this color token */ from "@patternfly/react-tokens/dist/esm/t_temp_dev_tbd";
import { t_temp_dev_tbd as global_Color_200 /* CODEMODS: you should update this color token */ } from "@patternfly/react-tokens/dist/esm/t_temp_dev_tbd";
import { t_temp_dev_tbd as color300 /* CODEMODS: you should update this color token, original v5 token was global_Color_300 */ } from "@patternfly/react-tokens/dist/esm/t_temp_dev_tbd";
import { t_temp_dev_tbd as global_BorderColor_100 /* CODEMODS: you should update this color token */ } from "@patternfly/react-tokens";

global_Color_100;
global_Color_200;
color300;
global_BorderColor_100;

<div
  style={{
    color: "var(--pf-t--temp--dev--tbd)"/* CODEMODS: original v5 color was --pf-v5-global--Color--100 */,
    backgroundColor: "var(--pf-t--temp--dev--tbd)"/* CODEMODS: original v5 color was --pf-v5-global--Color--200 */,
  }}
></div>;

toolbarChipGroupContent-rename-component (#10649)

The ToolbarChipGroupContent component has been renamed to ToolbarLabelGroupContent.

Examples

In:

import { ToolbarChipGroupContent } from "@patternfly/react-core";

const Component = ToolbarChipGroupContent;
export const ToolbarChipGroupContentRenameComponentInput = () => (
  <>
    <ToolbarChipGroupContent></ToolbarChipGroupContent>
    <ToolbarChipGroupContent />
    <Component />
  </>
);

export { ToolbarChipGroupContent as CustomThing };

Out:

import { ToolbarLabelGroupContent } from "@patternfly/react-core";

const Component = ToolbarLabelGroupContent;
export const ToolbarChipGroupContentRenameComponentInput = () => (
  <>
    <ToolbarLabelGroupContent></ToolbarLabelGroupContent>
    <ToolbarLabelGroupContent />
    <Component />
  </>
);

export { ToolbarLabelGroupContent as CustomThing };

toolbarGroup-updated-variant (#10674)

The variant prop of ToolbarGroup and ToolbarToggleGroup had these options renamed:

Old variant option	New variant option
`button-group`	`action-group`
`icon-button-group`	`action-group-plain`

Examples

In:

import {
  ToolbarGroup,
  ToolbarToggleGroup,
  ToolbarGroupVariant,
} from "@patternfly/react-core";

export const ToolbarGroupUpdatedVariantInput = () => (
  <>
    <ToolbarGroup variant='button-group' />
    <ToolbarGroup variant={ToolbarGroupVariant["icon-button-group"]} />
    <ToolbarToggleGroup variant='icon-button-group' />
    <ToolbarToggleGroup variant={ToolbarGroupVariant["button-group"]} />
  </>
);

Out:

import {
  ToolbarGroup,
  ToolbarToggleGroup,
  ToolbarGroupVariant,
} from "@patternfly/react-core";

export const ToolbarGroupUpdatedVariantInput = () => (
  <>
    <ToolbarGroup variant="action-group" />
    <ToolbarGroup variant={ToolbarGroupVariant["action-group-plain"]} />
    <ToolbarToggleGroup variant="action-group-plain" />
    <ToolbarToggleGroup variant={ToolbarGroupVariant["action-group"]} />
  </>
);

toolbarItem-variant-prop-updates (#10649)

The variant prop for ToolbarItem has been updated: "bulk-select", "overflow-menu" and "search-filter" were removed and "chip-group" was renamed to "label-group".

Examples

In:

import { ToolbarItem } from "@patternfly/react-core";

export const ToolbarItemVariantPropUpdatesInput = () => (
  <>
    <ToolbarItem variant="chip-group" />
    <ToolbarItem variant="bulk-select" />
    <ToolbarItem variant="overflow-menu" />
    <ToolbarItem variant="search-filter" />
  </>
);

Out:

import { ToolbarItem } from "@patternfly/react-core";

export const ToolbarItemVariantPropUpdatesInput = () => (
  <>
    <ToolbarItem variant="label-group" />
    <ToolbarItem  />
    <ToolbarItem  />
    <ToolbarItem  />
  </>
);

toolbarLabelGroupContent-updated-markup (#10674)

The markup for ToolbarLabelGruopContent (formerly ToolbarChipGroupContent) has changed when the numberOfFilters value is greater than 0, when the showClearFiltersButton prop is true, or when the customLabelGroupContent prop is passed. This rule will not provide a fix, but will throw a warning.

toolbar-remove-props (#10674)

The following props have been removed from Toolbar components:

Component	Prop removed
Toolbar	`usePageInsets`
ToolbarContent	`alignSelf`
ToolbarItem	`widths`
ToolbarToggleGroup	`alignment`

Examples

In:

import {
  Toolbar,
  ToolbarContent,
  ToolbarItem,
  ToolbarToggleGroup,
} from "@patternfly/react-core";

export const ToolbarRemovePropsInput = () => (
  <>
    <Toolbar usePageInsets />
    <ToolbarContent alignSelf={{}} />
    <ToolbarItem widths={{}} />
    <ToolbarToggleGroup alignment={{}} />
  </>
);

Out:

import {
  Toolbar,
  ToolbarContent,
  ToolbarItem,
  ToolbarToggleGroup,
} from "@patternfly/react-core";

export const ToolbarRemovePropsInput = () => (
  <>
    <Toolbar  />
    <ToolbarContent  />
    <ToolbarItem  />
    <ToolbarToggleGroup  />
  </>
);

toolbar-replace-chip-instances (#10649)

Several Chip-based props have been renamed on our Toolbar components:

Examples

In:

import {
  Toolbar,
  ToolbarExpandableContent,
  ToolbarFilter,
  ToolbarChipGroupContent,
  ToolbarToggleGroup,
} from "@patternfly/react-core";

export const ToolbarReplaceChipInstancesInput = () => (
  <>
    <Toolbar customChipGroupContent />
    <ToolbarExpandableContent chipContainerRef />
    <ToolbarFilter
      chips
      deleteChipGroup
      deleteChip
      chipGroupExpandedText
      chipGroupCollapsedText
      expandableChipContainerRef
    />
    <ToolbarChipGroupContent chipGroupContentRef customChipGroupContent />
    <ToolbarToggleGroup chipContainerRef />
  </>
);

Out:

import {
  Toolbar,
  ToolbarExpandableContent,
  ToolbarFilter,
  ToolbarChipGroupContent,
  ToolbarToggleGroup,
} from "@patternfly/react-core";

export const ToolbarReplaceChipInstancesInput = () => (
  <>
    <Toolbar customLabelGroupContent />
    <ToolbarExpandableContent labelContainerRef />
    <ToolbarFilter
      labels
      deleteLabelGroup
      deleteLabel
      labelGroupExpandedText
      labelGroupCollapsedText
      expandableLabelContainerRef
    />
    <ToolbarChipGroupContent labelGroupContentRef customLabelGroupContent />
    <ToolbarToggleGroup labelContainerRef />
  </>
);

toolbar-rename-interfaces (#10649)

The following Toolbar interfaces have been renamed:

Examples

In:

import {
  ToolbarChipGroup,
  ToolbarChipGroupContentProps as CustomGroupContent,
  ToolbarChip,
} from "@patternfly/react-core";

interface MyInterface extends ToolbarChip {}
let typedThing: ToolbarChipGroup;

export {
  ToolbarChipGroup as CustomGroup,
  CustomGroupContent,
  ToolbarChip as CustomThing,
};

Out:

import {
  ToolbarLabelGroup,
  ToolbarLabelGroupContentProps as CustomGroupContent,
  ToolbarLabel,
} from "@patternfly/react-core";

interface MyInterface extends ToolbarLabel {}
let typedThing: ToolbarLabelGroup;

export {
  ToolbarLabelGroup as CustomGroup,
  CustomGroupContent,
  ToolbarLabel as CustomThing,
};

toolbar-replaced-spacer-spaceItems (#10418)

The spacer property has been removed from ToolbarGroup, ToolbarItem, and ToolbarToggleGroup. We recommend instead using our new gap, columnGap, or rowGap properties.

Additionally, the spaceItems property has been removed from ToolbarGroup and ToolbarToggleGroup.

Examples

In:

import {
  ToolbarGroup,
  ToolbarItem,
  ToolbarToggleGroup,
} from "@patternfly/react-core";

export const ToolbarReplacedSpacerSpaceItemsInput = () => (
  <>
    <ToolbarGroup
      spacer={{ default: "spacerNone", md: "spacerSm", lg: "spacerMd" }}
      spaceItems={{
        default: "spaceItemsNone",
        md: "spaceItemsSm",
        lg: "spaceItemsMd",
      }}
    />
    <ToolbarItem
      spacer={{ default: "spacerNone", md: "spacerSm", lg: "spacerMd" }}
    />
    <ToolbarToggleGroup
      spacer={{ default: "spacerNone", md: "spacerSm", lg: "spacerMd" }}
      spaceItems={{
        default: "spaceItemsNone",
        md: "spaceItemsSm",
        lg: "spaceItemsMd",
      }}
    />
  </>
);

Out:

import {
  ToolbarGroup,
  ToolbarItem,
  ToolbarToggleGroup,
} from "@patternfly/react-core";

export const ToolbarReplacedSpacerSpaceItemsInput = () => (
  <>
    <ToolbarGroup
      gap={{ default: "gapNone", md: "gapSm", lg: "gapMd" }}
      
    />
    <ToolbarItem
      gap={{ default: "gapNone", md: "gapSm", lg: "gapMd" }}
    />
    <ToolbarToggleGroup
      gap={{ default: "gapNone", md: "gapSm", lg: "gapMd" }}
      
    />
  </>
);

toolbar-update-align-values (#10366)

The values for the align property on ToolbarGroup and ToolbarItem, and the alignment property on ToolbarToggleGroup, have been updated from "alignLeft" and "alignRight" to "alignStart" and "alignEnd", respectively.

Examples

In:

import {
  ToolbarGroup,
  ToolbarItem,
  ToolbarToggleGroup,
} from "@patternfly/react-core";

export const ToolbarUpdateAlignValuesInput = () => (
  <>
    <ToolbarGroup
      align={{
        default: "alignLeft",
        md: "alignRight",
        lg: "alignLeft",
        xl: "alignRight",
        "2xl": "alignLeft",
      }}
    />
    <ToolbarItem
      align={{
        default: "alignLeft",
        md: "alignRight",
        lg: "alignLeft",
        xl: "alignRight",
        "2xl": "alignLeft",
      }}
    />
    <ToolbarToggleGroup
      alignment={{
        default: "alignLeft",
        md: "alignRight",
        lg: "alignLeft",
        xl: "alignRight",
        "2xl": "alignLeft",
      }}
    />
  </>
);

Out:

import {
  ToolbarGroup,
  ToolbarItem,
  ToolbarToggleGroup,
} from "@patternfly/react-core";

export const ToolbarUpdateAlignValuesInput = () => (
  <>
    <ToolbarGroup
      align={{
        default: "alignStart",
        md: "alignEnd",
        lg: "alignStart",
        xl: "alignEnd",
        "2xl": "alignStart",
      }}
    />
    <ToolbarItem
      align={{
        default: "alignStart",
        md: "alignEnd",
        lg: "alignStart",
        xl: "alignEnd",
        "2xl": "alignStart",
      }}
    />
    <ToolbarToggleGroup
      alignment={{
        default: "alignStart",
        md: "alignEnd",
        lg: "alignStart",
        xl: "alignEnd",
        "2xl": "alignStart",
      }}
    />
  </>
);

treeView-warn-selectable-styling-modifier-removed (#10101)

Selectable styling attribute (pf-m-selectable) has been removed on the list items of the TreeView component. You should update selectors, tests and snapshot tests which are relying on the pf-m-selectable class.

user-feedback-warn-changes (#76)

The internal scss stylesheet that FeedbackModal and its internal components were referencing has been refactored into a css stylesheet. The new Feedback.css file will have to be imported to maintain styling on FeedbackModal, and may be located in the dist (@patternfly/react-user-feedback/dist/esm/Feedback/Feedback.css) or in the src.

wizardFooter-warn-update-markup (#10378)

The default WizardFooter now uses an ActionList wrapped around our Button components, rather than just our Button components.

wizardNavItem-warn-update-markup (#10378)

There is now a wrapper element with class pf-v6-c-wizard__nav-link-main rendered around the nav item content. Additionally, when the nav item has a status of "error" the icon will be rendered before the item content, and the WizardToggle will also now render an error icon.

wizardStep-updated-body-typing (#10637)

The body prop on WizardStep no longer accepts a value of "null".

Examples

In:

import { WizardStep } from "@patternfly/react-core";

export const WizardStepUpdatedBodyTypingInput = () => (
  <WizardStep body={null} />
);

Out:

import { WizardStep } from "@patternfly/react-core";

export const WizardStepUpdatedBodyTypingInput = () => (
  <WizardStep  />
);

Name		Name	Last commit message	Last commit date
Latest commit History 817 Commits
.github		.github
generators		generators
packages		packages
test		test
.gitignore		.gitignore
.gitmodules		.gitmodules
.prettierrc		.prettierrc
CONTRIBUTING.md		CONTRIBUTING.md
README.md		README.md
getPackages.js		getPackages.js
lerna.json		lerna.json
package.json		package.json
plopFile.cjs		plopFile.cjs
tsconfig.base.json		tsconfig.base.json
yarn.lock		yarn.lock

patternfly/pf-codemods

Folders and files

Latest commit

History

Repository files navigation

pf-codemods

Usage

Simple case

Options

Rules

accordionContent-remove-isHidden-prop (#9876)

Examples

accordionItem-warn-update-markup (#9876)

accordionToggle-move-isExpanded-prop (#9876)

Examples

avatar-replace-border-for-isBordered

Examples

banner-replace-variantProp (#9891)

Examples

button-moveIcons-icon-prop (#10663)

Examples

button-rename-isActive (#9934)

Examples

card-remove-various-props (#10056)

Examples

card-updated-clickable-markup (#10859)

Examples

chartsImport-moved (#11091)

Examples

checkbox-radio-replace-isLabelBeforeButton (#10016)

Examples

chip-deprecated (#)

Examples

chip-replace-with-label (#10049)

Examples

colorProps-replaced-colors (#10661)

Examples

componentGroups-logSnippet-rename-leftBorderVariant (react-component-groups/#145)

Examples

component-groups-contentHeader-rename-to-pageHeader (react-component-groups/#313)

Examples

componentGroups-errorState-rename-props (react-component-groups/#145)

Examples

component-groups-invalidObject-rename-props (react-component-groups/#145)

Examples

component-groups-invalidObject-rename-to-missingPage (react-component-groups/#313)

Examples

component-groups-multi-content-card-remove-props (react-component-groups/#145)

Examples

component-groups-notAuthorized-rename-props (react-component-groups/#145)

Examples

component-groups-notAuthorized-rename-to-unauthorizedAccess (react-component-groups/#313)

Examples

component-groups-unavailableContent-bodyText-props-update (react-component-groups/#244)

Examples

component-groups-unavailable-content-rename-props (react-component-groups/#145)

Examples

data-codemods-cleanup

Examples

dataListAction-remove-isPlainButtonAction-prop (#10939)

Examples

dragDrop-deprecated (#10181)

Examples

drawerContent-replace-noBackground-colorVariant (#10211)

Examples

drawer-remove-props (#10036)

Examples

drawerHead-warn-updated-markup (#10036)

drawer-replace-colorVariant-light200 (#10017) (#10036)

Examples

dualListSelector-deprecated (#10359)

Examples

dualListSelectorNext-promoted (#10359)

Examples

emptyStateHeader-move-into-emptyState (#9947)

Examples

emptyState-nonExported-components (#10364)

Examples

formFiledGroupHeaderTitleTextObject-renamed (#10016)

Examples