spincycle
Version:
A reactive message router and object manager that lets clients subscribe to object property changes on the server
60 lines (37 loc) • 1.68 kB
Markdown
<!---
This README is automatically generated from the comments in these files:
iron-doc-property.html iron-doc-viewer.html
Edit those files, and our readme bot will duplicate them over here!
Edit this file, and the bot will squash your changes :)
The bot does some handling of markdown. Please file a bug if it does the wrong
thing! https://github.com/PolymerLabs/tedium/issues
-->
[](https://travis-ci.org/PolymerElements/iron-doc-viewer)
_[Demo and API docs](https://elements.polymer-project.org/elements/iron-doc-viewer)_
##<iron-doc-viewer>
Renders documentation describing an element's API.
`iron-doc-viewer` renders element and behavior descriptions as extracted by
[Hydrolysis](https://github.com/PolymerLabs/hydrolysis). You can provide them
either via binding...
```html
<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`:
```javascript
<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!