mirror of https://github.com/ANL-CEEESA/RELOG.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
30 lines
1.1 KiB
30 lines
1.1 KiB
import type { ReactFlowInstance, Node, Edge } from '../types';
|
|
/**
|
|
* This hook returns a ReactFlowInstance that can be used to update nodes and edges, manipulate the viewport, or query the current state of the flow.
|
|
*
|
|
* @public
|
|
* @example
|
|
* ```jsx
|
|
*import { useCallback, useState } from 'react';
|
|
*import { useReactFlow } from '@xyflow/react';
|
|
*
|
|
*export function NodeCounter() {
|
|
* const reactFlow = useReactFlow();
|
|
* const [count, setCount] = useState(0);
|
|
* const countNodes = useCallback(() => {
|
|
* setCount(reactFlow.getNodes().length);
|
|
* // you need to pass it as a dependency if you are using it with useEffect or useCallback
|
|
* // because at the first render, it's not initialized yet and some functions might not work.
|
|
* }, [reactFlow]);
|
|
*
|
|
* return (
|
|
* <div>
|
|
* <button onClick={countNodes}>Update count</button>
|
|
* <p>There are {count} nodes in the flow.</p>
|
|
* </div>
|
|
* );
|
|
*}
|
|
*```
|
|
*/
|
|
export declare function useReactFlow<NodeType extends Node = Node, EdgeType extends Edge = Edge>(): ReactFlowInstance<NodeType, EdgeType>;
|
|
//# sourceMappingURL=useReactFlow.d.ts.map
|