PatternFly React

This project provides a set of React components for the PatternFly project.

Community: PatternFly website | Slack | Medium | Mailing list

Table of contents

1. PatternFly React packages
2. Setup
3. Contribution guidelines
4. License

Using PatternFly 3? Take a look at the PatternFly 3 React component information.

PatternFly React packages

Setup

Before you begin, check out this overview of PatternFly to get familiar with the basic elements of the design system.

Install a package manager

Install a package manager before using the PatternFly libraries.

• Use npm
• Use Yarn

Start with PatternFly React seed

If you want to start with your existing project, skip to Install and configure PatternFly React.

PatternFly React seed is an open source build scaffolding utility. It gives developers a jump-start when creating new projects that will use PatternFly.

1. Fork the project

   • TypeScript: Fork and clone the PatternFly React Seed project.

   • JavaScript: Fork and clone the JavaScript branch of the PatternFly React Seed project.

     For more information about how to fork and clone a repo, view GitHub Help.

2. Install the project

   Follow the steps outlined in the PatternFly React Seed README to install.

Install and configure PatternFly React

• Using npm, run the following command to install:

  npm install @patternfly/react-core --save

  OR

• Using yarn, run the following command to install:

  yarn add @patternfly/react-core

  Once the library is installed, use the specific setup instructions for that library to access the components it contains. These can be found in the readme for each library.

Contribution guidelines

All React contributors must first be PatternFly community contributors. If you're already a PatternFly community contributor, check out the React contribution guidelines to make React contributions.

License

PatternFly React is licensed under the MIT License.

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

6.1.0 (2024-12-16)

Bug Fixes

• Update promote.sh to release 6.1.0 (2b5106f)

6.1.0-prerelease.6 (2024-12-04)

Note: Version bump only for package @patternfly/react-icons

6.1.0-prerelease.5 (2024-11-25)

Note: Version bump only for package @patternfly/react-icons

6.1.0-prerelease.4 (2024-11-20)

Note: Version bump only for package @patternfly/react-icons

6.1.0-prerelease.3 (2024-11-19)

Note: Version bump only for package @patternfly/react-icons

6.1.0-prerelease.2 (2024-11-18)

Bug Fixes

• deps: update dependency tslib to ^2.8.1 (#11222) (7c90e9b)

6.1.0-prerelease.1 (2024-11-13)

Bug Fixes

• CodeEditor: Set default height (#11014) (6ddfc93)

6.1.0-prerelease.0 (2024-10-24)

Note: Version bump only for package @patternfly/react-icons

6.0.0 (2024-10-24)

Note: Version bump only for package @patternfly/react-icons

6.0.0-prerelease.7 (2024-10-02)

Bug Fixes

• Menu toggle: Remove pf-m-action modifier (#11096) (fe6871c)

6.0.0-prerelease.6 (2024-09-26)

Bug Fixes

• datalist: actions wrapper (#10939) (833465f)

6.0.0-prerelease.5 (2024-09-24)

Note: Version bump only for package @patternfly/react-icons

6.0.0-prerelease.4 (2024-09-11)

Note: Version bump only for package @patternfly/react-icons

6.0.0-prerelease.3 (2024-09-10)

Note: Version bump only for package @patternfly/react-icons

6.0.0-prerelease.2 (2024-09-10)

Bug Fixes

• deps: update dependency tslib to ^2.7.0 (#10949) (024b3cc)

6.0.0-prerelease.1 (2024-09-07)

Bug Fixes

• expandable section: update to use <Button> for toggle (#10891) (fd9ce14)

6.0.0-alpha.37 (2024-08-27)

Note: Version bump only for package @patternfly/react-icons

6.0.0-alpha.36 (2024-08-19)

Bug Fixes

• Card: updated markup for actionable cards (#10859) (d58b051)

6.0.0-alpha.35 (2024-08-08)

Note: Version bump only for package @patternfly/react-icons

6.0.0-alpha.34 (2024-07-29)

Bug Fixes

• deps: bump v6 alphas (#10816) (d99aa9b)

6.0.0-alpha.33 (2024-07-29)

Features

• Masthead: Updates for new masthead structure in Penta (#10809) (266ee47)

6.0.0-alpha.32 (2024-07-29)

Features

• MenuToggle: replaced custom styles with text modifier V6 (#10793) (95a204c)

6.0.0-alpha.31 (2024-07-22)

Features

• Page: support page fill (#10760) (850bd46)

6.0.0-alpha.30 (2024-07-15)

Bug Fixes

• Toolbar: updated for parity with Core updates (#10674) (d508325)

6.0.0-alpha.29 (2024-07-03)

Features

• page: support for context selector in sidebar (#10686) (b85fb19)

6.0.0-alpha.28 (2024-07-02)

Features

• Button: add text wrapper, update icon usage (#10663) (eca5878)

6.0.0-alpha.27 (2024-06-26)

Features

• Banner,Label: rename cyan/gold to teal/yellow (#10661) (3e76f17)

6.0.0-alpha.26 (2024-06-25)

Note: Version bump only for package @patternfly/react-icons

6.0.0-alpha.25 (2024-06-25)

Bug Fixes

• docs: fix v6 classname in icons readme (#10575) (52c21a7)

6.0.0-alpha.24 (2024-06-05)

Bug Fixes

• charts: renamed cyan to teal, gold to yellow (#10518) (d407554)

6.0.0-alpha.23 (2024-05-31)

Note: Version bump only for package @patternfly/react-icons

6.0.0-alpha.22 (2024-05-23)

Features

• Toolbar: updated spacer props to gap (#10418) (29578a2)

6.0.0-alpha.21 (2024-05-21)

Features

• misc, TextContent: update core version & text content updates (#10378) (1f1b93c)

6.0.0-alpha.20 (2024-04-22)

Note: Version bump only for package @patternfly/react-icons

5.3.0-prerelease.3 (2024-03-26)

Note: Version bump only for package @patternfly/react-icons

5.3.0-prerelease.2 (2024-03-22)

Note: Version bump only for package @patternfly/react-icons

5.3.0-prerelease.1 (2024-02-28)

Bug Fixes

• deps: bump to latest core (#10116) (dc1aceb)

5.3.0-prerelease.0 (2024-02-02)

5.2.0 (2024-02-02)

Note: Version bump only for package @patternfly/react-icons

5.2.0 (2024-02-02)

Note: Version bump only for package @patternfly/react-icons

5.2.0-prerelease.10 (2024-01-11)

Note: Version bump only for package @patternfly/react-icons

5.2.0-prerelease.9 (2023-12-11)

Note: Version bump only for package @patternfly/react-icons

5.2.0-prerelease.8 (2023-11-14)

Note: Version bump only for package @patternfly/react-icons

5.2.0-prerelease.7 (2023-11-10)

Note: Version bump only for package @patternfly/react-icons

5.2.0-prerelease.6 (2023-11-03)

Note: Version bump only for package @patternfly/react-icons

6.0.0-alpha.19 (2024-04-02)

Note: Version bump only for package @patternfly/react-icons

6.0.0-alpha.18 (2024-03-27)

Features

• Page,Drawer: core bump and updates (#10211) (8210248)

6.0.0-alpha.17 (2024-03-22)

Note: Version bump only for package @patternfly/react-icons

6.0.0-alpha.16 (2024-03-18)

Note: Version bump only for package @patternfly/react-icons

6.0.0-alpha.15 (2024-03-08)

Note: Version bump only for package @patternfly/react-icons

6.0.0-alpha.14 (2024-02-21)

Note: Version bump only for package @patternfly/react-icons

6.0.0-alpha.13 (2024-02-21)

Note: Version bump only for package @patternfly/react-icons

6.0.0-alpha.12 (2024-02-16)

Features

• CodeEditor,Divider: consume penta & update core version (#10081) (addda04)

6.0.0-alpha.11 (2024-01-31)

Features

• Tabs: consumed Penta updates (#10044) (8fdd83e)

6.0.0-alpha.10 (2024-01-26)

Note: Version bump only for package @patternfly/react-icons

6.0.0-alpha.9 (2024-01-22)

Note: Version bump only for package @patternfly/react-icons

6.0.0-alpha.8 (2024-01-18)

Note: Version bump only for package @patternfly/react-icons

6.0.0-alpha.7 (2024-01-16)

Features

• Navigation: Penta updates for nav (#9948) (dba392d)

6.0.0-alpha.6 (2024-01-04)

Note: Version bump only for package @patternfly/react-icons

6.0.0-alpha.5 (2023-12-20)

Note: Version bump only for package @patternfly/react-icons

6.0.0-alpha.4 (2023-12-13)

Note: Version bump only for package @patternfly/react-icons

6.0.0-alpha.3 (2023-12-04)

Note: Version bump only for package @patternfly/react-icons

6.0.0-alpha.2 (2023-11-16)

Reverts

• Revert "Merge remote-tracking branch 'upstream/main' into v6" (#9791) (b7e8065), closes #9791

6.0.0-alpha.1 (2023-09-29)

Bug Fixes

• Release alphas from v6 and rebase from main (#9692) (bb022ff), closes #9651 #9627 #9555 #9543 #9578 #9519 #9603 #9655 #9614 #9606 #9628 #9635 #9649 #9642 #9633 #9637 #9584 #9284

5.1.1-prerelease.7 (2023-09-21)

Note: Version bump only for package @patternfly/react-icons

5.2.0-prerelease.8 (2023-11-14)

Note: Version bump only for package @patternfly/react-icons

5.2.0-prerelease.7 (2023-11-10)

Note: Version bump only for package @patternfly/react-icons

5.2.0-prerelease.6 (2023-11-03)

Note: Version bump only for package @patternfly/react-icons

5.2.0-prerelease.9 (2023-12-11)

Note: Version bump only for package @patternfly/react-icons

5.2.0-prerelease.8 (2023-11-14)

Note: Version bump only for package @patternfly/react-icons

5.2.0-prerelease.7 (2023-11-10)

Note: Version bump only for package @patternfly/react-icons

5.2.0-prerelease.6 (2023-11-03)

Note: Version bump only for package @patternfly/react-icons

5.2.0-prerelease.10 (2024-01-11)

Note: Version bump only for package @patternfly/react-icons

5.2.0-prerelease.9 (2023-12-11)

Note: Version bump only for package @patternfly/react-icons

5.2.0-prerelease.8 (2023-11-14)

Note: Version bump only for package @patternfly/react-icons

5.2.0-prerelease.7 (2023-11-10)

Note: Version bump only for package @patternfly/react-icons

5.2.0-prerelease.6 (2023-11-03)

Note: Version bump only for package @patternfly/react-icons

5.3.0-prerelease.1 (2024-02-28)

Bug Fixes

• deps: bump to latest core (#10116) (dc1aceb)

5.3.0-prerelease.0 (2024-02-02)

5.2.0 (2024-02-02)

Note: Version bump only for package @patternfly/react-icons

5.2.0 (2024-02-02)

Note: Version bump only for package @patternfly/react-icons

5.2.0-prerelease.10 (2024-01-11)

Note: Version bump only for package @patternfly/react-icons

5.2.0-prerelease.9 (2023-12-11)

Note: Version bump only for package @patternfly/react-icons

5.2.0-prerelease.8 (2023-11-14)

Note: Version bump only for package @patternfly/react-icons

5.2.0-prerelease.7 (2023-11-10)

Note: Version bump only for package @patternfly/react-icons

5.2.0-prerelease.6 (2023-11-03)

Note: Version bump only for package @patternfly/react-icons

5.2.0-prerelease.5 (2023-10-27)

Bug Fixes

• react-icons: rename custom icons (#9759) (a7a36e9)

5.2.0-prerelease.4 (2023-10-26)

Note: Version bump only for package @patternfly/react-icons

5.2.0-prerelease.3 (2023-10-10)

Note: Version bump only for package @patternfly/react-icons

5.2.0-prerelease.2 (2023-10-10)

Note: Version bump only for package @patternfly/react-icons

5.2.0-prerelease.1 (2023-10-09)

Note: Version bump only for package @patternfly/react-icons

5.2.0-prerelease.0 (2023-10-05)

Note: Version bump only for package @patternfly/react-icons

5.1.1 (2023-10-05)

Note: Version bump only for package @patternfly/react-icons

5.1.1-prerelease.8 (2023-10-03)

Bug Fixes

• whitespace changes to trigger prereleases (#9702) (741c248)

5.1.1-prerelease.7 (2023-09-21)

Note: Version bump only for package @patternfly/react-icons

5.1.1-prerelease.6 (2023-09-18)

Note: Version bump only for package @patternfly/react-icons

5.1.1-prerelease.5 (2023-09-07)

Note: Version bump only for package @patternfly/react-icons

5.1.1-prerelease.4 (2023-09-06)

Note: Version bump only for package @patternfly/react-icons

5.1.1-prerelease.3 (2023-09-05)

Note: Version bump only for package @patternfly/react-icons

5.1.1-prerelease.2 (2023-08-31)

Note: Version bump only for package @patternfly/react-icons

5.1.1-prerelease.1 (2023-08-29)

5.0.0 (2023-07-27)

Note: Version bump only for package @patternfly/react-icons

5.1.0-prerelease.0 (2023-07-27)

Note: Version bump only for package @patternfly/react-icons

5.0.0 (2023-07-27)

Note: Version bump only for package @patternfly/react-icons

5.0.0-prerelease.9 (2023-07-20)

Note: Version bump only for package @patternfly/react-icons

5.0.0-prerelease.8 (2023-07-06)

Note: Version bump only for package @patternfly/react-icons

5.0.0-prerelease.7 (2023-06-21)

Note: Version bump only for package @patternfly/react-icons

5.0.0-prerelease.6 (2023-06-15)

Note: Version bump only for package @patternfly/react-icons

5.0.0-prerelease.5 (2023-06-15)

Bug Fixes

• release: ensure component package.json file has correct data (#9272) (6053a6f)

5.0.0-prerelease.4 (2023-06-13)

Bug Fixes

• docs: update use of deprecated tag and clean up changelogs (#9259) (8de83dc)

5.0.0-prerelease.3 (2023-06-12)

Bug Fixes

• react-icons: Added fallback width and height attributes to icons (#9257) (5c782ba)

5.0.0-prerelease.2 (2023-06-06)

Bug Fixes

• versions: bump core and fix demo-app versions (#9248) (d19f9d2)

5.0.0-prerelease.1 (2023-06-06)

Bug Fixes

• release: dryrun publishing prereleases (#9242) (e4c35f1)

5.0.0-alpha.21 (2023-06-02)

Note: Version bump only for package @patternfly/react-icons

5.0.0-alpha.20 (2023-05-31)

Note: Version bump only for package @patternfly/react-icons

5.0.0-alpha.19 (2023-05-19)

Note: Version bump only for package @patternfly/react-icons

5.0.0-alpha.18 (2023-05-18)

Features

• Flex: add plain gap spacing (#9143) (eceb265)

5.0.0-alpha.17 (2023-05-18)

Features

• Table: added class names for table elements (#9133) (51d6d2b)

5.0.0-alpha.16 (2023-05-18)

Features

• FormControls: updated logic for rendering icons (#9132) (9f4863f)

5.0.0-alpha.15 (2023-05-16)

Note: Version bump only for package @patternfly/react-icons

5.0.0-alpha.14 (2023-05-05)

Bug Fixes

• deps: updated Core for v5 versioning (#9075) (3879fc7)

5.0.0-alpha.13 (2023-05-05)

Note: Version bump only for package @patternfly/react-icons

5.0.0-alpha.12 (2023-04-27)

Bug Fixes

• createIcon: Spread className to svg to fix broken images (#8954) (8073115)

5.0.0-alpha.11 (2023-04-25)

Bug Fixes

• bump dependencies and remove ssl option (#8984) (f8f77d2)

5.0.0-alpha.10 (2023-04-11)

Bug Fixes

• icons: fixed pficons naming overrides (#8932) (1c9c9cb)

5.0.0-alpha.9 (2023-04-06)

Note: Version bump only for package @patternfly/react-icons

5.0.0-alpha.8 (2023-04-03)

Note: Version bump only for package @patternfly/react-icons

5.0.0-alpha.7 (2023-03-27)

Note: Version bump only for package @patternfly/react-icons

5.0.0-alpha.6 (2023-03-18)

Note: Version bump only for package @patternfly/react-icons

5.0.0-alpha.5 (2023-03-17)

Note: Version bump only for package @patternfly/react-icons

5.0.0-alpha.4 (2023-03-02)

Bug Fixes

• core: update core to alpha.24 (#8768) (6dd5e01)

5.0.0-alpha.3 (2023-02-15)

Bug Fixes

• deps: updated to the latest core alpha (#8688) (5f81928)

5.0.0-alpha.2 (2023-02-08)