com.vaadin.polymer.iron.IronDocViewerElement Maven / Gradle / Ivy
/*
* This code was generated with Vaadin Web Component GWT API Generator,
* from iron-doc-viewer project by The Polymer Authors
* that is licensed with http://polymer.github.io/LICENSE.txt license.
*/
package com.vaadin.polymer.iron;
import com.vaadin.polymer.elemental.*;
import com.google.gwt.core.client.JavaScriptObject;
import com.google.gwt.core.client.JsArray;
import jsinterop.annotations.JsOverlay;
import jsinterop.annotations.JsProperty;
import jsinterop.annotations.JsType;
/**
* 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.
*/
@JsType(isNative=true)
public interface IronDocViewerElement extends HTMLElement {
@JsOverlay public static final String TAG = "iron-doc-viewer";
@JsOverlay public static final String SRC = "iron-doc-viewer/iron-doc-viewer.html";
/**
* The Hydrolysis-generated
element descriptor to display details for.
* Alternatively, the element descriptor can be provided as JSON via the text content
of this element.
*
* JavaScript Info:
* @property descriptor
* @type hydrolysis.ElementDescriptor
*
*/
@JsProperty JavaScriptObject getDescriptor();
/**
* The Hydrolysis-generated
element descriptor to display details for.
* Alternatively, the element descriptor can be provided as JSON via the text content
of this element.
*
* JavaScript Info:
* @property descriptor
* @type hydrolysis.ElementDescriptor
*
*/
@JsProperty void setDescriptor(JavaScriptObject value);
/**
* Prefix for fragment identifiers used in anchors.
For static routing iron-component-page can
set this to a string identifying the current component.
*
* JavaScript Info:
* @property prefix
* @type String
*
*/
@JsProperty String getPrefix();
/**
* Prefix for fragment identifiers used in anchors.
For static routing iron-component-page can
set this to a string identifying the current component.
*
* JavaScript Info:
* @property prefix
* @type String
*
*/
@JsProperty void setPrefix(String value);
/**
* Scrolls to the currently selected anchor, as identified
by the URL hash. Whichever element or script is in charge
of routing should call this method on initial page load and
on hashchange events.
*
* JavaScript Info:
* @method scrollToAnchor
* @param {} hash
*
*
*/
void scrollToAnchor(Object hash);
}