Created
April 22, 2016 02:14
-
-
Save kriscooke/c40ba6833635f9b7b284aadda7d42a90 to your computer and use it in GitHub Desktop.
Example hydrolysis descriptor of a paper-dialog element
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| "{"type":"element","desc":"\nMaterial design: [Dialogs](https://www.google.com/design/spec/components/dialogs.html)\n\n`<paper-dialog>` is a dialog with Material Design styling and optional animations when it is\nopened or closed. It provides styles for a header, content area, and an action area for buttons.\nYou can use the `<paper-dialog-scrollable>` element (in its own repository) if you need a scrolling\ncontent area. See `Polymer.PaperDialogBehavior` for specifics.\n\nFor example, the following code implements a dialog with a header, scrolling content area and\nbuttons.\n\n <paper-dialog>\n <h2>Header</h2>\n <paper-dialog-scrollable>\n Lorem ipsum...\n </paper-dialog-scrollable>\n <div class=\"buttons\">\n <paper-button dialog-dismiss>Cancel</paper-button>\n <paper-button dialog-confirm>Accept</paper-button>\n </div>\n </paper-dialog>\n\n### Styling\n\nSee the docs for `Polymer.PaperDialogBehavior` for the custom properties available for styling\nthis element.\n\n### Animations\n\nSet the `entry-animation` and/or `exit-animation` attributes to add an animation when the dialog\nis opened or closed. See the documentation in\n[PolymerElements/neon-animation](https://github.com/PolymerElements/neon-animation) for more info.\n\nFor example:\n\n <link rel=\"import\" href=\"components/neon-animation/animations/scale-up-animation.html\">\n <link rel=\"import\" href=\"components/neon-animation/animations/fade-out-animation.html\">\n\n <paper-dialog entry-animation=\"scale-up-animation\"\n exit-animation=\"fade-out-animation\">\n <h2>Header</h2>\n <div>Dialog body</div>\n </paper-dialog>\n\n### Accessibility\n\nSee the docs for `Polymer.PaperDialogBehavior` for accessibility features implemented by this\nelement.\n\n","events":[{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"iron-overlay-canceled","params":[{"type":"Event","desc":"The closing of the `iron-overlay` can be prevented\nby calling `event.preventDefault()`. The `event.detail` is the original event that originated\nthe canceling (e.g. ESC keyboard event or click event outside the `iron-overlay`).","name":"event"}]},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"iron-overlay-closed","params":[{"type":"{canceled: (boolean|undefined)}","desc":"Contains `canceled` (whether the overlay was canceled).","name":"closingReason"}]},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"iron-overlay-opened","params":[]}],"properties":[{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"alwaysOnTop","type":"Boolean","desc":"\nSet to true to keep overlay always on top.\n ","published":true},{"__fromBehavior":"Polymer.NeonAnimatableBehavior","name":"animationConfig","type":"Object","desc":"\nAnimation configuration. See README for more info.\n ","published":true},{"__fromBehavior":"Polymer.IronResizableBehavior","name":"assignParentResizable","type":"Function","desc":"\nUsed to assign the closest resizable ancestor to this resizable\nif the ancestor detects a request for notifications.\n ","params":[{"name":"parentResizable"}],"function":true},{"__fromBehavior":"Polymer.IronFitBehavior","name":"autoFitOnAttach","type":"Boolean","desc":"\nSet to true to auto-fit on attach.\n ","published":true,"default":false},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"backdropElement","type":"Element","desc":"\nThe backdrop element.\n"},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"cancel","type":"Function","desc":"\nCancels the overlay.\n","params":[{"name":"event","type":"Event=","desc":"The original event"}],"function":true},{"__fromBehavior":"Polymer.NeonAnimationRunnerBehavior","name":"cancelAnimation","type":"Function","desc":"\nCancels the currently running animation.\n ","params":[],"function":true},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"canceled","type":"Boolean","desc":"\nTrue if the overlay was canceled when it was last closed.\n ","published":true,"observer":"_canceledChanged","observerNode":{"type":"Literal","value":"_canceledChanged","raw":"'_canceledChanged'","range":[2185,2203],"loc":{"start":{"line":60,"column":18},"end":{"line":60,"column":36}}},"readOnly":true,"default":false},{"__fromBehavior":"Polymer.IronFitBehavior","name":"center","type":"Function","desc":"\nCenters horizontally and vertically if not already positioned. This also sets\n`position:fixed`.\n ","params":[],"function":true},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"close","type":"Function","desc":"\nClose the overlay.\n ","params":[],"function":true},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"closingReason","type":"Object","desc":"\nReturns the reason this dialog was last closed.\n ","published":true},{"__fromBehavior":"Polymer.IronFitBehavior","name":"constrain","type":"Function","desc":"\nConstrains the size of the element to the window or `fitInfo` by setting `max-height`\nand/or `max-width`.\n ","params":[],"function":true},{"__fromBehavior":"Polymer.NeonAnimatableBehavior","name":"entryAnimation","type":"String","desc":"\nConvenience property for setting an 'entry' animation. Do not set `animationConfig.entry`\nmanually if using this. The animated node is set to `this` if using this property.\n ","published":true,"observer":"_entryAnimationChanged","observerNode":{"type":"Literal","value":"_entryAnimationChanged","raw":"'_entryAnimationChanged'","range":[648,672],"loc":{"start":{"line":24,"column":18},"end":{"line":24,"column":42}}}},{"__fromBehavior":"Polymer.NeonAnimatableBehavior","name":"exitAnimation","type":"String","desc":"\nConvenience property for setting an 'exit' animation. Do not set `animationConfig.exit`\nmanually if using this. The animated node is set to `this` if using this property.\n ","published":true,"observer":"_exitAnimationChanged","observerNode":{"type":"Literal","value":"_exitAnimationChanged","raw":"'_exitAnimationChanged'","range":[955,978],"loc":{"start":{"line":33,"column":18},"end":{"line":33,"column":41}}}},{"__fromBehavior":"Polymer.IronFitBehavior","name":"fit","type":"Function","desc":"\nFits and optionally centers the element into the window, or `fitInfo` if specified.\n ","params":[],"function":true},{"__fromBehavior":"Polymer.IronFitBehavior","name":"fitInto","type":"Object","desc":"\nThe element to fit `this` into.\n ","published":true,"default":"window"},{"__fromBehavior":"Polymer.NeonAnimatableBehavior","name":"getAnimationConfig","type":"Function","desc":"\nAn element implementing `Polymer.NeonAnimationRunnerBehavior` calls this method to configure\nan animation with an optional type. Elements implementing `Polymer.NeonAnimatableBehavior`\nshould define the property `animationConfig`, which is either a configuration object\nor a map of animation type to array of configuration objects.\n ","params":[{"name":"type"}],"function":true},{"__fromBehavior":"Polymer.PaperDialogBehavior","name":"modal","type":"Boolean","desc":"\nIf `modal` is true, this implies `no-cancel-on-outside-click`, `no-cancel-on-esc-key` and `with-backdrop`.\n ","published":true,"default":false},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"noAutoFocus","type":"Boolean","desc":"\nSet to true to disable auto-focusing the overlay or child nodes with\nthe `autofocus` attribute` when the overlay is opened.\n ","published":true,"default":false},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"noCancelOnEscKey","type":"Boolean","desc":"\nSet to true to disable canceling the overlay with the ESC key.\n ","published":true,"default":false},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"noCancelOnOutsideClick","type":"Boolean","desc":"\nSet to true to disable canceling the overlay by clicking outside it.\n ","published":true,"default":false},{"__fromBehavior":"Polymer.IronResizableBehavior","name":"notifyResize","type":"Function","desc":"\nCan be called to manually notify a resizable and its descendant\nresizables of a resize change.\n ","params":[],"function":true},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"open","type":"Function","desc":"\nOpen the overlay.\n ","params":[],"function":true},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"opened","type":"Boolean","desc":"\nTrue if the overlay is currently displayed.\n ","published":true,"observer":"_openedChanged","observerNode":{"type":"Literal","value":"_openedChanged","raw":"'_openedChanged'","range":[1968,1984],"loc":{"start":{"line":50,"column":18},"end":{"line":50,"column":34}}},"default":false,"notify":true},{"__fromBehavior":"Polymer.NeonAnimationRunnerBehavior","name":"playAnimation","type":"Function","desc":"\nPlays an animation with an optional `type`.\n","params":[{"name":"type","type":"string=","desc":null},{"name":"cookie","type":"!Object=","desc":null}],"function":true},{"__fromBehavior":"Polymer.IronFitBehavior","name":"refit","type":"Function","desc":"\nEquivalent to calling `resetFit()` and `fit()`. Useful to call this after the element,\nthe window, or the `fitInfo` element has been resized.\n ","params":[],"function":true},{"__fromBehavior":"Polymer.IronFitBehavior","name":"resetFit","type":"Function","desc":"\nResets the target element's position and size constraints, and clear\nthe memoized data.\n ","params":[],"function":true},{"__fromBehavior":"Polymer.IronResizableBehavior","name":"resizerShouldNotify","type":"Function","desc":"\nThis method can be overridden to filter nested elements that should or\nshould not be notified by the current element. Return true if an element\nshould be notified, or false if it should not be notified.\n\n","params":[{"name":"element","type":"HTMLElement","desc":"A candidate descendant element that\nimplements `IronResizableBehavior`."}],"function":true,"return":{"type":"boolean","desc":"True if the `element` should be notified of resize."}},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"restoreFocusOnClose","type":"Boolean","desc":"\nSet to true to enable restoring of focus when overlay is closed.\n ","published":true,"default":false},{"__fromBehavior":"Polymer.IronFitBehavior","name":"sizingTarget","type":"!Element","desc":"\nThe element that will receive a `max-height`/`width`. By default it is the same as `this`,\nbut it can be set to a child element. This is useful, for example, for implementing a\nscrolling region inside the element.\n","published":true,"default":"UNKNOWN"},{"__fromBehavior":"Polymer.IronResizableBehavior","name":"stopResizeNotificationsFor","type":"Function","desc":"\nUsed to remove a resizable descendant from the list of descendants\nthat should be notified of a resize change.\n ","params":[{"name":"target"}],"function":true},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"toggle","type":"Function","desc":"\nToggle the opened state of the overlay.\n ","params":[],"function":true},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"withBackdrop","type":"Boolean","desc":"\nSet to true to display a backdrop behind the overlay.\n ","published":true,"observer":"_withBackdropChanged","observerNode":{"type":"Literal","value":"_withBackdropChanged","raw":"'_withBackdropChanged'","range":[2406,2428],"loc":{"start":{"line":70,"column":18},"end":{"line":70,"column":40}}}},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"_applyFocus","type":"Function","desc":"\nApplies focus according to the opened state.\n","params":[],"jsdoc":{"tags":[{"tag":"protected","type":null,"description":null}]},"private":true,"function":true},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"_canceledChanged","type":"Function","params":[],"private":true,"function":true},{"__fromBehavior":"Polymer.NeonAnimatableBehavior","name":"_cloneConfig","type":"Function","params":[{"name":"config"}],"private":true,"function":true},{"__fromBehavior":"Polymer.NeonAnimationRunnerBehavior","name":"_completeAnimations","type":"Function","params":[{"name":"allAnimations"}],"private":true,"function":true},{"__fromBehavior":"Polymer.NeonAnimationRunnerBehavior","name":"_configureAnimationEffects","type":"Function","params":[{"name":"allConfigs"}],"private":true,"function":true},{"__fromBehavior":"Polymer.NeonAnimatableBehavior","name":"_copyProperties","type":"Function","params":[{"name":"config1"},{"name":"config2"}],"private":true,"function":true},{"__fromBehavior":"Polymer.IronFitBehavior","name":"_discoverInfo","type":"Function","desc":"\nMemoize information needed to position and size the target element.\n ","params":[],"private":true,"function":true},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"_ensureSetup","type":"Function","params":[],"private":true,"function":true},{"__fromBehavior":"Polymer.NeonAnimatableBehavior","name":"_entryAnimationChanged","type":"Function","params":[],"private":true,"function":true},{"__fromBehavior":"Polymer.NeonAnimatableBehavior","name":"_exitAnimationChanged","type":"Function","params":[],"private":true,"function":true},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"_finishPositioning","type":"Function","params":[],"private":true,"function":true},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"_finishRenderClosed","type":"Function","desc":"\nTasks to be performed at the end of close action. Will fire `iron-overlay-closed`.\n","params":[],"jsdoc":{"tags":[{"tag":"protected","type":null,"description":null}]},"private":true,"function":true},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"_finishRenderOpened","type":"Function","desc":"\nTasks to be performed at the end of open action. Will fire `iron-overlay-opened`.\n","params":[],"jsdoc":{"tags":[{"tag":"protected","type":null,"description":null}]},"private":true,"function":true},{"__fromBehavior":"Polymer.IronResizableBehavior","name":"_fireResize","type":"Function","params":[],"private":true,"function":true},{"__fromBehavior":"Polymer.IronFitBehavior","name":"_fitHeight","type":"","private":true},{"__fromBehavior":"Polymer.IronFitBehavior","name":"_fitInfo","type":"?Object","desc":"","published":true,"private":true},{"__fromBehavior":"Polymer.IronFitBehavior","name":"_fitLeft","type":"","private":true},{"__fromBehavior":"Polymer.IronFitBehavior","name":"_fitTop","type":"","private":true},{"__fromBehavior":"Polymer.IronFitBehavior","name":"_fitWidth","type":"","private":true},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"_focusableNodes","type":"Array.<Node>","desc":"\nArray of nodes that can receive focus (overlay included), ordered by `tabindex`.\nThis is used to retrieve which is the first and last focusable nodes in order\nto wrap the focus for overlays `with-backdrop`.\n\nIf you know what is your content (specifically the first and last focusable children),\nyou can override this method to return only `[firstFocusable, lastFocusable];`\n","jsdoc":{"tags":[{"tag":"protected","type":null,"description":null}]},"private":true},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"_focusedChild","type":"?Node","desc":"\nThe node being focused.\n","published":true,"private":true},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"_focusNode","type":"Node","desc":"\nReturns the node to give focus to.\n","private":true},{"__fromBehavior":"Polymer.NeonAnimatableBehavior","name":"_getAnimationConfigRecursive","type":"Function","params":[{"name":"type"},{"name":"map"},{"name":"allConfigs"}],"private":true,"function":true},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"_manager","type":"Polymer.IronOverlayManagerClass","desc":"\nShortcut to access to the overlay manager.\n","published":true,"default":"Polymer.IronOverlayManager","jsdoc":{"tags":[{"tag":"private","type":null,"description":null}]},"private":true},{"__fromBehavior":"Polymer.PaperDialogBehavior","name":"_modalChanged","type":"Function","params":[{"name":"modal"},{"name":"readied"}],"private":true,"function":true},{"__fromBehavior":"Polymer.IronResizableBehavior","name":"_notifyDescendant","type":"Function","params":[{"name":"descendant"}],"private":true,"function":true},{"__fromBehavior":"Polymer.IronResizableBehavior","name":"_notifyingDescendant","type":"Boolean","desc":"\nTrue if this element is currently notifying its descedant elements of\nresize.\n ","published":true,"default":false,"private":true},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"_onCaptureClick","type":"Function","desc":"\nCancels (closes) the overlay. Call when click happens outside the overlay.\n","params":[{"name":"event","type":"!Event","desc":null}],"jsdoc":{"tags":[{"tag":"protected","type":null,"description":null}]},"private":true,"function":true},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"_onCaptureEsc","type":"Function","desc":"\nHandles the ESC key event and cancels (closes) the overlay.\n","params":[{"name":"event","type":"!Event","desc":null}],"jsdoc":{"tags":[{"tag":"protected","type":null,"description":null}]},"private":true,"function":true},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"_onCaptureFocus","type":"Function","desc":"\nKeeps track of the focused child. If withBackdrop, traps focus within overlay.\n","params":[{"name":"event","type":"!Event","desc":null}],"jsdoc":{"tags":[{"tag":"protected","type":null,"description":null}]},"private":true,"function":true},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"_onCaptureTab","type":"Function","desc":"\nHandles TAB key events to track focus changes.\nWill wrap focus for overlays withBackdrop.\n","params":[{"name":"event","type":"!Event","desc":null}],"jsdoc":{"tags":[{"tag":"protected","type":null,"description":null}]},"private":true,"function":true},{"__fromBehavior":"Polymer.IronResizableBehavior","name":"_onDescendantIronResize","type":"Function","params":[{"name":"event"}],"private":true,"function":true},{"__fromBehavior":"Polymer.PaperDialogBehavior","name":"_onDialogClick","type":"Function","desc":"\nWill dismiss the dialog if user clicked on an element with dialog-dismiss\nor dialog-confirm attribute.\n ","params":[{"name":"event"}],"private":true,"function":true},{"__fromBehavior":"Polymer.IronResizableBehavior","name":"_onIronRequestResizeNotifications","type":"Function","params":[{"name":"event"}],"private":true,"function":true},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"_onIronResize","type":"Function","desc":"\nRefits if the overlay is opened and not animating.\n","params":[],"jsdoc":{"tags":[{"tag":"protected","type":null,"description":null}]},"private":true,"function":true},{"name":"_onNeonAnimationFinish","type":"Function","params":[],"private":true,"function":true},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"_onNodesChange","type":"Function","desc":"\nWill call notifyResize if overlay is opened.\nCan be overridden in order to avoid multiple observers on the same node.\n","params":[],"jsdoc":{"tags":[{"tag":"protected","type":null,"description":null}]},"private":true,"function":true},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"_openedChanged","type":"Function","params":[],"private":true,"function":true},{"__fromBehavior":"Polymer.IronResizableBehavior","name":"_parentResizable","type":"Object","desc":"\nThe closest ancestor element that implements `IronResizableBehavior`.\n ","published":true,"observer":"_parentResizableChanged","observerNode":{"type":"Literal","value":"_parentResizableChanged","raw":"'_parentResizableChanged'","range":[1120,1145],"loc":{"start":{"line":27,"column":18},"end":{"line":27,"column":43}}},"private":true},{"__fromBehavior":"Polymer.IronResizableBehavior","name":"_parentResizableChanged","type":"Function","params":[{"name":"parentResizable"}],"private":true,"function":true},{"__fromBehavior":"Polymer.NeonAnimationRunnerBehavior","name":"_player","type":"?Object","desc":"","published":true,"private":true},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"_preparePositioning","type":"Function","params":[],"private":true,"function":true},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"_prepareRenderOpened","type":"Function","desc":"\ntasks which must occur before opening; e.g. making the element visible.\n","params":[],"jsdoc":{"tags":[{"tag":"protected","type":null,"description":null}]},"private":true,"function":true},{"name":"_renderClosed","type":"Function","params":[],"private":true,"function":true},{"name":"_renderOpened","type":"Function","params":[],"private":true,"function":true},{"__fromBehavior":"Polymer.NeonAnimationRunnerBehavior","name":"_runAnimationEffects","type":"Function","params":[{"name":"allEffects"}],"private":true,"function":true},{"__fromBehavior":"Polymer.IronFitBehavior","name":"_sizeDimension","type":"Function","params":[{"name":"rect"},{"name":"positionedBy"},{"name":"start"},{"name":"end"},{"name":"extent"}],"private":true,"function":true},{"__fromBehavior":"Polymer.PaperDialogBehavior","name":"_updateClosingReasonConfirmed","type":"Function","params":[{"name":"confirmed"}],"private":true,"function":true},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"_withBackdropChanged","type":"Function","params":[],"private":true,"function":true},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"attached","type":"Function","params":[],"private":true,"configuration":true,"function":true},{"__fromBehavior":"Polymer.IronResizableBehavior","name":"created","type":"Function","params":[],"private":true,"configuration":true,"function":true},{"__fromBehavior":"Polymer.IronOverlayBehavior","name":"detached","type":"Function","params":[],"private":true,"configuration":true,"function":true},{"__fromBehavior":"Polymer.PaperDialogBehavior","name":"hostAttributes","type":"Object","private":true,"configuration":true},{"name":"listeners","type":"Object","private":true,"configuration":true},{"__fromBehavior":"Polymer.PaperDialogBehavior","name":"ready","type":"Function","params":[],"private":true,"configuration":true,"function":true}],"behaviors":["Polymer.PaperDialogBehavior","Polymer.NeonAnimationRunnerBehavior"],"observers":[],"is":"paper-dialog","contentHref":"/Users/dfreedm/me/polymer-element-catalog/bower_components/paper-dialog/paper-dialog.html","jsdoc":{"tags":[{"tag":"group","type":null,"description":"Paper Elements"},{"tag":"element","type":null,"description":"paper-dialog"},{"tag":"hero","type":null,"name":"hero.svg","description":null},{"tag":"demo","type":null,"name":"demo/index.html","description":""}]},"demos":[{"desc":"demo","path":"demo/index.html"}],"hero":"hero.svg"}" |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment