#Px-Typeahead
A typeahead functionality using polymer, vanilla javascript , px-inuit-styling , e2e tests written using web-component-tester, mocha and chai
px-typeahead is a Predix UI component. It offers search capability with user input among all possible suggestions as part of the input array and lists all the suggestions which has the input and show all the possibilities upto the max-suggestions listed as part of declaration.
- node.js
- npm
- bower
- 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.
First, install the component via bower on the command line.
bower install px-typeahead --save
Second, import the component to 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>
For more - read documentation section below
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.
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.
Please use Github Issues to submit any bugs you might find.