npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

angular-patternfly-sass

v3.23.2

Published

Angular extension of the PatternFly project. (patternfly-sass compatible)

Downloads

9

Readme

Build Status Dependency Status Code Climate

Join the chat at https://gitter.im/patternfly/angular-patternfly

AngularJS directives for PatternFly

This project will provide a set of common AngularJS directives 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 Bower globally - Find more information on Bower

      npm install -g bower
  • Install Grunt globally - Find more information on Grunt

      npm install -g grunt-cli
  • Install npm dependencies with:

      npm install
  • Install bower dependencies with:

      bower install

You should have your environment ready now.

Angular-PatternFly can now be built with:

grunt build

To see all the grunt tasks that are available:

grunt help

Using Angular-PatternFly In Your Application

Note:

  1. Add Angular and Angular-PatternFly as dependencies for your project and you'll receive all the libraries you'll need:

     $ bower install angular --save
     $ bower 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
  3. Add the following CSS include to your HTML file(s):

     <!-- Angular-PatternFly Styles -->
     <link rel="stylesheet" href="bower_components/angular-patternfly/dist/styles/angular-patternfly.min.css" />
  4. Add the following script includes to your HTML file(s), adjusting where necessary to pull in only what you need:

     <!-- Angular -->
     <script src="bower_components/angular/angular.min.js"></script>
    
     <!-- Angular-Bootstrap -->
     <script src="bower_components/angular-bootstrap/ui-bootstrap.min.js"></script>
     <script src="bower_components/angular-bootstrap/ui-bootstrap-tpls.min.js"></script>
    
     <!-- Angular-Sanitize -->
     <script src="bower_components/angular-sanitize/angular-sanitize.min.js"></script>
    
     <!-- Angular-PatternFly  -->
     <script src="bower_components/angular-patternfly/dist/angular-patternfly.min.js"></script>
    
     <!-- C3, D3 - Charting Libraries. Only required if you are using the 'patternfly.charts' module-->
     <script src="bower_components/patternfly/components/c3/c3.min.js"></script>
     <script src="bower_components/patternfly/components/d3/d3.min.js"></script>
  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 'patternfly.charts' as a dependency in your application:

     my-app.module.js:
    
     angular.module('myApp', [
       'patternfly',
       'patternfly.charts'
     ]);

Using with Webpack

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

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": "angular-patternfly/node_modules/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:

grunt ngdocs

If you're interested in reading the docs right away, you can use special target, which will start a web server:

grunt ngdocs: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:

grunt ngdocs:view --port=8002

Releasing

Angular PatternFly is released through Bower. To release a new version version of Angular 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 patternfly reference version listed in bower.json by editing the file and changing the line below. Angular patternfly has a dependency on the patternfly reference implementation so the major and minor version numbers of the two project should be the same:

"patternfly": "<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 -m "Version bump to <new_version>"

Publish a new set of release notes with new version as the tag version: https://github.com/patternfly/angular-patternfly/releases/new

Contributing

We're always interested in contributions from the community.

Please ensure that your PR provides the following:

  • Detailed description of the proposed changes
  • Follows the style rules for javascript and html.
  • Rebased onto the latest master commit