From f386ea454c23eead3c995f96d9087217d2ba2db4 Mon Sep 17 00:00:00 2001 From: braks <78412429+bcakmakoglu@users.noreply.github.com> Date: Sat, 30 Jul 2022 16:30:59 +0200 Subject: [PATCH] docs: replace vuepress specific components --- docs/components/home/Features.vue | 9 +- docs/components/home/flows/Additional.vue | 2 +- docs/components/home/flows/Basic.vue | 2 +- docs/components/home/flows/Nested.vue | 2 +- docs/components/home/flows/RGB.vue | 2 +- docs/src/examples/dnd.md | 4 +- docs/src/examples/edges/connection-line.md | 4 +- docs/src/examples/edges/index.md | 4 +- docs/src/examples/edges/updatable-edge.md | 4 +- docs/src/examples/edges/validation.md | 4 +- docs/src/examples/empty.md | 4 +- docs/src/examples/hidden.md | 4 +- docs/src/examples/horizontal.md | 4 +- docs/src/examples/index.md | 4 +- docs/src/examples/interaction.md | 4 +- docs/src/examples/multi.md | 4 +- docs/src/examples/nodes/index.md | 4 +- docs/src/examples/nodes/nesting.md | 4 +- docs/src/examples/nodes/update-node.md | 4 +- docs/src/examples/save.md | 4 +- docs/src/examples/stress.md | 4 +- docs/src/examples/teleport.md | 4 +- docs/src/guide/getting-started.md | 44 +------- docs/src/guide/utils/instance.md | 11 +- docs/src/guide/vue-flow/config.md | 112 +++++++++------------ docs/src/index.md | 3 +- 26 files changed, 99 insertions(+), 156 deletions(-) diff --git a/docs/components/home/Features.vue b/docs/components/home/Features.vue index 81a2bf7f..e9503cf3 100644 --- a/docs/components/home/Features.vue +++ b/docs/components/home/Features.vue @@ -1,10 +1,11 @@ ``` - - - - +- Using Event Listener ```vue ``` - - - ## Updating Config You can update the configuration at any point, either by having them bound as props or using the state values returned by `useVueFlow`. - - +- Using Component Props ```vue{2,5-6,10} ``` - - - ## Basic Options -### id +### id (optional) - Type: `string` @@ -89,7 +75,7 @@ onMounted(() => { It is used for the lookup and injection of the state instance. -### modelValue +### modelValue (optional) - Type: [`Elements`](/typedocs/types/Elements) @@ -121,7 +107,7 @@ const elements = ref([ ``` -### nodes +### nodes (optional) - Type: [`Node[]`](/typedocs/interfaces/Node) @@ -151,7 +137,7 @@ const nodes = ref([ ``` -### edges +### edges (optional) - Type: [`Edge[]`](/typedocs/interfaces/Edge) @@ -186,7 +172,7 @@ const edges = ref([ ``` -### node-types +### node-types (optional) - Type: [`Record`](/typedocs/types/NodeComponent) @@ -223,7 +209,7 @@ const edges = ref([ ``` -### edge-types +### edge-types (optional) - Type: [`Record`](/typedocs/types/EdgeComponent) @@ -260,7 +246,7 @@ const edges = ref([ ``` -### apply-default +### apply-default (optional) - Type: `boolean` @@ -295,7 +281,7 @@ const edges = ref([ ``` -### connection-mode +### connection-mode (optional) - Type: [`ConnectionMode`](/typedocs/enums/ConnectionMode) @@ -315,7 +301,7 @@ const edges = ref([ The options include the connection line type, style and possible marker types (marker-end/marker-start). -### connection-line-type +### connection-line-type (optional) (deprecated) - Type: [`ConnectionLineType`](/typedocs/enums/ConnectionLineType) @@ -327,7 +313,7 @@ const edges = ref([ When using a custom connection line this prop does nothing. -### connection-line-style +### connection-line-style (optional) (deprecated) - Type: `CSSProperties` | `null` @@ -335,7 +321,7 @@ const edges = ref([ Additional styles to add to the default connection-line. -### fit-view-on-init +### fit-view-on-init (optional) - Type: `boolean` @@ -347,7 +333,7 @@ const edges = ref([ ## Viewport Options -### zoom-activation-key-code +### zoom-activation-key-code (optional) - Type: `KeyCode` @@ -359,7 +345,7 @@ const edges = ref([ Overwrites zoom-on-scroll or pan-on-scroll behavior as long as the key is pressed. -### zoom-on-scroll +### zoom-on-scroll (optional) - Type: `boolean` @@ -369,7 +355,7 @@ const edges = ref([ Whether to allow zooming in and out when scrolling inside the Vue Flow container. -### zoom-on-pinch +### zoom-on-pinch (optional) - Type: `boolean` @@ -379,7 +365,7 @@ const edges = ref([ Whether to allow zooming in and out when pinching (touch or trackpad) inside the Vue Flow container. -### zoom-on-double-click +### zoom-on-double-click (optional) - Type: `boolean` @@ -389,7 +375,7 @@ const edges = ref([ Whether to allow zooming in and out when double-clicking (or tapping) inside the Vue Flow container. -### pan-on-scroll +### pan-on-scroll (optional) - Type: `boolean` @@ -401,13 +387,13 @@ const edges = ref([ Does not work together with `zoom-on-scroll` but will work together with `zoom-activation-key-code`. -### pan-on-scroll-speed +### pan-on-scroll-speed (optional) - Type: `number` - Default: `0.5` -### pan-on-scroll-mode +### pan-on-scroll-mode (optional) - Type: [`PanOnScrollMode`](/typedocs/enums/PanOnScrollMode) @@ -417,7 +403,7 @@ const edges = ref([ Specify on which axis panning is allowed (x, y or both). -### pan-on-drag +### pan-on-drag (optional) - Old name: `paneMovable` @@ -429,7 +415,7 @@ const edges = ref([ Whether to allow moving the pane when dragging inside the Vue Flow container. -### prevent-scrolling +### prevent-scrolling (optional) - Type: `boolean` @@ -439,7 +425,7 @@ const edges = ref([ Enable this to prevent vue flow from scrolling inside its container, i.e. allow for the page to scroll. -### no-wheel-class-name +### no-wheel-class-name (optional) - Type: `string` @@ -452,7 +438,7 @@ const edges = ref([ Useful if you want to allow for scrolling _inside_ a node -### no-pan-class-name +### no-pan-class-name (optional) - Type: `string` @@ -462,25 +448,25 @@ const edges = ref([ Set a class name which prevents elements from triggering pan-scroll events. -### min-zoom +### min-zoom (optional) - Type: `number` - Default: `0.5` -### max-zoom +### max-zoom (optional) - Type: `number` - Default: `2` -### default-zoom +### default-zoom (optional) - Type: `number` - Default: `1` -### default-position +### default-position (optional) - Type: `[x: number, y: number]` @@ -490,7 +476,7 @@ const edges = ref([ Default viewport position on initial load. -### translate-extent +### translate-extent (optional) - Type: [`CoordinateExtent`](/typedocs/types/CoordinateExtent) @@ -509,7 +495,7 @@ const edges = ref([ ## Selection Options -### selection-key-code +### selection-key-code (optional) - Type: `KeyCode` @@ -519,7 +505,7 @@ const edges = ref([ Define a key which can be used to activate the selection rect. -### multi-selection-key-code +### multi-selection-key-code (optional) - Type: `KeyCode` @@ -531,7 +517,7 @@ const edges = ref([ Multi-selection can be used to select multiple nodes with clicks. -### delete-key-code +### delete-key-code (optional) - Type: `KeyCode` @@ -543,7 +529,7 @@ const edges = ref([ ## Global Node Options -### nodes-draggable +### nodes-draggable (optional) - Type: `boolean` @@ -571,7 +557,7 @@ const elements = ref([ ``` -### nodes-connectable +### nodes-connectable (optional) - Type: `boolean` @@ -599,7 +585,7 @@ const elements = ref([ ``` -### nodes-extent +### nodes-extent (optional) - Type: [`CoordinateExtent`](/typedocs/types/CoordinateExtent) @@ -634,13 +620,13 @@ const elements = ref([ ``` -### select-nodes-on-drag +### select-nodes-on-drag (optional) - Type: `boolean` - Default: `true` -### snap-to-grid +### snap-to-grid (optional) - Type: `boolean` @@ -650,7 +636,7 @@ const elements = ref([ If enabled, nodes will be placed and moved in a grid-like fashion. -### snap-grid +### snap-grid (optional) - Type: [`SnapGrid`](/typedocs/types/SnapGrid) @@ -662,7 +648,7 @@ const elements = ref([ ## Global Edge Options -### edges-updatable +### edges-updatable (optional) - Type: `boolean` @@ -692,7 +678,7 @@ const elements = ref([ ``` -### default-marker-color +### default-marker-color (optional) - Type: `string` @@ -702,7 +688,7 @@ const elements = ref([ The default color value which is used when presenting edge-markers (arrowheads). -### edge-updater-radius +### edge-updater-radius (optional) - Type: `number` @@ -712,7 +698,7 @@ const elements = ref([ The radius at which an edge-updater can be triggered. -### connect-on-click +### connect-on-click (optional) - Type: `boolean` @@ -724,7 +710,7 @@ const elements = ref([ Useful if you want to enable creating edges on a touch device. -### default-edge-options +### default-edge-options (optional) - Type: [`DefaultEdgeOptions`](/typedocs/types/DefaultEdgeOptions) @@ -734,7 +720,7 @@ const elements = ref([ Does not work for the `addEdge` utility! -### auto-connect +### auto-connect (optional) - Type: `boolean` | [`Connector`](/typedocs/types/Connector) @@ -787,7 +773,7 @@ const connector = (params) => { ``` -### elevate-edges-on-select +### elevate-edges-on-select (optional) - Type: `boolean` @@ -803,7 +789,7 @@ const connector = (params) => { ## Global Element Options -### only-render-visible-elements +### only-render-visible-elements (optional) - Type: `boolean` @@ -813,7 +799,7 @@ const connector = (params) => { Skip rendering elements that are not visible currently (either hidden or outside the current pane dimensions). -### elements-selectable +### elements-selectable (optional) - Type: `boolean` diff --git a/docs/src/index.md b/docs/src/index.md index 38171587..dabc01bc 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,7 +1,6 @@ --- layout: home -heroText: null -tagline: null + ---