JarCasting
JarCasting JarCasting

px-app-helpers

WebJar for px-app-helpers

License

License

BSD 3-Clause
GroupId

GroupId

org.webjars.bowergithub.predixdesignsystem
ArtifactId

ArtifactId

px-app-helpers
Last Version

Last Version

2.1.9
Release Date

Release Date
Type

Type

jar
Description

Description

px-app-helpers
WebJar for px-app-helpers
Project URL

Project URL

http://webjars.org
Source Code Management

Source Code Management

https://github.com/predixdesignsystem/px-app-helpers

Download px-app-helpers

Filename Size
px-app-helpers-2.1.9.pom
px-app-helpers-2.1.9.jar 171 KB
px-app-helpers-2.1.9-sources.jar 22 bytes
px-app-helpers-2.1.9-javadoc.jar 22 bytes
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.bowergithub.predixdesignsystem/px-app-helpers/ -->
<dependency>
    <groupId>org.webjars.bowergithub.predixdesignsystem</groupId>
    <artifactId>px-app-helpers</artifactId>
    <version>2.1.9</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.bowergithub.predixdesignsystem/px-app-helpers/
implementation 'org.webjars.bowergithub.predixdesignsystem:px-app-helpers:2.1.9'
// https://jarcasting.com/artifacts/org.webjars.bowergithub.predixdesignsystem/px-app-helpers/
implementation ("org.webjars.bowergithub.predixdesignsystem:px-app-helpers:2.1.9")
'org.webjars.bowergithub.predixdesignsystem:px-app-helpers:jar:2.1.9'
<dependency org="org.webjars.bowergithub.predixdesignsystem" name="px-app-helpers" rev="2.1.9">
  <artifact name="px-app-helpers" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.bowergithub.predixdesignsystem', module='px-app-helpers', version='2.1.9')
)
libraryDependencies += "org.webjars.bowergithub.predixdesignsystem" % "px-app-helpers" % "2.1.9"
[org.webjars.bowergithub.predixdesignsystem/px-app-helpers "2.1.9"]

Dependencies

compile (5)

Group / Artifact Type Version
org.webjars.bowergithub.predixdesignsystem : px-branding-bar jar [1.0.0,2)
org.webjars.bowergithub.predixdesignsystem : px-app-nav jar [2.0.0,3)
org.webjars.bowergithub.polymerelements : app-layout jar [2.0.0,3)
org.webjars.bowergithub.predixdesignsystem » px-theme jar [3.0.0,4)
org.webjars.bowergithub.polymer : polymer jar [1.9.0,3)

Project Modules

There are no modules declared in this project.

px-app-helpers

Overview

px-app-helpers is a repository containing components and behaviors that are useful for creating an application using Predix UI. The app-header component provides a container and scroll behavior for pinning a navigation and branding bar to the top of an application. The asset graph, activatable, and selectable behaviors all help to create and interact with an asset model within an application, and is used by the context browser, tree, and breadcrumbs components.

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-app-helpers --save

Second, import any of the included components to your application with one of the following tags in your head.

<link rel="import" href="/bower_components/px-app-helpers/px-app-header/px-app-header.html"/>
<link rel="import" href="/bower_components/px-app-helpers/px-app-asset/px-app-asset-behavior-selectable.html"/>
<link rel="import" href="/bower_components/px-app-helpers/px-app-asset/px-app-asset-behavior-activatable.html"/>
<link rel="import" href="/bower_components/px-app-helpers/px-app-asset/px-app-asset-behavior-graph.html"/>

Finally, use the components in your application:

<px-app-header>
  <px-app-nav slot="app-nav" items="..."></px-app-nav>
</px-app-header>

and/or:

behaviors: [
  PxAppBehavior.AssetGraph,
  PxAppBehavior.AssetSelectable,
  PxAppBehavior.AssetActivatable
],

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, 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.

org.webjars.bowergithub.predixdesignsystem

Predix Design System

Versions

Version
2.1.9
2.0.0
1.4.3