diff --git a/docs/src/auto-imports.d.ts b/docs/src/auto-imports.d.ts index f7f8b0ea..1c40ac41 100644 --- a/docs/src/auto-imports.d.ts +++ b/docs/src/auto-imports.d.ts @@ -19,7 +19,9 @@ declare global { const createGlobalState: typeof import('@vueuse/core')['createGlobalState'] const createInjectionState: typeof import('@vueuse/core')['createInjectionState'] const createReactiveFn: typeof import('@vueuse/core')['createReactiveFn'] + const createReusableTemplate: typeof import('@vueuse/core')['createReusableTemplate'] const createSharedComposable: typeof import('@vueuse/core')['createSharedComposable'] + const createTemplatePromise: typeof import('@vueuse/core')['createTemplatePromise'] const createUnrefFn: typeof import('@vueuse/core')['createUnrefFn'] const customRef: typeof import('vue')['customRef'] const debouncedRef: typeof import('@vueuse/core')['debouncedRef'] @@ -87,8 +89,9 @@ declare global { const throttledWatch: typeof import('@vueuse/core')['throttledWatch'] const toRaw: typeof import('vue')['toRaw'] const toReactive: typeof import('@vueuse/core')['toReactive'] - const toRef: typeof import('vue')['toRef'] + const toRef: typeof import('@vueuse/core')['toRef'] const toRefs: typeof import('vue')['toRefs'] + const toValue: typeof import('@vueuse/core')['toValue'] const triggerRef: typeof import('vue')['triggerRef'] const tryOnBeforeMount: typeof import('@vueuse/core')['tryOnBeforeMount'] const tryOnBeforeUnmount: typeof import('@vueuse/core')['tryOnBeforeUnmount'] @@ -99,11 +102,14 @@ declare global { const unrefElement: typeof import('@vueuse/core')['unrefElement'] const until: typeof import('@vueuse/core')['until'] const useActiveElement: typeof import('@vueuse/core')['useActiveElement'] + const useAnimate: typeof import('@vueuse/core')['useAnimate'] + const useArrayDifference: typeof import('@vueuse/core')['useArrayDifference'] const useArrayEvery: typeof import('@vueuse/core')['useArrayEvery'] const useArrayFilter: typeof import('@vueuse/core')['useArrayFilter'] const useArrayFind: typeof import('@vueuse/core')['useArrayFind'] const useArrayFindIndex: typeof import('@vueuse/core')['useArrayFindIndex'] const useArrayFindLast: typeof import('@vueuse/core')['useArrayFindLast'] + const useArrayIncludes: typeof import('@vueuse/core')['useArrayIncludes'] const useArrayJoin: typeof import('@vueuse/core')['useArrayJoin'] const useArrayMap: typeof import('@vueuse/core')['useArrayMap'] const useArrayReduce: typeof import('@vueuse/core')['useArrayReduce'] @@ -189,6 +195,8 @@ declare global { const useOnline: typeof import('@vueuse/core')['useOnline'] const usePageLeave: typeof import('@vueuse/core')['usePageLeave'] const useParallax: typeof import('@vueuse/core')['useParallax'] + const useParentElement: typeof import('@vueuse/core')['useParentElement'] + const usePerformanceObserver: typeof import('@vueuse/core')['usePerformanceObserver'] const usePermission: typeof import('@vueuse/core')['usePermission'] const usePointer: typeof import('@vueuse/core')['usePointer'] const usePointerLock: typeof import('@vueuse/core')['usePointerLock'] @@ -254,8 +262,10 @@ declare global { const watchArray: typeof import('@vueuse/core')['watchArray'] const watchAtMost: typeof import('@vueuse/core')['watchAtMost'] const watchDebounced: typeof import('@vueuse/core')['watchDebounced'] + const watchDeep: typeof import('@vueuse/core')['watchDeep'] const watchEffect: typeof import('vue')['watchEffect'] const watchIgnorable: typeof import('@vueuse/core')['watchIgnorable'] + const watchImmediate: typeof import('@vueuse/core')['watchImmediate'] const watchOnce: typeof import('@vueuse/core')['watchOnce'] const watchPausable: typeof import('@vueuse/core')['watchPausable'] const watchPostEffect: typeof import('vue')['watchPostEffect'] diff --git a/docs/src/guide/edge.md b/docs/src/guide/edge.md index bae54518..64c5326d 100644 --- a/docs/src/guide/edge.md +++ b/docs/src/guide/edge.md @@ -1,3 +1,74 @@ + + # Edges Edges are what connects your nodes into a map. @@ -5,9 +76,8 @@ Edges are what connects your nodes into a map. They cannot exist on their own and need nodes to which they are connected. Each edge requires a unique id, a source node and a target node id. -Anything else is optional. -You can check the full options for an edge element in the TypeDocs [here](/typedocs/types/Edge). +You can view the full options-list for an edge [here](/typedocs/types/Edge). ## Usage @@ -55,9 +125,8 @@ export default defineComponent({ ``` For more advanced graphs that require more state access you will want to use the useVueFlow composable. -[useVueFlow](/typedocs/functions/useVueFlow) will provide -you with an [`addEdges`](/typedocs/interfaces/Actions#addedges/) utility function, which you can use to add edges -directly to the state. +[useVueFlow](/typedocs/functions/useVueFlow) will provide the [`addEdges`](/typedocs/interfaces/Actions#addedges/) action, +which you can use to add edges directly to the state. ```vue + # Nodes Nodes are the building blocks of your graph. They represent any sort of data you want to present in your graph. @@ -5,10 +39,9 @@ Nodes are the building blocks of your graph. They represent any sort of data you They can exist on their own but can be connected to each other with edges to create a map. Each node requires a unique id and -a [xy-position](/typedocs/interfaces/XYPosition). -Anything else is optional. +an [xy-position](/typedocs/interfaces/XYPosition). -You can check the full options for a node element [here](/typedocs/interfaces/Node). +You can view the full options-list for a node [here](/typedocs/interfaces/Node). ## Usage @@ -43,6 +76,7 @@ export default defineComponent({ } }) +