README.md

v-gantt

中文文档

Table of Contents

• Introduction
• Feature
• Quick Start
• Development
  • Todo
• Links
• Inspiration
• Contributing
• Contributors
• License

Introduction

Base on vue + element-ui, create web version omniplan。

⬆ Back to Top

Feature

1. fold & collapse tree node
2. support tree header slot
3. drag gantt node to modify dates
4. drag to modify duration
5. jump to 'today'
6. col unit base on days or weeks or months
7. monthly view hover node to display date info
8. click tree node to jump to gantt node
9. click milestone's line to jump to milestone node
10. get chinese festivals by public-api

⬆ Back to Top

Quick Start

v-gantt is based on el-button, el-select, el-progress and el-tree. So you need to register those in global environment with Vue.component or simply with Vue.use(Element)

yarn add @femessage/v-gantt @femessage/element-ui

<template>
  <v-gantt style="height: 400px;" :data.sync="data" />
</template>

<script>
  export default {
    data() {
      const y = new Date().getFullYear()
      const m = `${new Date().getMonth() + 1}`.padStart(2, 0)
      const d = (date) => `${y}-${m}-${date}`
      return {
        data: [
          {
            id: 'group-1',
            name: '群组-1',
            children: [
              {
                id: 'item-1',
                name: '叶节点-1',
                progress: 30,
                startDate: d('06'),
                endDate: d('07'),
              },
            ],
          },
          {
            id: 'milestone-1',
            name: '里程碑-1',
            date: d('10'),
            done: true,
          },
        ],
      }
    },
  }
</script>

Development

develop on top of vue-styleguide

yarn dev

Todo

• support tree node dragging
• support header-slot to place button like 'new'
• support delete action
• fix 'rowH' doesn't inpact tree nodes
• support drag to change progress
• support click to toggle milestone
• lost <gantt-layout> in <gantt-group> when compile with rollup

⬆ Back to Top

Links

• online demo
• design docs

⬆ Back to Top

Inspiration

thanks to

• ones-plan
• omniplan

⬆ Back to Top

Contributing

For those who are interested in contributing to this project, such as:

• report a bug
• request new feature
• fix a bug
• implement a new feature

Please refer to our contributing guide.

⬆ Back to Top

Contributors

Thanks goes to these wonderful people (emoji key):

Donald Shen 💻 📝 🔧 🎨

4Ark 📖 🚧

This project follows the all-contributors specification. Contributions of any kind welcome!

⬆ Back to Top

License

MIT

⬆ Back to Top