THIS IS A TEMPORARY FORK OF patternfly-react v3
This is only here until patternfly/patternfly-react#4267 lands
and is released. It sets sideEffects: true
This package provides Core PatternFly React components for PatternFly 3.
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:
npm install 10
npm use 10
This project also requires a Yarn version of >=1.6.0. The latest version can be installed here.
yarn add patternfly-react
or
npm install patternfly-react --save
import { Alert } from 'patternfly-react';
Example with LESS:
@import "~bootstrap/less/variables";
@import "~patternfly/dist/less/variables";
@import "~patternfly-react/dist/less/patternfly-react.less";
As an alernative to consuming the patternfly-react.css
file (found in dist/css
), you can build patternfly-react styles into your css by including the Sass partials from dist/sass
. The partial _patternfly-react.scss
will pull in all the partials required for the patternfly-react components. When using the patternfly-react Sass files, you MUST include bootstrap and patternfly variables and mixins. An example of the required imports can be found in patternfly-react.scss.
yarn build
Note the build scripts for this are located in the root package.json under yarn build
.
Testing is done at the root of this repo. To only run the patternfly-react tests:
yarn test packages/patternfly-react
yarn publish
This project uses React Storybook to test and demo new PaternFly 3React UI components. You can view our current storybook here.
How to use Storybook locally:
yarn install
yarn start