<gantt-chart>
Web component implementation of a Gantt chart.
Data model
{
milestones: [
{
id: 1,
taskId: 6, // Graphical hint, it may be latest task in the milestone.
title: 'Milestone A',
date: 'July 2019', // Optional.
additionalVerticalShift: 1 // Optional.
},
...
],
tasks: [
{
id: 1,
title: 'task 1',
start: 0, // Week number.
duration: 4, // Duration in weeks.
class: 'c1',
progress: // Optional, defaults to 0.
},
...
]
}Exposed attributes
width: chart width in pixelsheight: chart height in pixels
Margins attributes help to ensure task and milestone titles are visible.
margin-top: space in pixel between the top border and the first task.margin-bottom: space in pixel between the bottom border and the last task.margin-left: space in pixel between the left border and the first task.margin-right: space in pixel between the right border and the last task.
See section Usage for an example.
Exposed CSS Custom Properties
--font-familydefaults tosans-serif--font-sizedefaults to12px--background-colordefaults towhite--visibility-ticksdefaults tovisible, set tohiddento hide the week ticks
Up to 10 classes can be passed:
--c1, the task color defaults topurple--c2, the task color defaults toblue--c3, the task color defaults togold
See section Usage for an example.
Usage
In an html file
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<script type="module">
import 'https://unpkg.com/@nextbitlabs/[email protected]/dist/gantt-chart.umd.js';
</script>
</head>
<style>
@import url('https://fonts.googleapis.com/css?family=Lato:400,700&display=swap');
/*
CSS custom properties penetrate the Shadow DOM,
they are useful to provide custom styling.
The gantt-chart webcomponent exposes font-size and font-family custom properties.
*/
gantt-chart {
--font-family: 'Lato', sans-serif;
--c1: lightblue;
}
</style>
<body>
<!-- Set component attributes -->
<gantt-chart
width="1150"
height="700"
margin-top="40"
margin-left="40"
margin-right="40"
margin-bottom="40"
></gantt-chart>
</body>
<script>
const element = document.querySelector('gantt-chart');
// Set gantt data: tasks and milestones.
element.data = {
milestones: [
{
id: 1,
taskId: 1,
title: 'Milestone A'
},
],
tasks: [
{
id: 1,
title: 'task 1',
start: 0,
duration: 4,
class: 'c1',
progress: 0.65
},
]
};
</script>
</html>With npm:
npm i @nextbitlabs/gantt-chartSee demo.
Development
Install dependencies with
npm installUpdate build on changes with
npm run devand see updates on ./demo/index.html running a local server from ./.
Release
npm run releaseLicense
This project is licensed under the MIT License. See the license file for details.