2
0
mirror of https://github.com/tenrok/vue-ganttastic.git synced 2026-06-09 20:22:25 +03:00
Marko Zunic 2a0fa28533 New prop for g-gantt-chart: snap-back-on-overlap
If true (and if push-on-overlap is false), if a bar ends up
overlapping with another bar after a drag, the bar (or its whole bundle, if it belongs to one) snaps back to its original position
Added .npmignore
Bumped npm package version
Updated README
2020-03-27 14:32:56 +01:00

vue-ganttastic

A simple and easy-to-use Gantt chart component for Vue.js

Installation

If you use npm in your project, you can install vue-ganttastic simply with:

npm install vue-ganttastic

If you do not use npm in your project, you may alternatively copy and paste all files from the components folder and and import the components GGanttChart and GGanttRow wherever you need them

Basic Usage

Import the components GGanttChart and GGanttRow.
Use g-gantt-chart in your template, pass the desired chart start and chart end time as props (chart-start and chart-end) and add g-gantt-rows to the default template slot.
Pass an array containing your bar objects to every row using the bars prop, while specifying the name of the properties in your bar objects that stand for the bar start and bar end time using the props bar-start and bar-end

For more detailed information, such as how to style the bars or additional configuration options, please refer to the docs on the project's homepage (coming soon).

The following code showcases a simple usage example in a .vue SFC (Single File Component)

<template>
  ...

  <g-gantt-chart
    :chart-start="myChartStart"
    :chart-end="myChartEnd"
  >
    <g-gantt-row
      v-for="row in rows"
      :key="row.label"
      :label="row.label"
      :bars="row.bars"
      bar-start="myStart"
      bar-end="myEnd"
    />
  </g-gantt-chart>

  ...
</template>

<script>

import {GGanttChart, GGanttBar} from 'vue-ganttastic'

export default {

  ...

  components:{
    GGanttChart,
    GGanttBar
  },

  data(){
    return {
      myChartStart: "2020-03-01 00:00",
      myChartEnd: "2020-03-03 00:00",
      rows: [
        {
          label: "My row #1",
          bars: [
            {
              myStart: "2020-03-01 12:10",
              myEnd: "2020-03-01 16:35"
            }
          ]
        },
        {
          label: "My row #2",
          bars: [
            {
              myStart: "2020-03-02 01:00",
              myEnd: "2020-03-02 12:00"
            },
            {
              myStart: "2020-03-02 13:00",
              myEnd: "2020-03-02 22:00"
            }
          ]
        }
      ]
    }
  }

  ...

}
</script>

Contributing

Pull requests are warmly welcomed, while every major change or proposal ought to be discussed in an issue first. As the project is still new, I will gladly accept suggestions, proposals, contributions etc.

Contributing - How to run the project

  1. Clone the project
  2. Install the Vue CLI service, if you don't already have it installed:
      npm install -g @vue/cli
      npm install -g @vue/cli-service-global
    
  3. Playground.vue is a dedicated Vue SFC where all Vue-Ganttastic components can be played around with and tested out. Get it running using:
      vue serve src/Playground.vue
    

Dependencies

Moment.js

License

MIT

S
Description
A simple and easy-to-use Gantt chart component for Vue.js
Readme 3.1 MiB
Languages
Vue 84.6%
SCSS 12.3%
JavaScript 2.2%
HTML 0.9%