Develop with PatternFly

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

Before you begin, install a package manager:

• Use npm
• Use Yarn

Get started with:

• React
• HTML/CSS

The React library provides a collection of React components you can use to build interfaces with consistent markup, styling, and behavior.

• Start with a sample project

  Start with the PatternFly React seed, which is an open source build scaffolding utility created to give developers a jump start when creating new projects that will use PatternFly.

• Start with your existing project

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

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 README to install.

• 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

PatternFly React is composed of a number of React implementations published in the following npm packages:

• @patternfly/react-core - This packages provides most of the React core components
• @patternfly/react-charts - This package provides PatternFly charting components.
• @patternfly/react-code-editors - This package provides a PatternFly wrapper for the Monaco code editor.
• @patternfly/react-icons - This package provides PatternFly icons as React components.
• @patternfly/react-styles - This package provides CSS-in-JS capabilities .
• @patternfly/react-table - This package provides table PatternFly components.
• @patternfly/react-tokens - This package provides all CSS tokens and values as JavaScript objects.

These PatternFly React packages are maintained together. To determine which versions of each package are compatible with the rest, view our release highlights.

Configurations

• TypeScript
• Webpack
• Jest
• Editor

The HTML/CSS library provides a collection of code samples you can use to build interfaces with consistent PatternFly markup and styling.

Using npm, run the following commands to install:

npm install @patternfly/patternfly --save

What’s included?

Each of the three modules (layouts, components, and utilities) delivers a Sass file (.scss) and CSS file, so you can include them in your build environment or consume the CSS from your page header.

If you need to overwrite any elements, we recommend extending the variables found in the .scss files, rather than manually overwriting the CSS.

When you install PatternFly, the package includes:

• A single file for the entire compiled library: node_modules/@patternfly/patternfly/patternfly.css
• Individual files with each component compiled separately: node_modules/@patternfly/patternfly/<ComponentName>/styles.css
• A single file for the entire library's source (Sass): node_modules/@patternfly/patternfly/patternfly.scss
• Individual files for each component's source (Sass): node_modules/@patternfly/patternfly/<ComponentName>/styles.scss

Use these files to consume the library. The recommended consumption approach will vary from project to project.

1. Navigate to the patternfly package you just installed and find the PatternFly CSS stylesheet, patternfly.css

2. Copy patternfly.css to your project's CSS directory.

3. In your HTML file, add the following line to the bottom of your list of CSS files to link to your new stylesheet:

   <link rel="stylesheet" href="css/patternfly.css">

   This will ensure that PatternFly styles take precedence over anything that currently resides in your application.

4. If you want to use PatternFly utilities in your project, find the utilities file, patternfly-addons.css

5. Copy patternfly-addons.css into your project’s CSS directory.

6. In your HTML file, add the following line to the bottom of your list of CSS files:

   <link rel="stylesheet" href="css/patternfly-addons.css">

Typography

PatternFly uses the Red Hat font family. By default, Red Hat fonts are included as part of the PatternFly distributed CSS file. You do not need to do anything with your configuration to use this font family.

The official documentation for the Red Hat font family can be found at the RedHatOfficial/RedHatFont repo. For additional guidelines on typography implementation in PatternFly see the PatternFly typography guidelines.

Icons

PatternFly uses Font Awesome 5. Font Awesome 5 can be utilized in two different ways:

• Built into PatternFly

  By default, Font Awesome is included as part of the PatternFly distributed CSS file. You do not need to do anything with your configuration to use this icon font family.

• Used as a CDN

  If you wish to use the CDN for Font Awesome 5 rather than the default approach, you need to update the sass-utilities/scss-variables.scss file (from source node_modules/@patternfly/patternfly/) and build PatternFly as part of your build process.

  To use the CDN vs the standard build, update the sass-utilities/scss-variables.scss file as follows:

  $pf-v5-global--enable-fontawesome-cdn: true !default;

The CSS variable system enables you to easily customize things like color or shape without overwriting existing PatternFly styles.

Learn more and view CSS variables

Many PatternFly components comply with the Open UI Automation (OUIA) guidelines, which are designed to ease the burden of creating and maintaining automated testing environments. Additional details about Open UI Automation and the full list of compliant components can be found on the Open UI Automation page.