🌜
🌞
frappe-gantt

frappe-gantt

v0.6.1

A simple, modern, interactive gantt library for the web

npm install frappe-gantt

README

Frappe Gantt

A simple, interactive, modern gantt chart library for the web

View the demo »

Install

npm install frappe-gantt

Usage

Include it in your HTML:

<script src="frappe-gantt.min.js"></script>
<link rel="stylesheet" href="frappe-gantt.css">

And start hacking:

var tasks = [
  {
    id: 'Task 1',
    name: 'Redesign website',
    start: '2016-12-28',
    end: '2016-12-31',
    progress: 20,
    dependencies: 'Task 2, Task 3',
    custom_class: 'bar-milestone' // optional
  },
  ...
]
var gantt = new Gantt("#gantt", tasks);

You can also pass various options to the Gantt constructor:

var gantt = new Gantt("#gantt", tasks, {
    header_height: 50,
    column_width: 30,
    step: 24,
    view_modes: ['Quarter Day', 'Half Day', 'Day', 'Week', 'Month'],
    bar_height: 20,
    bar_corner_radius: 3,
    arrow_curve: 5,
    padding: 18,
    view_mode: 'Day',
    date_format: 'YYYY-MM-DD',
    custom_popup_html: null
});

Contributing

If you want to contribute enhancements or fixes:

  1. Clone this repo.
  2. cd into project directory
  3. yarn
  4. yarn run dev
  5. Open index.html in your browser, make your code changes and test them.

Publishing

If you have publishing rights (Frappe Team), follow these steps to publish a new version.

Assuming the last commit (or a couple of commits) were enhancements or fixes,

  1. Run yarn build

    This will generate files in the dist/ folder. These files need to be committed.

  2. Run yarn publish

  3. Type the new version at the prompt

    Depending on the type of change, you can either bump the patch version or the minor version. For e.g.,

    0.5.0 -> 0.6.0 (minor version bump)
    0.5.0 -> 0.5.1 (patch version bump)
    
  4. Now, there will be a commit named after the version you just entered. Include the generated files in dist/ folder as part of this commit by running the command:

    git add dist
    git commit --amend
    git push origin master
    

License: MIT


Project maintained by frappe

General

License
MIT
Typescript Types
Tree-shakeable
No

Popularity

GitHub Stargazers
3,318
Community Interest
3,207
Number of Forks
748

Maintenance

Commits
10/219/2203
Last Commit
Apr 28, 2022
Open Issues
113
Closed Issues
67
Open Pull Requests
50
Closed Pull Requests
38

Versions

Versions Released
10/219/2201
Latest Version Released
Current Tags
latest0.6.1

Contributors

netchampfaris
netchampfaris
Commits: 51
diegodurrod
diegodurrod
Commits: 2
kostasx
kostasx
Commits: 1
St7s
St7s
Commits: 1
davidalves1
davidalves1
Commits: 1
anto-christo
anto-christo
Commits: 1
huchim
huchim
Commits: 1
dalwadani
dalwadani
Commits: 1
kannkyo
kannkyo
Commits: 1
mhunesi
mhunesi
Commits: 1
jeroenrinzema
jeroenrinzema
Commits: 1
TakanashiAsuka
TakanashiAsuka
Commits: 1
dbtek
dbtek
Commits: 1
gavindsouza
gavindsouza
Commits: 1
swkasica
swkasica
Commits: 1