px-breadcrumbs

Overview

Px-breadcrumbs displays the navigational path of the user through a context browser.

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-breadcrumbs --save

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

<link rel="import" href="https://github.com/predixdesignsystem/px-breadcrumbs/blob/master/bower_components/px-breadcrumbs/px-breadcrumbs.html"/>

Finally, use the component in your application:

<px-breadcrumbs breadcrumbs-data="[[breadcrumbsData]]"></px-breadcrumbs>

Documentation

Read the full API and view the demo here.

The documentation in this repository is supplemental to the official Predix documentation, which is continuously updated and maintained by the Predix documentation team. Go to http://predix.io to see the official Predix documentation.

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.

GE Coding Style Guide

GE JS Developer's Guide

Known Issues

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