Skip to content

Commit 0fa140d

Browse files
Merge pull request #94 from AlexKlimenkov/master
[dev] update angular/vue installation guides, update vue guides
2 parents da6ee7e + e6fd809 commit 0fa140d

4 files changed

Lines changed: 193 additions & 34 deletions

File tree

docs/integrations/angular/installation.md

Lines changed: 79 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,43 +6,66 @@ description: "How to install the evaluation or professional version of Angular G
66

77
# Installing Angular Gantt
88

9-
Angular Gantt is distributed in two package channels with the same wrapper API:
9+
Angular Gantt is available in two distributions:
1010

11-
1. **Evaluation package** on public npm: `@dhtmlx/trial-angular-gantt`
12-
2. **Professional package** on DHTMLX private npm: `@dhx/angular-gantt`
11+
1. **Evaluation version** publicly available on npm, includes a trial watermark, and can optionally be paired with a free evaluation period that grants access to technical support.
12+
2. **Professional (commercial) version** available from the private DHTMLX npm repository and intended for production use.
1313

14-
## Choose Your Package Channel
14+
Both packages contain the same API.
1515

16-
### Evaluation package (`@dhtmlx/trial-angular-gantt`)
16+
## Install The Evaluation Package (Public npm)
1717

18-
Install with npm:
18+
The evaluation build is available on npm as [@dhtmlx/trial-angular-gantt](https://www.npmjs.com/package/@dhtmlx/trial-angular-gantt):
19+
20+
- npm:
1921

2022
~~~bash
2123
npm install @dhtmlx/trial-angular-gantt
2224
~~~
2325

24-
Install with Yarn:
26+
- Yarn:
2527

2628
~~~bash
2729
yarn add @dhtmlx/trial-angular-gantt
2830
~~~
2931

30-
### Professional package (`@dhx/angular-gantt`)
32+
This build is fully functional, but shows a message indicating that the library is running in evaluation mode.
33+
34+
### Optional: Start a full evaluation period (recommended)
35+
36+
Although the trial package installs without restrictions, you may also start an official evaluation through the website at
37+
[https://dhtmlx.com/docs/products/dhtmlxGantt-for-Angular/download.shtml](https://dhtmlx.com/docs/products/dhtmlxGantt-for-Angular/download.shtml).
38+
39+
Starting a formal evaluation gives you free technical support during the trial period.
40+
41+
**Downloading offline examples (zip)**
42+
43+
The evaluation form also includes downloadable ZIP containing offline-ready examples.
44+
45+
You can also explore additional examples and demo projects on the official GitHub by checking [Angular Gantt Demos on GitHub](https://github.com/DHTMLX/?q=angular-gantt&type=all&language=&sort=).
46+
47+
## Install The Professional Package (Private npm)
48+
49+
The Professional version is used for production applications and includes commercial licensing and full access to technical support.
3150

32-
Get private npm credentials in the [Client's Area](https://dhtmlx.com/clients/), then configure registry and login:
51+
Once you obtain a commercial license, you can generate your private npm credentials in the [Client's Area](https://dhtmlx.com/clients/).
52+
53+
After generating your login/password, configure npm:
3354

3455
~~~bash
3556
npm config set @dhx:registry=https://npm.dhtmlx.com
3657
npm login --registry=https://npm.dhtmlx.com --scope=@dhx --auth-type=legacy
3758
~~~
3859

39-
Install with npm:
60+
Then install the Professional package:
61+
62+
- npm:
4063

4164
~~~bash
4265
npm install @dhx/angular-gantt
4366
~~~
4467

45-
Install with Yarn:
68+
- Yarn:
4669

4770
~~~bash
4871
yarn add @dhx/angular-gantt
@@ -126,6 +149,51 @@ import { DhxGanttModule } from '@dhtmlx/trial-angular-gantt';
126149
export class AppModule {}
127150
~~~
128151

152+
## Moving from the trial package to the commercial one
153+
154+
Most projects start on the trial package and switch later, once the prototype is approved and a commercial license is in place. Both packages share the same API, so the move is mostly mechanical: swap the package name, swap the CSS import, and reinstall.
155+
156+
After you've configured the private registry as shown above, update every import in the code:
157+
158+
~~~ts
159+
// before
160+
import { DhxGanttComponent } from "@dhtmlx/trial-angular-gantt";
161+
162+
// after
163+
import { DhxGanttComponent } from "@dhx/angular-gantt";
164+
~~~
165+
166+
And update the CSS import in `src/styles.css`:
167+
168+
~~~css
169+
/* before */
170+
@import "@dhtmlx/trial-angular-gantt/dist/angular-gantt.css";
171+
172+
/* after */
173+
@import "@dhx/angular-gantt/dist/angular-gantt.css";
174+
~~~
175+
176+
Search the project for any remaining mentions of `@dhtmlx/trial-angular-gantt`, including the CSS import path - that one is the easiest to forget. Replace the dependency in `package.json`, then `npm install` and run the app. If the watermark is gone and the rest of the UI behaves identically, the swap is done.
177+
178+
### Using the registry from CI or shared build environments
179+
180+
`npm login` works fine on a developer machine, but CI runners and other shared build environments typically can't run an interactive login. For those, generate a non-interactive access token from a logged-in machine:
181+
182+
~~~bash
183+
npm token create --registry=https://npm.dhtmlx.com
184+
~~~
185+
186+
The token is printed once in the terminal output - copy it before closing the session, since it cannot be retrieved later. Then expose it through an `.npmrc` file that the build can read:
187+
188+
~~~ini
189+
@dhx:registry=https://npm.dhtmlx.com
190+
//npm.dhtmlx.com/:_authToken=${DHTMLX_NPM_TOKEN}
191+
~~~
192+
193+
Set `DHTMLX_NPM_TOKEN` as a secret in the CI provider (GitHub Actions, GitLab, etc.) so the token never gets committed. The same pattern works for Docker builds - inject the token at build time rather than baking it into the image.
194+
195+
If `npm install` fails on CI with a 401 or 403 against `npm.dhtmlx.com`, the secret is either missing, expired, or the `.npmrc` file isn't where npm expects it (the project root is the safest location).
196+
129197
## What To Read Next
130198

131199
- [Quick Start with Angular Gantt](integrations/angular/quick-start.md)

docs/integrations/vue/installation.md

Lines changed: 66 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,12 @@ description: "How to install the evaluation or professional version of Vue Gantt
66

77
# Installing Vue Gantt
88

9-
Use this page to install the official Vue wrapper package and pick the correct import paths.
9+
Vue Gantt is available in two distributions:
10+
11+
1. **Evaluation version** publicly available on npm, includes a trial watermark, and can optionally be paired with a free evaluation period that grants access to technical support.
12+
2. **Professional (commercial) version** available from the private DHTMLX npm repository and intended for production use.
13+
14+
Both packages contain the same API.
1015

1116
## Prerequisites
1217

@@ -15,15 +20,10 @@ Use this page to install the official Vue wrapper package and pick the correct i
1520
- npm or Yarn available
1621
- DHTMLX private npm access (professional package only)
1722

18-
## Choose The Package Channel
19-
20-
Vue Gantt is distributed in two package channels with the same wrapper API:
21-
22-
1. Evaluation package on public npm: `@dhtmlx/trial-vue-gantt`
23-
2. Professional package on DHTMLX private npm: `@dhx/vue-gantt`
24-
2523
## Install The Evaluation Package (Public npm)
2624

25+
The evaluation build is available on npm as [@dhtmlx/trial-vue-gantt](https://www.npmjs.com/package/@dhtmlx/trial-vue-gantt):
26+
2727
- npm:
2828

2929
~~~bash
@@ -36,16 +36,35 @@ npm install @dhtmlx/trial-vue-gantt
3636
yarn add @dhtmlx/trial-vue-gantt
3737
~~~
3838

39+
This build is fully functional, but shows a message indicating that the library is running in evaluation mode.
40+
41+
### Optional: Start a full evaluation period (recommended)
42+
43+
Although the trial package installs without restrictions, you may also start an official evaluation through the website at
44+
[https://dhtmlx.com/docs/products/dhtmlxGantt-for-Vuejs/download.shtml](https://dhtmlx.com/docs/products/dhtmlxGantt-for-Vuejs/download.shtml).
45+
46+
Starting a formal evaluation gives you free technical support during the trial period.
47+
48+
**Downloading offline examples (zip)**
49+
50+
The evaluation form also includes downloadable ZIP containing offline-ready examples.
51+
52+
You can also explore additional examples and demo projects on the official GitHub by checking [Vue Gantt Demos on GitHub](https://github.com/DHTMLX/?q=vue-gantt&type=all&language=&sort=).
53+
3954
## Install The Professional Package (Private npm)
4055

41-
Get private npm credentials in the [Client's Area](https://dhtmlx.com/clients/), then configure the registry and log in:
56+
The Professional version is used for production applications and includes commercial licensing and full access to technical support.
57+
58+
Once you obtain a commercial license, you can generate your private npm credentials in the [Client's Area](https://dhtmlx.com/clients/).
59+
60+
After generating your login/password, configure npm:
4261

4362
~~~bash
4463
npm config set @dhx:registry=https://npm.dhtmlx.com
4564
npm login --registry=https://npm.dhtmlx.com --scope=@dhx --auth-type=legacy
4665
~~~
4766

48-
Install the package:
67+
Then install the Professional package:
4968

5069
- npm:
5170

@@ -74,6 +93,43 @@ Wrapper peer dependency:
7493

7594
- `vue >= 3.2.25`
7695

96+
## Moving from the trial package to the commercial one
97+
98+
Most projects start on the trial package and switch later, once the prototype is approved and a commercial license is in place. Both packages share the same API, so the move is mostly mechanical: swap the package name, swap the CSS import, and reinstall.
99+
100+
After you've configured the private registry as shown above, update every import in the code:
101+
102+
~~~ts
103+
// before
104+
import VueGantt from "@dhtmlx/trial-vue-gantt";
105+
import "@dhtmlx/trial-vue-gantt/dist/vue-gantt.css";
106+
107+
// after
108+
import VueGantt from "@dhx/vue-gantt";
109+
import "@dhx/vue-gantt/dist/vue-gantt.css";
110+
~~~
111+
112+
Search the project for any remaining mentions of `@dhtmlx/trial-vue-gantt`, including the CSS import path - that one is the easiest to forget. Replace the dependency in `package.json`, then `npm install` and run the app. If the watermark is gone and the rest of the UI behaves identically, the swap is done.
113+
114+
### Using the registry from CI or shared build environments
115+
116+
`npm login` works fine on a developer machine, but CI runners and other shared build environments typically can't run an interactive login. For those, generate a non-interactive access token from a logged-in machine:
117+
118+
~~~bash
119+
npm token create --registry=https://npm.dhtmlx.com
120+
~~~
121+
122+
The token is printed once in the terminal output - copy it before closing the session, since it cannot be retrieved later. Then expose it through an `.npmrc` file that the build can read:
123+
124+
~~~ini
125+
@dhx:registry=https://npm.dhtmlx.com
126+
//npm.dhtmlx.com/:_authToken=${DHTMLX_NPM_TOKEN}
127+
~~~
128+
129+
Set `DHTMLX_NPM_TOKEN` as a secret in the CI provider (GitHub Actions, GitLab, etc.) so the token never gets committed. The same pattern works for Docker builds - inject the token at build time rather than baking it into the image.
130+
131+
If `npm install` fails on CI with a 401 or 403 against `npm.dhtmlx.com`, the secret is either missing, expired, or the `.npmrc` file isn't where npm expects it (the project root is the safest location).
132+
77133
## What To Read Next
78134

79135
- [Quick Start with Vue Gantt](integrations/vue/quick-start.md)

docs/integrations/vue/quick-start.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,18 @@ description: "Step-by-step guide to render the official Vue Gantt wrapper in a V
66

77
# Quick Start with Vue Gantt
88

9-
Use this quick start to render Vue Gantt in a Vue 3 + Vite app with a dedicated Gantt component and `data.save` callback wiring.
9+
:::note
10+
This tutorial covers the Vue wrapper included in the **Commercial, Enterprise, and Ultimate** editions of DHTMLX Gantt.
11+
If you are using the **Individual** or **GPL** edition, follow the alternative guide:
12+
[How to Start with Vue](integrations/vue/js-gantt-vue.md).
13+
:::
1014

11-
If you're new to Vue, start with the official [Vue documentation](https://vuejs.org/guide/introduction.html). Check [a complete working project that follows this tutorial on GitHub](https://github.com/DHTMLX/vue-gantt-quick-start).
15+
The **Vue Gantt** component is the official wrapper for **DHTMLX Gantt**.
16+
This guide walks you through creating a small Vue 3 + Vite application and rendering a basic Gantt chart using the trial package.
17+
18+
If you're new to Vue, start with the official [Vue documentation](https://vuejs.org/guide/introduction.html).
19+
20+
Check [a complete working project that follows this tutorial on GitHub](https://github.com/DHTMLX/vue-gantt-quick-start).
1221

1322
## Prerequisites
1423

@@ -29,13 +38,21 @@ If you prefer Yarn, replace the install step with `yarn`.
2938

3039
## 2. Install Vue Gantt
3140

32-
Install the evaluation package:
41+
Install Vue Gantt as described in the [Vue Gantt installation guide](integrations/vue/installation.md).
42+
43+
In this tutorial we use the evaluation package:
3344

3445
~~~bash
3546
npm install @dhtmlx/trial-vue-gantt
3647
~~~
3748

38-
If you use the professional package, replace `@dhtmlx/trial-vue-gantt` with `@dhx/vue-gantt` in commands and imports.
49+
or
50+
51+
~~~bash
52+
yarn add @dhtmlx/trial-vue-gantt
53+
~~~
54+
55+
If you already use the Professional package, replace `@dhtmlx/trial-vue-gantt` with `@dhx/vue-gantt` in the commands and imports.
3956

4057
## 3. Add Demo Data
4158

docs/integrations/vue/state/pinia.md

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,25 @@ import App from "./App.vue";
3333
createApp(App).use(createPinia()).mount("#app");
3434
~~~
3535

36-
## 2. Add Demo Data
36+
## 2. Install Vue Gantt
37+
38+
Install Vue Gantt as described in the [Vue Gantt installation guide](integrations/vue/installation.md).
39+
40+
In this tutorial we use the evaluation package:
41+
42+
~~~bash
43+
npm install @dhtmlx/trial-vue-gantt
44+
~~~
45+
46+
or
47+
48+
~~~bash
49+
yarn add @dhtmlx/trial-vue-gantt
50+
~~~
51+
52+
If you already use the Professional package, replace `@dhtmlx/trial-vue-gantt` with `@dhx/vue-gantt` in the commands and imports.
53+
54+
## 3. Add Demo Data
3755

3856
Create `src/demoData.ts`:
3957

@@ -64,7 +82,7 @@ export const tasks: SerializedTask[] = [
6482
export const links: SerializedLink[] = [{ id: 1, source: 1, target: 2, type: "0" }];
6583
~~~
6684

67-
## 3. Create A Basic Gantt Store
85+
## 4. Create A Basic Gantt Store
6886

6987
Create `src/stores/ganttStore.ts`:
7088

@@ -159,7 +177,7 @@ This store keeps one source of truth:
159177
- `config` is derived state
160178
- `applyBatch` is the wrapper callback entry point
161179

162-
## 4. Bind Store State To `VueGantt`
180+
## 5. Bind Store State To `VueGantt`
163181

164182
Create `src/components/GanttChart.vue`:
165183

@@ -204,7 +222,7 @@ This is the core wrapper wiring:
204222
- `batchSave` -> store action
205223
- store action -> new state -> wrapper props again
206224

207-
## 5. Render Gantt In The App Shell
225+
## 6. Render Gantt In The App Shell
208226

209227
Replace `src/App.vue`:
210228

@@ -220,7 +238,7 @@ import GanttChart from "./components/GanttChart.vue";
220238
</template>
221239
~~~
222240

223-
## 6. Verify The Data Flow
241+
## 7. Verify The Data Flow
224242

225243
Use this flow for predictable updates:
226244

@@ -232,13 +250,13 @@ Use this flow for predictable updates:
232250

233251
Do not mix this with direct instance mutations unless you also update the store.
234252

235-
## 7. (Optional) Add Store-Level Undo/Redo
253+
## 8. (Optional) Add Store-Level Undo/Redo
236254

237255
Use this if you want undo/redo while keeping Pinia as the source of truth.
238256

239257
Do not enable `gantt.plugins({ undo: true })` in this mode.
240258

241-
### 7.1 Replace The Store With A History Version
259+
### 8.1 Replace The Store With A History Version
242260

243261
Replace the store from step 2 with this version.
244262
It keeps state typed as `SerializedTask[]` / `SerializedLink[]` and avoids `as any` casts in date cloning.
@@ -409,7 +427,7 @@ export const useGanttStore = defineStore("gantt", {
409427
});
410428
~~~
411429

412-
### 7.2 Add Undo/Redo Buttons To The Component
430+
### 8.2 Add Undo/Redo Buttons To The Component
413431

414432
Update `src/components/GanttChart.vue`:
415433

@@ -450,7 +468,7 @@ const setZoom = (level: "day" | "month" | "year") => {
450468
</template>
451469
~~~
452470

453-
### 7.3 Why This Uses Store-Level History
471+
### 8.3 Why This Uses Store-Level History
454472

455473
Use store-level history here because the store is the source of truth:
456474

0 commit comments

Comments
 (0)