Skip to content

evwilkin/patternfly-react

This branch is 27 commits behind patternfly/patternfly-react:main.

Folders and files

NameName
Last commit message
Last commit date
Jan 9, 2025
Jun 25, 2024
Jan 31, 2025
Aug 27, 2024
Mar 11, 2019
Aug 8, 2024
Mar 12, 2019
Apr 19, 2024
Oct 2, 2019
Jun 25, 2024
Jun 25, 2024
Jun 25, 2024
Mar 1, 2019
Jan 6, 2025
Apr 19, 2024
Aug 8, 2024
Nov 8, 2024
Jun 25, 2024
Sep 5, 2024
Feb 5, 2025
Aug 27, 2024
Feb 5, 2025

Repository files navigation

PatternFly React

lerna PatternFly npm badge

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

Package link Description
💙 Core packages
  @patternfly/react-core Core set of components
  @patternfly/react-table Table components
  @patternfly/react-charts Chart components
  @patternfly/react-icons Icon components
  @patternfly/react-styles PatternFly CSS styles
  @patternfly/react-tokens PatternFly CSS variable tokens
💛 Extension packages
  @patternfly/react-log-viewer Virtualized log viewer component
  @patternfly/react-catalog-view-extension Catalog view extension
  @patternfly/react-topology Topology components
📂 Supporting packages
  @patternfly/react-docs Gatsby documentation site for components
  @patternfly/react-integration Cypress integration tests
❌ Deprecated packages
  @patternfly/react-virtualized-extension Table and list row virtualization extension

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.

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
  1. 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.

About

A set of React components for the PatternFly project.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 98.1%
  • JavaScript 1.7%
  • Other 0.2%