Skip to content

Latest commit

 

History

History
206 lines (160 loc) · 4.85 KB

README.md

File metadata and controls

206 lines (160 loc) · 4.85 KB
Raw

@vue2vis/timeline

Vue2 wrapper for the Visjs Timeline library.

Build Status Software License npm version Issues

Installation

npm install --save @vue2vis/timeline vis-data moment

or

yarn add @vue2vis/timeline vis-data moment

Usage

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
      }
    };
  }
});

Additional info can be found on Visjs Timeline documentation

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

Events

Component Events

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>

Data Events

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,
}

Advanced

You can also manage your own data bindings by passing your own DataSet or DataView instead of an Array.

import { DataSet } from "vis-data";

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
      }
    };
  }
});

Visjs documentation

Full reference of Item and Group formats, options properties and events:

Change log

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Run demo locally

# Run demo at localhost:8080
yarn install
yarn lerna bootstrap
yarn serve:timeline

Go to http://localhost:8080/ to see running examples

NOTE: If you make changes to the library you should run yarn prepare again in the root folder. The dev server should detect modification and reload the demo

Security

If you discover any security related issues, please email infocontact.alex@gmail.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.