<y-element>
Polymer Web Component for sharing data with Yjs. Perform data-binding on shared data!
Read the docs to get started!
This repository contains four elements:
- y-element - Configures the database and connector information
- y-map - Creates a map type. It exports the data as a shared javascript object
- y-array - Creates an array type. It exports the data as a shared javascript array
- y-type - Configuration for any Yjs type. It exports the Yjs type
Simple Yjs example in Javascript
Y({
db: {
name: 'memory'
},
connector: {
name: 'websockets-client',
room: 'example'
},
share: {
map: 'Map'
}
}).then(function (y) {
y.share.map // is the shared map type
})
Same example in Polymer
<y-element
db-name="memory"
connector-name="websockets-client"
connector-room="example">
<y-map name="map" data="{{myMap}}"></y-map>
</y-element>
Before you start
Before you start remember to install all y-* modules you want to use.
In particular you need to install a connector (e.g. y-websockets-client), and
a database adapter (e.g. y-memory).
bower i --save y-element yjs y-map y-array y-memory y-websockets-client
<y-element>@>2.0.0 no longer supports automatic module finding. You need to explicitly include all y-* modules!
<script src="../bower_components/yjs/y.js"></script>
<script src="../bower_components/y-map/y-map.js"></script>
<script src="../bower_components/y-array/y-array.js"></script>
<script src="../bower_components/y-memory/y-memory.js"></script>
<script src="../bower_components/y-websockets-client/y-websockets-client.js"></script>
<link rel="import" href="../bower_components/y-element/y-element.html">Contribute
Issues and Pull requests are very much welcome. If you want to help out you can also contribute to the docs ;) This project was build with Polymer CLI v0.16. Make sure the tests are still running ;)
License
y-element is licensed under the MIT License.