Skip to content

Commit

Permalink
docs: replace old typedoc links
Browse files Browse the repository at this point in the history
  • Loading branch information
@bcakmakoglu
bcakmakoglu committed Jun 15, 2022
1 parent 06420ac commit e469708
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 29 deletions.
2 changes: 1 addition & 1 deletion docs/src/.vuepress/theme/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ export default {
]
},
{
text: 'Additional Components',
text: 'Components',
children: [
'/guide/components/background',
'/guide/components/minimap',
Expand Down
22 changes: 11 additions & 11 deletions docs/src/guide/components/background.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ To use the background simply pass the `Background` component as a child to the `

## Props

| Name | Definition | Type | Optional | Default |
|--------------|-------------------|-----------------------------------------------------------------------------|----------|---------|
| variant | Pattern variant | [BackgroundVariant](https://types.vueflow.dev/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.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 |
4 changes: 2 additions & 2 deletions docs/src/guide/components/control-button.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ To use the component pass the `ControlButton` component as a child to the [`Cont

## Slots

| Name | Definition |
|---------|------------------------------------------------------|
| Name | Definition |
|---------|--------------------------------------------------------|
| default | inner slot of btn (is wrapped by a `<button>` element) |

14 changes: 7 additions & 7 deletions docs/src/guide/components/controls.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ To use the controls simply pass the `Controls` component as a child to the `VueF

## Props

| Name | Definition | Type | Optional | Default |
|-----------------|---------------------------|-----------------------------------------------------------------------|----------|---------|
| showZoom | Show zoom btn | boolean | true | true |
| 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](https://types.vueflow.dev/modules.html#FitViewParams) | true | - |
| Name | Definition | Type | Optional | Default |
|-----------------|---------------------------|------------------------------------------------------|----------|---------|
| showZoom | Show zoom btn | boolean | true | true |
| 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 | - |

## Emits

Expand Down
22 changes: 14 additions & 8 deletions docs/src/guide/components/minimap.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,17 @@ To use the minimap simply pass the `MiniMap` component as a child to the `VueFlo

## Props

| Name | Definition | Type | Optional | Default |
|------------------|--------------------------|------------------------------------------------------------------------------|----------|-------------------------|
| nodeColor | Node(s) Background color | string, [MiniMapNodeFunc](https://types.vueflow.dev/modules.html#StringFunc) | true | #fff |
| nodeStrokeColor | Border color | string, [MiniMapNodeFunc](https://types.vueflow.dev/modules.html#StringFunc) | true | #555 |
| nodeClassName | Extra classes | string, [MiniMapNodeFunc](https://types.vueflow.dev/modules.html#StringFunc) | 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) |
| 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 | - |
| nodeBorderRadius | Border radius | number | true | 5 |
| nodeStrokeWidth | Stroke width | number | true | 2 |
| maskColor | Minimap Background color | string | true | rgb(240, 242, 243, 0.7) |

## Slots

| Name | Definition | Props | Default |
|---------------------|-------------------|-----------------------------------------------------------------|-----------------------------------------------------|
| `node-${node.type}` | MiniMap Node slot | [MiniMapNodeProps](/typedocs/interfaces/MiniMapNodeProps.html/) | [MiniMapNode](/guide/components/minimap-node.html/) |

0 comments on commit e469708

Please sign in to comment.