px-overlay

WebJar for px-overlay

License	BSD 3-Clause
GroupId	org.webjars.bowergithub.predixdesignsystem
ArtifactId	px-overlay
Last Version	2.0.5
Release Date	Apr 22, 2018
Type	jar
Description	px-overlay WebJar for px-overlay
Project URL	http://webjars.org
Source Code Management	https://github.com/predixdesignsystem/px-overlay

Download px-overlay

Filename	Size
px-overlay-2.0.5.pom
px-overlay-2.0.5.jar	236 KB
px-overlay-2.0.5-sources.jar	22 bytes
px-overlay-2.0.5-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.bowergithub.predixdesignsystem/px-overlay/ -->
<dependency>
    <groupId>org.webjars.bowergithub.predixdesignsystem</groupId>
    <artifactId>px-overlay</artifactId>
    <version>2.0.5</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.bowergithub.predixdesignsystem/px-overlay/
implementation 'org.webjars.bowergithub.predixdesignsystem:px-overlay:2.0.5'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.bowergithub.predixdesignsystem/px-overlay/
implementation ("org.webjars.bowergithub.predixdesignsystem:px-overlay:2.0.5")

Apache Buildr

'org.webjars.bowergithub.predixdesignsystem:px-overlay:jar:2.0.5'

Apache Ivy

<dependency org="org.webjars.bowergithub.predixdesignsystem" name="px-overlay" rev="2.0.5">
  <artifact name="px-overlay" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.bowergithub.predixdesignsystem', module='px-overlay', version='2.0.5')
)

Scala SBT

libraryDependencies += "org.webjars.bowergithub.predixdesignsystem" % "px-overlay" % "2.0.5"

Leiningen

[org.webjars.bowergithub.predixdesignsystem/px-overlay "2.0.5"]

Dependencies

compile (2)

Group / Artifact	Type	Version
org.webjars.bowergithub.polymer : polymer	jar	[1.9.0,3)
org.webjars.bowergithub.predixdesignsystem » px-theme	jar	[3.0.0,4)

Project Modules

There are no modules declared in this project.

px-overlay

Overview

Px-overlay is a Predix UI component which defines a full viewport overlay element. It has two types, a light version and a dark version.

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

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

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

Finally, use the component in your application:

<px-overlay type="dark"></px-overlay>

---

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.

LiveReload

By default gulp serve is configured to enable LiveReload and will be watching for modifications in your root directory as well as /css.

GE Coding Style Guide

GE JS Developer's Guide

---

Known Issues

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

Predix Design System

Versions

Version
2.0.5 Apr 22, 2018