PatternFly reference implementation
This reference implementation of PatternFly is based on Bootstrap v3. Think of PatternFly as a "skinned" version of Bootstrap with additional components and customizations. For information on how to quickly get started using PatternFly, see the Quick Start Guide.
PatternFly can be installed and managed through Bower. To do so, either add patternfly as a dependency in your bower.json or run the following:
bower install patternfly
Are you using Wiredep? PatternFly's CSS includes the CSS of its dependencies. As a result, you'll want to add the following to your Wiredep configuration so you don't end up with duplicate CSS.
exclude: [
"bower_components/bootstrap-combobox/css/bootstrap-combobox.css",
"bower_components/bootstrap-datepicker/dist/css/bootstrap-datepicker.css",
"bower_components/bootstrap-datepicker/dist/css/bootstrap-datepicker3.css",
"bower_components/bootstrap-select/dist/css/bootstrap-select.css",
"bower_components/bootstrap-switch/dist/css/bootstrap3/bootstrap-switch.css",
"bower_components/bootstrap-treeview/dist/bootstrap-treeview.min.css",
"bower_components/c3/c3.css",
"bower_components/datatables/media/css/jquery.dataTables.css",
"bower_components/datatables-colreorder/css/dataTables.colReorder.css",
"bower_components/datatables-colvis/css/dataTables.colVis.css",
"bower_components/eonasdan-bootstrap-datetimepicker/build/css/bootstrap-datetimepicker.min.css",
"bower_components/font-awesome/css/font-awesome.css",
"bower_components/google-code-prettify/bin/prettify.min.css"
],
PatternFly can be installed and managed through npm. To do so, run the following:
npm install patternfly
A Sass port of PatternFly is available, as is a Sass-based Rails Gem.
A set of common AngularJS directives for use with PatternFly is available.
PatternFly includes a number of dependencies that are not committed to this repository. To add them, see "Install Bower Components". And make sure you keep them updated (see "Keeping Bower Components Updated").
Development setup requires nodejs and Ruby. If you do not already have nodejs, npm, and Ruby installed on your system, see https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager and https://www.ruby-lang.org/en/downloads.
After ensuring nodejs and npm are available, install Bower globally:
npm install -g bower
Now that Bower is available, we can install the required development components:
bower install
At this point, you should now have a top level components/ folder with all dependencies listed in the bower.json file installed. Unless you plan to contribute to PatternFly itself, you're done. Celebrate by working on integrating PatternFly and its dependencies in your app!
Anytime you pull a new version of PatternFly, make sure you also run
bower update
so you get the latest version of the components specified in bower.json.
The development includes the use of a number of helpful tasks. In order to setup your development environment to allow running of these tasks, you need to install the local nodejs packages declared in package.json. To do this run:
npm install
This will install all necessary development packages into node_modules/. At this point, the gruntjs tasks are available for use such as starting a local development server or building the master CSS file.
Additionally you may need to install the grunt command line utility. To do this run:
npm install -g grunt-cli
Test pages are generated using Jekyll. Ensure Ruby is installed and available then run:
gem install jekyll -v 3.1.6
Note: You can use any 3.1.x version with at least 3.1.4 (3.1.4 includes necessary fixes to #4433 and #4442)
A local development server can be quickly fired up by using the Gruntjs server task:
grunt server
This local static asset server (i.e., http://localhost:9000) has the advantage of having livereload integration. Thus, if you start the Gruntjs server, any changes you make to .html or .less files will be automatically reloaded into your browser and the changes reflected almost immediately. This has the obvious benefit of not having to refresh your browser and still be able to see the changes as you add or remove them from your development files. Additionally, any changes made to Jekyll source files (tests\pages/) will trigger a Jekyll build.
See http://codeguide.patternfly.org/.
In development, styling is written and managed through multiple lesscss files. In order to generate a CSS file of all styling, run the build Gruntjs task:
grunt build
This task will compile and minify the lesscss files into CSS files located at dist/css/patternfly.min.css and dist/css/patternfly-additional.min.css.
PatternFlyIcons font is generated using IcoMoon. Go to manage projects and import the project PatternFlyIcons-webfont.json. Load it and update as necessary. When finished, return to manage projects, and download the updated PatternFlyIcons-webfont.json file. Also generate the fonts. Please commit the updated PatternFlyIcons-webfont.json file, the updated font files and supporting LESS/CSS changes.
For detailed instructions, please see our PatternFly Icon Guide
The tests/ directory contains HTML pages with component and pattern examples in order to facilitate development. Please consult the official documentation (see below) for full details on how to use PatternFly.
The HTML pages in dist/tests are generated using Jekyll. Do not edit these files directly. See tests/pages to change these files.
Unit tests are written for [Karma test server] (https://karma-runner.github.io/1.0/index.html) with Jasmine
grunt karma
PatternFly is released through the Bower and npm.
To release a new version version of PatternFly, edit bower.json and package.json accordingly.
Update the version listed in bower.json by editing the file and changing the line:
"version": "<new_version>"
Update the version listed in package.json by editing the file and changing the line:
"version": "<new_version>"
Commit the version bump:
git commit -a -m "Version bump to <new_version>"
Tag and push upstream (assuming you have commit access):
git tag <new_version>
git push && git push --tags
The Bower package manager determines available versions and installs based upon git tags, so the new version will now be automatically available via Bower.
To publish a new version to npm, execute:
npm publish
See https://www.patternfly.org and http://getbootstrap.com/.
Since PatternFly is based on Bootstrap, PatternFly supports the same browsers as Bootstrap excluding Internet Explorer 8, plus the latest version of Firefox for Linux.
Important: starting with the v2.0.0 release, PatternFly no longer supports Internet Explorer 8.
See https://patternfly.atlassian.net/secure/RapidBoard.jspa?projectKey=PTNFLY&rapidView=4&view=planning.
Official tracking of bugs occurs in Jira. See https://patternfly.atlassian.net/issues/?filter=10300
Modifications to Bootstrap are copyright 2013 Red Hat, Inc. and licensed under the Apache License 2.0.