AngularJS components for PatternFly

This project will provide a set of common AngularJS components for use with the PatternFly reference implementation.

* Web site: https://www.patternfly.org
* API Docs: http://www.patternfly.org/angular-patternfly/#/api
* Build Status: https://travis-ci.org/patternfly/angular-patternfly.svg?branch=master

Getting started

You have to install required software before you're able to use grunt:

* Install Node.js - Find more information on Node.js

Angular Patternfly stays up to date with the Node LTS Release Schedule. If you're using Angular Patternfly downstream, we suggest the use of an actively supported version of Node/NPM, although prior versions of Node may work.

* Install npm - If npm is not already installed with Node.js, you have to install it manually. Find more information on NPM

* Install Grunt globally - Find more information on Grunt
``shell
$ npm install -g grunt-cli
`

* Install npm dependencies with:
`shell
$ npm install
`

You should have your environment ready now.

Angular-PatternFly can now be built with:
`shell
$ npm run build
`

To see all the grunt tasks that are available:
`shell
$ npm run help
`

$3

Note:

1. Add Angular-PatternFly as dependencies for your project and you'll receive all the libraries you'll need:
`shell
$ npm install angular-patternfly --save
`
2. Add the core Patternfly CSS and script includes to your HTML file(s):

Please see: https://github.com/patternfly/patternfly/blob/master/QUICKSTART.md

Alternatively, the minimum you will need:


3. Add the following CSS include to your HTML file(s):

`html


`
4. Add the following script includes to your HTML file(s), adjusting where necessary to pull in only what you need:

`html





`

5. (optional) The 'patternfly.charts' module is not a dependency in the default angular 'patternfly' module.
In order to use patternfly charts you must add it as a dependency in your application:

`javascript
my-app.module.js:

angular.module('myApp', [
'patternfly',
'patternfly.charts'
]);
`

And script includes to your HTML file:
`html



``

6. (optional) The 'patternfly.table' module is not a dependency in the default angular 'patternfly' module.
In order to use pfTableView, you must add 'patternfly.table' as a dependency in your application:

`javascript
my-app.module.js:

angular.module('myApp', [
'patternfly',
'patternfly.table'
]);
`

Add the npm dependency:
`shell
$ npm install angularjs-datatables --save
`

Add the following CSS includes to your HTML file(s):


`html


`
Add the following Javascript includes to your HTML file(s):

`html





`
7. (optional) The 'patternfly.canvas' module is not a dependency in the default angular 'patternfly' module.
In order to use pfCanvasEditor or pfCanvas, you must add 'patternfly.canvas' as a dependency in your application:

`javascript
my-app.module.js:

angular.module('myApp', [
'patternfly',
'patternfly.canvas'
]);
`

Add the npm dependencies:
`shell
$ npm install jquery-ui-dist --save
$ npm install angular-dragdrop --save
$ npm install angular-svg-base-fix --save
`

Add the following Javascript includes to your HTML file(s):

`html







`

Also, the canvas background grid image is located in 'node_modules/angular-patternfly/dist/imgs/canvas-dot-grid.png'
please copy this image to your application's main images directory and reference it by overridding the '.canvas' css
class:

`html

`

#### Less to Sass Conversion

During the build process Less files are converted to Sass files in /dist/sass. Then the Sass files are compiled into /dist/sass/angular-patternfly.css. If you would like to copy the Sass generated css into the main /dist/styles directory, execute:

`
grunt build --sass
`

This task will copy /dist/sass/angular-patternfly.css to /dist/styles/angular-patternfly.css. Then the build process will minimize the css in /dist/styles.

The Less to Sass Conversion step will be accomplished and managed as a part of any Pull Request which includes Less file changes. Although contributors may want to build and test their style changes with Sass before submitting a Pull Request, this step should always be tested and validated by reviewers before a style change is merged and released. If a contributor is having issues with Sass conversion that they cannot resolve, Pull Request reviewers will need to ensure that the Sass conversion step is successfully accomplished, tested, and included in the Pull Request before it is approved and merged.

For more detailed information, please read PatternFly Less to Sass Conversion

Note: When a Less file is added/deleted/renamed it needs to be updated in the main Less import file /styles/angular-patternfly.less and the main Sass import file styles/_angular-patternfly.scss.

$3

In order to use Angular-Patternfly in a Webpack-bundled application there are some things you need to keep in mind:

#### Create an alias for the jQuery module (if using JQuery dependency)

In order to let Webpack find the correct jQuery module when assembling all the dependencies you need to create an alias for it in the webpack.conf.js file:
`
...
resolve: {
alias: {
"jquery": "patternfly/node_modules/jquery"
}
}
...
`

Additionally, you have to use the webpack.ProvidePlugin so the $ and the jQuery variables are added to the window object, making them available to the other modules (Patternfly included):
`
...
plugins: [
new webpack.ProvidePlugin({
$: "jquery",
jQuery: "jquery",
"window.jQuery": "jquery",
"window.jquery": "jquery"
})
]
...
`

API documentation

The API documentation can be built with:
`shell
$ npm run uidocs
`

If you're interested in reading the docs right away, you can use special target, which will start a web server:
`shell
$ npm run uidocs:view
`

After executing this tasks you'll be able to access the documentation at http://localhost:8000/. If a different port is desired, it may be specified on as an option:
`shell
$ npm run uidocs:view -- --port=8002
`

Git Commit Guidelines

PatternFly uses a semantic release process to automate npm and bower package publishing, based on the following commit message format.

Each commit message consists of a header, a body and a footer. The header has a special
format that includes a type, a scope and a subject (full explanation):

`
():