noflo-polymer
v3.0.0
Published
Polymer wrapper component for NoFlo
Downloads
17
Readme
noflo-polymer
This project provides a binding between Polymer web components and NoFlo, allowing Polymer components to be used as components in a NoFlo graph. The attributes of a Polymer element become the input ports of the NoFlo component, and the events emitted by the Polymer element become the output ports.
Status
In production with noflo-ui
Installation
Add this component to your dependencies:
$ npm install noflo-polymer --save
In addit you need a working setup of Polymer and NoFlo.
Usage
Since Polymer elements don't support introspection yet, you need to utilize the noflo-polymer
custom element for informing NoFlo of the attributes and events of your custom elements.
For example:
<noflo-polymer name="the-graph" inports="graph width height" outports="changed"></noflo-polymer>
After this you'll have a polymer/the-graph
component available with the following ports:
- Input
- element (for providing an element instance either queried from DOM or as a result of
document.createElement
- graph (modifies the graph attribute)
- width (modifies the width attribute)
- height (modifies the height attribute)
- element (for providing an element instance either queried from DOM or as a result of
- Output
- element (the same element instance, passed through
- changed (sends output when the element fires a
changed
event)
Changes
- 3.0.0 (November 04 2020)
- Ported to Polymer 3.x
- 2.0.1 (November 10 2017)
- Made noflo-polymer not import
polymer.html
since paths may be different in production use. Consumers must import it themselves - Added a
true
payload to thenoflo:ready
event emitted when a Polymer element is bound to a NoFlo component instance
- Made noflo-polymer not import
- 2.0.0 (November 10 2017)
- Ported components from CoffeeScript to ES6
- Upgraded Polymer from 1.x to 2.x