# vue2vis

> Vue2 component that helps with Visjs interaction

Latest version **0.0.18** (published 2020-03-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue2vis
pnpm add vue2vis
yarn add vue2vis
bun add vue2vis
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; large bundle; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.18 |
| Published | 2020-03-03 |
| First published | 2017-08-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 12 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 215 |
| Author | Alex Couturon |
| Maintainers | alexkid |
| Keywords | vue, vis, visjs |

## Links

- npm: https://www.npmjs.com/package/vue2vis
- Repository: https://github.com/alexcode/vue2vis
- Homepage: https://github.com/alexcode/vue2vis#readme
- Issues: https://github.com/alexcode/vue2vis/issues
- npm.io page: https://npm.io/package/vue2vis

## Dependencies (2)

- [vis](https://npm.io/package/vis.md) ^4.21.0
- [core-js](https://npm.io/package/core-js.md) ^3.6.4

## Alternatives

- [d3-force-3d](https://npm.io/package/d3-force-3d.md) — 1.0M weekly downloads
- [ng2-charts](https://npm.io/package/ng2-charts.md) — 486.8K weekly downloads
- [@arcgis/core](https://npm.io/package/@arcgis/core.md) — 257.8K weekly downloads
- [react-sparklines](https://npm.io/package/react-sparklines.md) — 249.3K weekly downloads
- [react-native-gifted-charts](https://npm.io/package/react-native-gifted-charts.md) — 182.3K weekly downloads

## Recent versions

- 0.0.18 (latest) — 2020-03-03
- 0.0.17 — 2020-02-25
- 0.0.16 — 2018-12-04
- 0.0.15 — 2018-08-06
- 0.0.14 — 2018-08-03
- 0.0.13 — 2018-06-04
- 0.0.12 — 2018-04-26
- 0.0.11 — 2018-03-26
- 0.0.10 — 2018-03-19
- 0.0.9 — 2017-11-28
- 0.0.8 — 2017-09-13
- 0.0.7 — 2017-09-13
- 0.0.6 — 2017-09-13
- 0.0.5 — 2017-09-13
- 0.0.4 — 2017-09-12
- … 4 more at https://npm.io/package/vue2vis/versions

## README

# vue2vis

> Vue2 component that helps with <a href="http://visjs.org/">Visjs</a> interaction

<p align="center">
  <a href="https://travis-ci.org/alexcode/vue2vis">
    <img src="https://travis-ci.org/alexcode/vue2vis.svg?branch=master" alt="Build Status" />
  </a>
  <a href="https://coveralls.io/github/alexcode/vue2vis?branch=master">
    <img src="https://coveralls.io/repos/github/alexcode/vue2vis/badge.svg?branch=master" alt="Coverage Status" />
  </a>
  <a href="LICENSE">
    <img src="https://img.shields.io/badge/license-MIT-brightgreen.svg?" alt="Software License" />
  </a>
  <a href="https://npmjs.org/package/vue2vis">
    <img src="https://img.shields.io/npm/v/vue2vis.svg?" alt="Packagist" />
  </a>
  <a href="https://github.com/alexcode/vue2vis/releases">
    <img src="https://img.shields.io/github/release/alexcode/vue2vis.svg?" alt="Latest Version" />
  </a>

  <a href="https://github.com/alexcode/vue2vis/issues">
    <img src="https://img.shields.io/github/issues/alexcode/vue2vis.svg?" alt="Issues" />
  </a>
</p>

### Installation
```
npm install --save vue2vis
```

or

```
yarn add vue2vis
```

## Usage

Declare the component
``` javascript
Vue.component('timeline', vue2vis.Timeline);
```

Add the component in the template.

```html
<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.
``` javascript
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
``` css
@import "vue2vis/dist/vue2vis.css";
```

Here is a basic working demo with item generation:
[JS Fiddle Basic Demo](https://jsfiddle.net/alexkodo/ejdut8fm/)

You can also create items or group labels as Vue Components:
[JS Fiddle Item Vue Component Demo](https://jsfiddle.net/alexkodo/n978c58d/)

## 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](http://visjs.org/docs/timeline/#Events).

```html
<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](http://visjs.org/docs/data/dataset.html#Events) 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:
```javascript
{
  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.

``` javascript
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,
      }
    }
  },
});
```

## Visjs documentation

Full reference of Item and Group formats, options properties and events: [Timeline](http://visjs.org/docs/timeline), [Network](http://visjs.org/docs/network), [Graph2d](http://visjs.org/docs/graph2d), [DataSet](http://visjs.org/docs/dataset), [DataView](http://visjs.org/docs/dataview)

## List of currently implemented modules

-   [x] Timeline
-   [x] Graph2d
-   [ ] Graph3d
-   [x] Network

## Change log

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Testing

``` bash
$ npm run test
```

## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) and [CONDUCT](CONDUCT.md) for details.

### Build Setup

``` bash
# Once you have cloned this repo, install dependencies
$ npm install

# build for development and production with minification
$ npm run build

```

### Run demo locally
``` bash
# 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

## Security

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

## Credits

- [Alex Couturon][link-author]
- [João Menighin](https://github.com/Menighin)
- [All Contributors][link-contributors]

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

[link-author]: https://github.com/alexcode
[link-contributors]: ../../contributors

---
_Source: https://npm.io/package/vue2vis · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
