Skip to content

Commit 564d593

Browse files
bcakmakoglubcakmakoglu
authored
chore(docs,deps): update deps (#1598)
* chore(docs,deps): update deps Signed-off-by: braks <[email protected]> * chore(docs,plugins): update web vitals plugin Signed-off-by: braks <[email protected]> * chore(docs): update links Signed-off-by: braks <[email protected]> --------- Signed-off-by: braks <[email protected]>
1 parent f24230a commit 564d593

File tree

17 files changed

+1190
-890
lines changed

17 files changed

+1190
-890
lines changed

‎docs/package.json

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@
1111
"typedocs": "typedoc --options ./typedoc.json"
1212
},
1313
"dependencies": {
14-
"@algolia/client-search": "^4.23.3",
15-
"@stackblitz/sdk": "^1.10.0",
16-
"@vercel/analytics": "^1.1.2",
17-
"@vercel/speed-insights": "^1.0.8",
14+
"@algolia/client-search": "^5.1.1",
15+
"@stackblitz/sdk": "^1.11.0",
16+
"@vercel/analytics": "^1.3.1",
17+
"@vercel/speed-insights": "^1.0.12",
1818
"@vue-flow/background": "workspace:*",
1919
"@vue-flow/controls": "workspace:*",
2020
"@vue-flow/core": "workspace:*",
@@ -23,24 +23,24 @@
2323
"@vue-flow/node-toolbar": "workspace:*",
2424
"@vue/repl": "3.4.0",
2525
"blobity": "^0.2.3",
26-
"vue": "^3.3.11",
27-
"web-vitals": "^3.5.2"
26+
"vue": "^3.4.38",
27+
"web-vitals": "^4.2.3"
2828
},
2929
"devDependencies": {
30-
"@iconify/json": "^2.2.217",
30+
"@iconify/json": "^2.2.241",
3131
"@tooling/eslint-config": "workspace:*",
3232
"@tooling/tsconfig": "workspace:*",
3333
"@windicss/plugin-scrollbar": "^1.2.3",
3434
"dotenv": "^16.4.5",
3535
"ohmyfetch": "^0.4.21",
36-
"typedoc": "^0.25.7",
37-
"typedoc-plugin-markdown": "^3.17.1",
38-
"typedoc-plugin-merge-modules": "^5.1.0",
39-
"unplugin-auto-import": "^0.17.6",
40-
"unplugin-icons": "^0.19.0",
41-
"unplugin-vue-components": "^0.27.0",
36+
"typedoc": "^0.26.6",
37+
"typedoc-plugin-markdown": "^4.2.6",
38+
"typedoc-plugin-merge-modules": "^6.0.0",
39+
"unplugin-auto-import": "^0.18.2",
40+
"unplugin-icons": "^0.19.2",
41+
"unplugin-vue-components": "^0.27.4",
4242
"vite-plugin-windicss": "^1.9.3",
43-
"vitepress": "1.2.3",
43+
"vitepress": "^1.3.4",
4444
"windicss": "^3.5.6"
4545
}
4646
}

‎docs/src/.vitepress/plugins/vercel-web-vitals-api.ts

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { getCLS, getFCP, getFID, getLCP, getTTFB } from 'web-vitals'
1+
import { onCLS, onFCP, onFID, onINP, onLCP, onTTFB } from 'web-vitals'
22

33
const vitalsUrl = 'https://vitals.vercel-analytics.com/v1/vitals'
44

@@ -43,11 +43,12 @@ function sendToAnalytics(metric, options) {
4343

4444
export function webVitals(options) {
4545
try {
46-
getFID((metric) => sendToAnalytics(metric, options))
47-
getTTFB((metric) => sendToAnalytics(metric, options))
48-
getLCP((metric) => sendToAnalytics(metric, options))
49-
getCLS((metric) => sendToAnalytics(metric, options))
50-
getFCP((metric) => sendToAnalytics(metric, options))
46+
onFID((metric) => sendToAnalytics(metric, options))
47+
onTTFB((metric) => sendToAnalytics(metric, options))
48+
onLCP((metric) => sendToAnalytics(metric, options))
49+
onCLS((metric) => sendToAnalytics(metric, options))
50+
onFCP((metric) => sendToAnalytics(metric, options))
51+
onINP((metric) => sendToAnalytics(metric, options))
5152
} catch (err) {
5253
console.error('[Analytics]', err)
5354
}

‎docs/src/guide/components/background.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,14 @@ import { Background } from '@vue-flow/background'
3030

3131
## [Props](/typedocs/interfaces/BackgroundProps)
3232

33-
| Name | Definition | Type | Optional | Default |
34-
|--------------|---------------------------------------|--------------------------------------------------------|----------|---------|
35-
| variant | Pattern variant | [BackgroundVariant](/typedocs/enums/BackgroundVariant) | true | dots |
36-
| gap | Pattern gap | number | true | 10 |
37-
| size | Pattern size | number | true | 0.4 |
38-
| patternColor | Pattern color | string | true | #81818a |
39-
| bgColor | Background color (overwrites pattern) | string | true | #fff |
40-
| height | Background height | number | true | 100 |
41-
| width | Background width | number | true | 100 |
42-
| x | X-offset | number | true | 0 |
43-
| y | Y-offset | number | true | 0 |
33+
| Name | Definition | Type | Optional | Default |
34+
|--------------|---------------------------------------|---------------------------------------------------------------|----------|---------|
35+
| variant | Pattern variant | [BackgroundVariant](/typedocs/enumerations/BackgroundVariant) | true | dots |
36+
| gap | Pattern gap | number | true | 10 |
37+
| size | Pattern size | number | true | 0.4 |
38+
| patternColor | Pattern color | string | true | #81818a |
39+
| bgColor | Background color (overwrites pattern) | string | true | #fff |
40+
| height | Background height | number | true | 100 |
41+
| width | Background width | number | true | 100 |
42+
| x | X-offset | number | true | 0 |
43+
| y | Y-offset | number | true | 0 |

‎docs/src/guide/components/controls.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ import '@vue-flow/controls/dist/style.css'
4444
| showFitView | Show fit-view btn | boolean | true | true |
4545
| showInteractive | Show lock interactive btn | boolean | true | true |
4646
| showZoom | Show zoom button | boolean | true | true |
47-
| fitViewParams | Params to use on fit-view button click | [FitViewParams](/typedocs/types/FitViewParams) | true | - |
47+
| fitViewParams | Params to use on fit-view button click | [FitViewParams](/typedocs/type-aliases/FitViewParams) | true | - |
4848

4949
## Emits
5050

‎docs/src/guide/components/minimap.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@ When enabled, these props allow you to pan on drag and zoom on scroll using the
5151

5252
| Name | Definition | Type | Optional | Default |
5353
|------------------|------------------------------|------------------------------------------------------------|----------|-------------------------|
54-
| nodeColor | Node(s) Background color | string, [MiniMapNodeFunc](/typedocs/types/MiniMapNodeFunc) | true | #fff |
55-
| nodeStrokeColor | Border color | string, [MiniMapNodeFunc](/typedocs/types/MiniMapNodeFunc) | true | #555 |
56-
| nodeClassName | Extra classes | string, [MiniMapNodeFunc](/typedocs/types/MiniMapNodeFunc) | true | - |
54+
| nodeColor | Node(s) Background color | string, [MiniMapNodeFunc](/typedocs/type-aliases/MiniMapNodeFunc) | true | #fff |
55+
| nodeStrokeColor | Border color | string, [MiniMapNodeFunc](/typedocs/type-aliases/MiniMapNodeFunc) | true | #555 |
56+
| nodeClassName | Extra classes | string, [MiniMapNodeFunc](/typedocs/type-aliases/MiniMapNodeFunc) | true | - |
5757
| nodeBorderRadius | Border radius | number | true | 5 |
5858
| nodeStrokeWidth | Stroke width | number | true | 2 |
5959
| maskColor | Minimap Background color | string | true | rgb(240, 242, 243, 0.7) |

‎docs/src/guide/components/node-toolbar.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ defineProps<Props>()
7070
|-----------------|---------------------------------------------------|--------------------------------------|----------|-------------------------|
7171
| nodeId | Node(s) the toolbar is supposed to be attached to | string array | true | NodeId from context |
7272
| isVisible | Force visibility of toolbar | boolean | true | Selected node |
73-
| position | Toolbar position (top, left, right, bottom) | [Position](/typedocs/enums/Position) | true | Top |
73+
| position | Toolbar position (top, left, right, bottom) | [Position](/typedocs/enumerations/Position) | true | Top |
7474
| offset | Offset of toolbar position | number | true | 10 |
7575

7676
## Slots

‎docs/src/guide/controlled-flow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Though, there are cases where you want to take control of changes and apply them
1414

1515
In this guide, we will learn how to take control of changes and apply them manually.
1616

17-
## What is a [Change](https://vueflow.dev/typedocs/types/NodeChange.html)?
17+
## What is a [Change](https://vueflow.dev/typedocs/type-aliases/NodeChange.html)?
1818

1919
A *change* is anything that is triggered by an interaction with the flow, like adding, updating (position, selected), or removing a node or an edge, either
2020
by dragging, clicking etc. or by using the provided API.

‎docs/src/guide/edge.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Each edge runs from one handle to another, and can be customized to your liking.
8686

8787
Remember, every edge is unique and thus **requires a unique id**, a source and target node id.
8888

89-
For the full list of options available for an edge, check out the [Edge Type](/typedocs/types/Edge).
89+
For the full list of options available for an edge, check out the [Edge Type](/typedocs/type-aliases/Edge).
9090

9191
## Adding Edges to the Graph
9292

@@ -801,8 +801,8 @@ But you may wish to expand on these features or implement your business logic in
801801
| label | Edge label, can be a string or a VNode | string \| VNode \| Component \| Object | <Check class="text-[var(--vp-c-brand)]" /> |
802802
| style | CSS properties | CSSProperties | <Check class="text-[var(--vp-c-brand)]" /> |
803803
| selected | Is edge selected | boolean | <Check class="text-[var(--vp-c-brand)]" /> |
804-
| sourcePosition | Source position | [Position](/typedocs/enums/Position) | <Close class="text-red-500" /> |
805-
| targetPosition | Target position | [Position](/typedocs/enums/Position) | <Close class="text-red-500" /> |
804+
| sourcePosition | Source position | [Position](/typedocs/enumerations/Position) | <Close class="text-red-500" /> |
805+
| targetPosition | Target position | [Position](/typedocs/enumerations/Position) | <Close class="text-red-500" /> |
806806
| sourceHandleId | ID of the source handle | string | <Check class="text-[var(--vp-c-brand)]" /> |
807807
| targetHandleId | ID of the target handle | string | <Check class="text-[var(--vp-c-brand)]" /> |
808808
| animated | Is edge animated | boolean | <Check class="text-[var(--vp-c-brand)]" /> |
@@ -812,7 +812,7 @@ But you may wish to expand on these features or implement your business logic in
812812
| curvature | The curvature of the edge | number | <Check class="text-[var(--vp-c-brand)]" /> |
813813
| interactionWidth | Width of the interaction area for the edge | number | <Check class="text-[var(--vp-c-brand)]" /> |
814814
| data | Additional data of edge | any object | <Close class="text-red-500" /> |
815-
| events | Contextual and custom events of edge | [EdgeEventsOn](/typedocs/types/EdgeEventsOn) | <Close class="text-red-500" /> |
815+
| events | Contextual and custom events of edge | [EdgeEventsOn](/typedocs/type-aliases/EdgeEventsOn) | <Close class="text-red-500" /> |
816816

817817
## Edge Events
818818

‎docs/src/guide/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ $ yarn add @vue-flow/core
4949

5050
## Quick Start
5151

52-
In Vue Flow, a graph consists of [**nodes**](/typedocs/interfaces/Node) and [**edges**](/typedocs/types/Edge).
52+
In Vue Flow, a graph consists of [**nodes**](/typedocs/interfaces/Node) and [**edges**](/typedocs/type-aliases/Edge).
5353

5454
**Each node or edge requires a unique id.**
5555

‎docs/src/guide/handle.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ Upon mounting, handles will automatically attempt to attach to the node.
172172
However, if for any reason this isn't happening as expected, you can stick to the guideline provided below to enforce Vue Flow to update the node internals.
173173
:::
174174

175-
At times, you may need to modify handle positions dynamically or programmatically add new handles to a node. In this scenario, the [`updateNodeInternals`](/typedocs/types/UpdateNodeInternals) method found in Vue Flow's API comes in handy.
175+
At times, you may need to modify handle positions dynamically or programmatically add new handles to a node. In this scenario, the [`updateNodeInternals`](/typedocs/type-aliases/UpdateNodeInternals) method found in Vue Flow's API comes in handy.
176176

177177
Invoking this method is vital when dealing with dynamic handles. If not, the node might fail to recognize these new handles, resulting in misaligned edges.
178178

0 commit comments

Comments
 (0)