Skip to content

Commit 473c5cb

Browse files
Merge pull request #36 from DHTMLX/next
[dev] Update doc engine to v3.9.1 and node to v20
2 parents 39fd157 + 551b064 commit 473c5cb

File tree

5 files changed

+25
-13
lines changed

5 files changed

+25
-13
lines changed

.github/workflows/main.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ name: Deploy To Site
66
on:
77
# Triggers the workflow on push or pull request events but only for the master branch
88
push:
9-
branches: [ master, next, test ]
9+
branches: [master, next, test]
1010

1111
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
1212
jobs:
@@ -24,7 +24,7 @@ jobs:
2424

2525
- uses: actions/setup-node@v4
2626
with:
27-
node-version: '18.19.0'
27+
node-version: "20.0"
2828

2929
- run: yarn install
3030
- run: yarn build

docs/api/internal/intercept-method.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,17 @@ description: You can learn about the intercept method in the documentation of th
1515
~~~jsx
1616
api.intercept(
1717
event: string,
18-
callback: function
18+
callback: function,
19+
config?: { tag?: number | string | symbol }
1920
): void;
2021
~~~
2122

2223
### Parameters
2324

24-
- `event` - (required) an event to be fired
25+
- `event` - (required) an event to be fired
2526
- `callback` - (required) a callback to be performed (the callback arguments will depend on the event to be fired)
27+
- `config` - (optional) an object that stores the following parameter:
28+
- `tag` - (optional) an action tag. You can use the tag name to remove an action handler via the [`detach`](api/internal/js_kanban_detach_method.md) method
2629

2730
### Events
2831

@@ -59,7 +62,7 @@ const table = new pivot.Pivot("#root", {
5962
//make all rows close at the initialization
6063
table.api.intercept("render-table", (ev) => {
6164
ev.config.data.forEach((row) => (row.open = false));
62-
})
65+
}, {tag: "render-table-tag"});
6366
~~~
6467

6568
**Related articles**: [`render-table`](/api/events/render-table-event)

docs/api/internal/on-method.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,18 @@ description: You can learn about the on method in the documentation of the DHTML
1515
~~~jsx
1616
api.on(
1717
event: string,
18-
handler: function
18+
handler: function,
19+
config?: { intercept?: boolean, tag?: number | string | symbol }
1920
): void;
2021
~~~
2122

2223
### Parameters
2324

2425
- `event` - (required) an event to be fired
2526
- `handler` - (required) a handler to be attached (the handler arguments will depend on the event to be fired)
27+
- `config` - (optional) an object that stores the following parameters:
28+
- `intercept` - (optional) if you set `intercept: true` during event listener creation, this event listener will run before all others
29+
- `tag` - (optional) an action tag. You can use the tag name to remove an action handler via the [`detach`](api/internal/js_kanban_detach_method.md) method
2630

2731
### Events
2832

@@ -63,5 +67,5 @@ table.api.on("open-filter", (ev) => {
6367
if (field) {
6468
console.log("The field for which filter was activated:", ev.field.label);
6569
}
66-
});
70+
}, {tag: "open-filter-tag"});
6771
~~~

docusaurus.config.js

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,11 +138,16 @@ const config = {
138138
url: 'https://docs.dhtmlx.com',
139139
baseUrl: '/pivot/',
140140
onBrokenLinks: 'warn',
141-
onBrokenMarkdownLinks: 'warn',
141+
// onBrokenMarkdownLinks: 'warn', // deprecated in v3.9.1
142142
favicon: 'img/favicon.ico',
143143
organizationName: 'DHTMLX', // Usually your GitHub org/user name.
144144
projectName: 'docs-pivot', // Usually your repo name.
145145
trailingSlash: true,
146+
markdown: {
147+
hooks: {
148+
onBrokenMarkdownLinks: 'warn',
149+
}
150+
},
146151
presets: [
147152
[
148153
'@docusaurus/preset-classic',

package.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@
1414
"write-heading-ids": "docusaurus write-heading-ids"
1515
},
1616
"dependencies": {
17-
"@docusaurus/core": "^3.7.0",
18-
"@docusaurus/preset-classic": "^3.7.0",
17+
"@docusaurus/core": "^3.9.1",
18+
"@docusaurus/preset-classic": "^3.9.1",
1919
"@easyops-cn/docusaurus-search-local": "^0.44.5",
2020
"@mdx-js/react": "^3.0.0",
2121
"@svgr/webpack": "^5.5.0",
@@ -29,13 +29,13 @@
2929
"url-loader": "^4.1.1"
3030
},
3131
"devDependencies": {
32-
"@docusaurus/module-type-aliases": "^3.7.0",
33-
"@docusaurus/types": "^3.7.0",
32+
"@docusaurus/module-type-aliases": "^3.9.1",
33+
"@docusaurus/types": "^3.9.1",
3434
"dhx-md-data-parser": "file:local_modules/dhx-md-data-parser",
3535
"docusaurus-plugin-sass": "^0.2.5"
3636
},
3737
"engines": {
38-
"node": ">=18.0"
38+
"node": ">=20.0"
3939
},
4040
"browserslist": {
4141
"production": [

0 commit comments

Comments
 (0)