katemenkhaus / iron-doc-viewer

Polymer documentation viewer elements

Demo and API docs

##<iron-doc-viewer>

Renders documentation describing an element's API.

iron-doc-viewer renders element and behavior descriptions as extracted by Hydrolysis. You can provide them either via binding...

<iron-doc-viewer descriptor="{{elementDescriptor}}"></iron-doc-viewer>

...or by placing the element descriptor in JSON as the text content of an iron-doc-viewer:

<iron-doc-viewer>
  {
    "is": "awesome-sauce",
    "properties": [
      {"name": "isAwesome", "type": "boolean", "desc": "Is it awesome?"},
    ]
  }
</iron-doc-viewer>

However, be aware that due to current limitations in Polymer 0.8, changes to the text content will not be respected, only the initial value will be loaded. If you wish to update the documented element, please set it via the descriptor property.

##<iron-doc-property>

Renders documentation describing a specific property of an element.

Give it a hydrolysis PropertyDescriptor (via descriptor), and watch it go!