npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@recognizerhd/vue2vis-timeline

v1.0.2

Published

Vue2 wrapper for the Visjs Timeline library.

Downloads

3

Readme

@recognizerhd/vue2vis-timeline

A fork of the alexcode/vue2vis package. Vue2 wrapper for the Visjs Timeline library.

Installation

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

or

yarn add @recognizerhd/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 [email protected] instead of using the issue tracker.

Credits

License

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