@withyouwithme/vue2vis
Advanced tools
Readme
Vue2 component that helps with Visjs interaction
npm install --save vue2vis
or
yarn add vue2vis
Declare the component
Vue.component('timeline', vue2vis.Timeline);
Add the component in the template.
<body>
<div id="app">
<timeline ref="timeline"
:items="items"
:groups="groups"
:options="options">
</timeline>
</div>
</body>
Add groups, items and options in your observed data or computed.
new Vue({
el: '#app',
data() {
return {
groups: [{
id: 0,
content: 'Group 1'
}],
items: [{
id: 0,
group: 0,
start: new Date(),
content: 'Item 1'
}],
options: {
editable: true,
}
}
},
});
Add Visjs CSS
@import "vue2vis/dist/vue2vis.css";
Here is a basic working demo with item generation: JS Fiddle Basic Demo
You can also create items or group labels as Vue Components: JS Fiddle Item Vue Component Demo
By default all Vis events are emitted by your component. You can subscribe to a subset by passing an array in the prop events Visjs event.
<body>
<div id="app">
<timeline ref="timeline"
:items="items"
:groups="groups"
:options="options"
:events="['drop', 'changed']"
@drop="myDropCallback"
@changed="myChangedCallback">
</timeline>
</div>
</body>
When you pass an Array of data object, it is converted internally as a DataSet.
An event with the DataSet object will be fired at mounted. It's name will be prepend with the prop name (Ex: items-mounted, groups-mounted). You could use it to interact with the DataSet.
All the Visjs DataSet event will be prepened the same fashion (items-add, items-remove, items-update). For example, pushing a new object to the items prop will fire a items-add event with the following payload:
{
event: 'add',
properties: {
items: [7],
},
senderId: null,
}
You can also manage your own data bindings by passing your own DataSet or DataView instead of an Array.
import { DataSet } from 'vue2vis';
new Vue({
el: '#app',
data() {
return {
groups: new DataSet([{
id: 0,
content: 'Group 1'
}]),
items: new DataSet([{
id: 0,
group: 0,
start: new Date(),
content: 'Item 1'
}]),
options: {
editable: true,
}
}
},
});
Full reference of Item and Group formats, options properties and events: Timeline, Network, Graph2d, DataSet, DataView
Please see CHANGELOG for more information what has changed recently.
$ npm run test
Please see CONTRIBUTING and CONDUCT for details.
# Once you have cloned this repo, install dependencies
$ npm install
# build for development and production with minification
$ npm run build
# Run demo at localhost:8080
$ npm link
$ cd examples
$ npm install
$ npm link vue2vis
# serve with hot reload at localhost:8080
$ npm run dev
Go to http://localhost:8080/ to see running examples
NOTE: If you make changes to the library you should run 'npm run build' again in the root folder. The dev server should detect modification and reload the demo
If you discover any security related issues, please email infocontact.alex@gmail.com instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.
FAQs
Vue2 component that helps with Visjs interaction
We found that @withyouwithme/vue2vis demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.
Security News
Socket CEO Feross Aboukhadijeh joins a16z partners to discuss how modern, sophisticated supply chain attacks require AI-driven defenses and explore the challenges and solutions in leveraging AI for threat detection early in the development life cycle.