alighasami/vue-flow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: fix dead links

Browse Source
This commit is contained in:
braks
2022-08-01 21:10:14 +02:00
committed by Braks
parent f2b169145c
commit af78b52233
16 changed files with 165 additions and 165 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/src/guide/components/background.md
+12 -12
View File
@@ -14,16 +14,16 @@ To use the background simply pass the `Background` component as a child to the `
</template>
```
## [Props](/typedocs/interfaces/BackgroundProps.html/)
## [Props](/typedocs/interfaces/BackgroundProps)
| Name | Definition | Type | Optional | Default |
|--------------|-------------------|--------------------------------------------------------------|----------|---------|
| variant | Pattern variant | [BackgroundVariant](/typedocs/enums/BackgroundVariant.html/) | true | dots |
| gap | Pattern gap | number | true | 10 |
| size | Pattern size | number | true | 0.4 |
| patternColor | Pattern color | string | true | #81818a |
| bgColor | Is node dragging | boolean | true | #fff |
| height | Background height | number | true | 100 |
| width | Background width | number | true | 100 |
| x | X-offset | number | true | 0 |
| y | Y-offset | number | true | 0 |
| Name | Definition | Type | Optional | Default |
|--------------|-------------------|--------------------------------------------------------|----------|---------|
| variant | Pattern variant | [BackgroundVariant](/typedocs/enums/BackgroundVariant) | true | dots |
| gap | Pattern gap | number | true | 10 |
| size | Pattern size | number | true | 0.4 |
| patternColor | Pattern color | string | true | #81818a |
| bgColor | Is node dragging | boolean | true | #fff |
| height | Background height | number | true | 100 |
| width | Background width | number | true | 100 |
| x | X-offset | number | true | 0 |
| y | Y-offset | number | true | 0 |
docs/src/guide/components/control-button.md
+1 -1
View File
@@ -4,7 +4,7 @@ You can use the existing `ControlButton` component to create new control buttons
## Usage
To use the component pass the `ControlButton` component as a child to the [`Controls`](/guide/components/control-button.html/) component.
To use the component pass the `ControlButton` component as a child to the [`Controls`](/guide/components/control-button) component.
```vue
<template>
docs/src/guide/components/controls.md
+2 -2
View File
@@ -14,7 +14,7 @@ To use the controls simply pass the `Controls` component as a child to the `VueF
</template>
```
## [Props](/typedocs/interfaces/ControlProps.html/)
## [Props](/typedocs/interfaces/ControlProps)
| Name | Definition | Type | Optional | Default |
|-----------------|---------------------------|------------------------------------------------------|----------|---------|
@@ -22,7 +22,7 @@ To use the controls simply pass the `Controls` component as a child to the `VueF
| showFitView | Show fit-view btn | boolean | true | true |
| showInteractive | Show lock interactive btn | boolean | true | true |
| showZoom | Show zoom button | boolean | true | true |
| fitViewParams | Params to use on fit-view | [FitViewParams](/typedocs/types/FitViewParams.html/) | true | - |
| fitViewParams | Params to use on fit-view | [FitViewParams](/typedocs/types/FitViewParams) | true | - |
## Emits
docs/src/guide/components/minimap-node.md
+4 -4
View File
@@ -5,7 +5,7 @@ You can use it to add an icon to your node, or to add a custom tooltip etc.
## Usage
To use the component pass the `MiniMapNode` as a child to the [`MiniMap`](/guide/components/minimap.html/) component.
To use the component pass the `MiniMapNode` as a child to the [`MiniMap`](/guide/components/minimap) component.
```vue
<template>
@@ -19,7 +19,7 @@ To use the component pass the `MiniMapNode` as a child to the [`MiniMap`](/guide
</template>
```
## [Props](/typedocs/interfaces/MiniMapNodeProps.html/)
## [Props](/typedocs/interfaces/MiniMapNodeProps)
| Name | Definition | Type | Optional | Default |
|----------------|---------------------------------|-----------------------------------------------------|----------|---------|
@@ -27,8 +27,8 @@ To use the component pass the `MiniMapNode` as a child to the [`MiniMap`](/guide
| parentNode | Parent node id | string | true | - |
| selected | Is node selected | boolean | true | false |
| dragging | Is node dragging | boolean | true | false |
| position | XY position of node | [XYPosition](/typedocs/interfaces/XYPosition.html/) | false | - |
| dimensions | Node dimensions | [Dimensions](/typedocs/interfaces/Dimensions.html/) | false | - |
| position | XY position of node | [XYPosition](/typedocs/interfaces/XYPosition) | false | - |
| dimensions | Node dimensions | [Dimensions](/typedocs/interfaces/Dimensions) | false | - |
| borderRadius | MiniMap node css border-radius | number | true | - |
| color | MiniMap node css color | string | true | - |
| shapeRendering | MiniMap node css shapeRendering | ShapeRendering | true | - |
docs/src/guide/components/minimap.md
+5 -5
View File
@@ -12,13 +12,13 @@ To use the minimap simply pass the `MiniMap` component as a child to the `VueFlo
</template>
```
## [Props](/typedocs/interfaces/MiniMapProps.html/)
## [Props](/typedocs/interfaces/MiniMapProps)
| Name | Definition | Type | Optional | Default |
|------------------|--------------------------|------------------------------------------------------------------|----------|-------------------------|
| nodeColor | Node(s) Background color | string, [MiniMapNodeFunc](/typedocs/types/MiniMapNodeFunc.html/) | true | #fff |
| nodeStrokeColor | Border color | string, [MiniMapNodeFunc](/typedocs/types/MiniMapNodeFunc.html/) | true | #555 |
| nodeClassName | Extra classes | string, [MiniMapNodeFunc](/typedocs/types/MiniMapNodeFunc.html/) | true | - |
| nodeColor | Node(s) Background color | string, [MiniMapNodeFunc](/typedocs/types/MiniMapNodeFunc) | true | #fff |
| nodeStrokeColor | Border color | string, [MiniMapNodeFunc](/typedocs/types/MiniMapNodeFunc) | true | #555 |
| nodeClassName | Extra classes | string, [MiniMapNodeFunc](/typedocs/types/MiniMapNodeFunc) | true | - |
| nodeBorderRadius | Border radius | number | true | 5 |
| nodeStrokeWidth | Stroke width | number | true | 2 |
| maskColor | Minimap Background color | string | true | rgb(240, 242, 243, 0.7) |
@@ -27,4 +27,4 @@ To use the minimap simply pass the `MiniMap` component as a child to the `VueFlo
| Name | Definition | Props | Default |
|---------------------|-------------------|-----------------------------------------------------------------|-----------------------------------------------------|
| `node-${node.type}` | MiniMap Node slot | [MiniMapNodeProps](/typedocs/interfaces/MiniMapNodeProps.html/) | [MiniMapNode](/guide/components/minimap-node.html/) |
| `node-${node.type}` | MiniMap Node slot | [MiniMapNodeProps](/typedocs/interfaces/MiniMapNodeProps) | [MiniMapNode](/guide/components/minimap-node) |