Skip to content

predixdesignsystem/px-icon-set

 
 

Repository files navigation

px-icon-set Build Status

Overview

Px-icon-set is a wrapper for the Predix icon set which leverages px-icon (a subcomponent of px-icon-set).

Usage

Prerequisites

  1. node.js
  2. npm
  3. bower
  4. webcomponents-lite.js polyfill

Node, npm and bower are necessary to install the component and dependencies. webcomponents.js adds support for web components and custom elements to your application.

Getting Started

First, install the component via bower on the command line:

bower install px-icon-set --save

Second, import the component in your application with the following tag in your head:

<link rel="import" href="/bower_components/px-icon-set/px-icon-set.html"/>

Finally, use the component in your application:

<iron-icon icon="px-fea:analytics"></iron-icon>


Documentation

Read the full API and view the demo here.

Local Development

From the component's directory...

$ npm install
$ bower install
$ gulp sass

From the component's directory, to start a local server run:

$ gulp serve

Navigate to the root of that server (e.g. http://localhost:8080/) in a browser to open the API documentation page, with link to the "Demo" / working examples.

GE Coding Style Guide

GE JS Developer's Guide



Known Issues

Please use Github Issues to submit any bugs you might find.

Packages

No packages published

Languages

  • HTML 83.4%
  • JavaScript 13.3%
  • Shell 3.3%