Add element summaries

This commit is contained in:
Kevin Schaaf
2017-02-28 13:57:55 -08:00
parent 54c59937ba
commit c00883ecf8
6 changed files with 23 additions and 6 deletions
+2
View File
@@ -387,6 +387,8 @@ subject to an additional IP rights grant found at http://polymer.github.io/PATEN
* @extends Polymer.Element
* @mixes Polymer.ArraySelectorMixin
* @memberof Polymer
* @summary Custom element that links paths between an input `items` array and
* an output `selected` item or array based on calls to its selection API.
*/
const ArraySelector = class extends ArraySelectorMixin(Polymer.Element) {
// Not needed to find template; can be removed once the analyzer
+2
View File
@@ -33,6 +33,8 @@ subject to an additional IP rights grant found at http://polymer.github.io/PATEN
*
* @extends HTMLElement
* @memberof Polymer
* @summary Custom element for defining styles in the main document that can
* take advantage of Polymer's style scoping and custom properties shims.
*/
class CustomStyle extends HTMLElement {
constructor() {
+2
View File
@@ -30,6 +30,8 @@ subject to an additional IP rights grant found at http://polymer.github.io/PATEN
* @extends HTMLElement
* @mixes Polymer.PropertyEffects
* @memberof Polymer
* @summary Custom element to allow using Polymer's template features (data
* binding, declarative event listeners, etc.) in the main document.
*/
class DomBind extends domBindBase {
+2
View File
@@ -35,6 +35,8 @@ subject to an additional IP rights grant found at http://polymer.github.io/PATEN
* @polymerElement
* @extends Polymer.Element
* @memberof Polymer
* @summary Custom element that conditionally stamps and hides or removes
* template content based on a boolean flag.
*/
class DomIf extends Polymer.Element {
+13 -6
View File
@@ -19,19 +19,26 @@
/**
* The `dom-module` element registers the dom it contains to the name given
* by the module's id attribute. It provides a unified database of dom
* accessible via any dom-module element. Use the `import(id, selector)`
* method to locate dom within this database. For example,
* accessible via its static `import` API.
*
* <dom-module id="foo">
* <img src="stuff.png">
* </dom-module>
* A key use case of `dom-module` is for providing custom element `<template>`s
* via HTML imports that are parsed by the native HTML parser, that can be
* relocated during a bundling pass and still looked up by `id`.
*
* Example:
*
* <dom-module id="foo">
* <img src="stuff.png">
* </dom-module>
*
* Then in code in some other location that cannot access the dom-module above
*
* let img = document.createElement('dom-module').import('foo', 'img');
* let img = document.createElement('dom-module').import('foo', 'img');
*
* @extends HTMLElement
* @memberof Polymer
* @summary Custom element that provides a registry of relocatable DOM content
* by `id` that is agnostic to bundling.
*/
class DomModule extends HTMLElement {
+2
View File
@@ -107,6 +107,8 @@ subject to an additional IP rights grant found at http://polymer.github.io/PATEN
* @polymerElement
* @extends Polymer.Element
* @memberof Polymer
* @summary Custom element for stamping instance of a template bound to
* items in an array.
*/
class DomRepeat extends Polymer.Element {