https://github.com/dhtmlx/salesforce-gantt-demo
Using Gantt inside of SalesForce as web component
https://github.com/dhtmlx/salesforce-gantt-demo
dhtmlxgantt gantt-chart salesforce salesforce-lightning-component
Last synced: 10 months ago
JSON representation
Using Gantt inside of SalesForce as web component
- Host: GitHub
- URL: https://github.com/dhtmlx/salesforce-gantt-demo
- Owner: DHTMLX
- Created: 2020-02-04T12:14:26.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-24T13:01:49.000Z (about 1 year ago)
- Last Synced: 2025-05-06T01:37:43.723Z (about 1 year ago)
- Topics: dhtmlxgantt, gantt-chart, salesforce, salesforce-lightning-component
- Language: JavaScript
- Homepage: https://dhtmlx.com/docs/products/demoApps/salesforce-gantt-chart/
- Size: 918 KB
- Stars: 17
- Watchers: 9
- Forks: 25
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Gantt demo for SalesForce
[](https://dhtmlx.com/)
Here you can find a code example of the Gantt chart for Lightning Web Components on Salesforce Platform.
The sample is implemented with the help of JavaScript Gantt chart library - [DHTMLX Gantt](https://dhtmlx.com/docs/products/dhtmlxGantt/).
[](https://dhtmlx.com/docs/products/demoApps/salesforce-gantt-chart/)
## Prerequisites
- Enable the [Developer Hub](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_enable_devhub.htm) in your organization
- Install the [Salesforce CLI](https://developer.salesforce.com/tools/sfdxcli)
## How to start
- [Change login url](https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_auth_web_flow.htm) (sfdcLoginUrl) in sfdx-project.json to url of your SalesForce organization
- Create [scratch org](https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_scratch_orgs.htm#!)
```sh
sfdx org login web -d
sfdx org create scratch -f config/project-scratch-def.json -d
```
- Publish code
```sh
sfdx project deploy start
sfdx data import tree -f ./data/GanttTask__c.json
```
- Open scratch org in browser
```
sfdx org open
```
- Create custom tab with Gantt
The scratch org already has Gantt app which you can check, or go to "Setup : Lighting Apps", create a new Lighting App and drop the Gantt from the list of available components:
https://docs.dhtmlx.com/gantt/desktop__howtostart_salesforce.html#step7creatinglightningpage
- Open the tab with Gantt by choosing it from the `App Launcher`
## How to configure / modify
### Backend
getTasks in force-app/main/default/classes/GanttData.cls returns list of tasks and links, adjust this query as necessary.
### Frontend
force-app/main/default/lwc/gantt/gantt.js contains code of web component
```js
function unwrap(fromSF){
const data = fromSF.tasks.map(a => ({
```
**unwrap** functions controls how data from SalesForce is converted to Gantt compatible objects. You will need to modify this code if you will want to provide some additional data properties from SalesForce to the Gantt
```js
initializeUI(){
const root = this.template.querySelector('.thegantt');
root.style.height = this.height + "px";
const gantt = window.Gantt.getGanttInstance();
```
**initializeUI** creates an instance of gantt. This is the perfect place to configure gantt by using its [API](https://docs.dhtmlx.com/gantt)
```js
gantt.createDataProcessor({
task: {
```
**createDataProcessor** defines data saving rules, they need to be adjusted if you will want to save some extra fields along with the default Task's data.
### DHTMLX Gantt Version and License
The force-app/main/default/staticresources/dhtmlxgantt folder comes under the Evaluation license of DHTMLX Gantt. The Gantt chart will show a warning message about a 30-day trial period from time to time. For production usage, you will need to replace the js and css files in this archive with the ones from the DHTMLX Gantt package under the Enterprise or Ultimate licenses.
## Related resources
- Documentation: [https://docs.dhtmlx.com/gantt/](https://docs.dhtmlx.com/gantt/)
- DHTMLX Gantt product page: [https://dhtmlx.com/docs/products/dhtmlxGantt/](https://dhtmlx.com/docs/products/dhtmlxGantt/)
- Video tutorial: [https://youtu.be/1nXl9jfMdto](https://youtu.be/1nXl9jfMdto?list=PLKS_XdyIGP4MEW6yvvQUZT8vJKHVOq2S0)
- About DHTMLX Gantt in Salesforce: [https://dhtmlx.com/docs/products/demoApps/salesforce-gantt-chart/](https://dhtmlx.com/docs/products/demoApps/salesforce-gantt-chart/)
- Demo of DHTMLX Gantt chart with resource management diagram for SalesForce LWC: [https://github.com/DHTMLX/salesforce-gantt-resources-demo](https://github.com/DHTMLX/salesforce-gantt-resources-demo)
## Join our online community
- Star our GitHub repo :star:
- Check our [roadmap](https://trello.com/b/fhOySHPj/gantt-roadmap) for future updates :wrench:
- Watch our tutorials on [YouTube](https://www.youtube.com/user/dhtmlx/videos) :tv:
- Read us on [Medium](https://dhtmlx.medium.com) :newspaper:
- Follow us on [X](https://x.com/dhtmlx) :bird:
- Check our news and updates on [Facebook](https://www.facebook.com/dhtmlx/) :feet: