This package provides Core PatternFly components for the PatternFly 4.
This project currently supports Node Active LTS releases. Please stay current with Node Active LTS when developing patternfly-react.
For example, to develop with Node 8, use the following:
nvm install 8 nvm use 8
This project also requires a Yarn version of >=1.6.0. The latest version can be installed here.
yarn add @patternfly/react-core
npm install @patternfly/react-core --save
It's strongly advised to use the PatternFly Base CSS in your whole project, or some components may diverge in appearance:
Example Component Usage
All css related to each component is provided within it. There is no component level CSS to import.
This project uses Gatsby. For an overview of the project structure please refer to the Gatsby documentation - Building with Components.
A comprehensive list of components and detailed usage of each can be found on the PatternFly React Docs website You can also find how each component is meant to be used from a design perspective on the PatternFly 4 Core website.
Note: All commands below assume you are on the root directory in this repository.
Run to install all the dependencies
yarn install && yarn build
To start the site locally.
To build the site.
This library makes use of the babel plugin from @patternfly/react-styles to enable providing the CSS alongside the components. This removes the need for consumers to use (style|css|sass)-loaders. For an example of using CSS from core you can reference Button.js. For any CSS not provided by core please use the
StyleSheet.create utility from @patternfly/react-styles. This will prevent collisions with any consumers, and allow the CSS to be bundled with the component.
Note the build scripts for this are located in the root package.json under
Testing is done at the root of this repo. To only run the patternfly-react tests:
yarn test packages/patternfly-4/react-core