Skip to content

Latest commit

 

History

History
56 lines (40 loc) · 2.66 KB

README.md

File metadata and controls

56 lines (40 loc) · 2.66 KB

PatternFly 3 React

lerna PatternFly 3 npm badge CodeCov

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

Community: PatternFly website | Slack | Medium | Mailing list

Table of contents

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

PatternFly 3 React packages

Package link Description
💙 Core packages
  patternfly-react Core set of components
  patternfly-react-extensions Extensions
  patternfly-react-wooden-tree Wooden tree view
  react-console Console

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.

Install and configure PatternFly React

  • Using npm, run the following command to install:

    npm install patternfly-react --save
    

    OR

  • Using yarn, run the following command to install:

    yarn add patternfly-react
    

    Once the library is installed, use the specific setup instructions for that library to access the components it contains.

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.