px-typeahead

WebJar for px-typeahead

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

Download px-typeahead

Filename	Size
px-typeahead-2.1.0.pom
px-typeahead-2.1.0.jar	111 KB
px-typeahead-2.1.0-sources.jar	22 bytes
px-typeahead-2.1.0-javadoc.jar	22 bytes

How to add to project

Apache Maven

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

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.bowergithub.predixdesignsystem/px-typeahead/
implementation 'org.webjars.bowergithub.predixdesignsystem:px-typeahead:2.1.0'

Gradle Kotlin

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

Apache Buildr

'org.webjars.bowergithub.predixdesignsystem:px-typeahead:jar:2.1.0'

Apache Ivy

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

Groovy Grape

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

Scala SBT

libraryDependencies += "org.webjars.bowergithub.predixdesignsystem" % "px-typeahead" % "2.1.0"

Leiningen

[org.webjars.bowergithub.predixdesignsystem/px-typeahead "2.1.0"]

Dependencies

compile (5)

Group / Artifact	Type	Version
org.webjars.bowergithub.predixdesignsystem » px-icon-set	jar	[2.0.0,3)
org.webjars.bowergithub.polymer : polymer	jar	[1.9.0,3)
org.webjars.bowergithub.polymerlabs : promise-polyfill	jar	[2.0.0,3)
org.webjars.bowergithub.polymerelements : iron-resizable-behavior	jar	[2.0.0,3)
org.webjars.bowergithub.polymerelements : iron-ajax	jar	[2.0.0,3)

Project Modules

There are no modules declared in this project.

px-typeahead

Overview

Px-typeahead is a Predix UI component similar to a dropdown which shows possible autocompletion options for a given search term based on a list of possible values.

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

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

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

Finally, use the component in your application:

<px-typeahead max-suggestions="10" local-candidates="{{your-array-of-input-strings}}" placeholder="your-placeholder">
</px-typeahead>

---

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.

Predix Design System

Versions

Version
2.1.0 Apr 23, 2018