Px-api-viewer is a Predix UI component which uses Hydrolysis and iron-doc-viewer to create API docs on the fly from a requested component.
You need to pass the source attribute to the component - this attribute should hold the name of the component you'd like the API created for.
Example:
<px-api-viewer source="px-dropdown"></px-api-viewer>
- 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-api-viewer --save
Second, import the component to your application with the following tag in your head.
<link rel="import" href="/bower_components/px-api-viewer/px-api-viewer.html"/>
Finally, use the component in your application:
<px-api-viewer source="px-dropdown"></px-api-viewer>
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.