chore(core): update composable jsdocs

This commit is contained in:
braks
2024-02-15 17:46:21 +01:00
committed by Braks
parent ee8748e936
commit fbb3f63134
23 changed files with 104 additions and 18 deletions
@@ -5,6 +5,17 @@ export interface UseNodesInitializedOptions {
includeHiddenNodes?: boolean
}
/**
* Composable for getting the initialized state of all nodes.
*
* When a new node is added to the graph, it is not immediately initialized.
* That's because the node's bounds are not yet known.
* This composable will return false and then true when all nodes are initialized, i.e. when their bounds are known.
*
* @public
* @param options - Options
* @returns boolean indicating whether all nodes are initialized
*/
export function useNodesInitialized(options: UseNodesInitializedOptions = { includeHiddenNodes: false }) {
const { nodes } = useVueFlow()