リファレンスフック

useNodesInitialized

GitHub上のソースコード

このフックは、フロー内のすべてのノードが測定され、幅と高さが割り当てられているかどうかを示します。フローにノードを追加すると、このフックはfalseを返し、ノードが測定されるとtrueを返します。

import { useReactFlow, useNodesInitialized } from '@xyflow/react';
import { useEffect, useState } from 'react';
 
const options = {
  includeHiddenNodes: false,
};
 
export default function useLayout() {
  const { getNodes } = useReactFlow();
  const nodesInitialized = useNodesInitialized(options);
  const [layoutedNodes, setLayoutedNodes] = useState(getNodes());
 
  useEffect(() => {
    if (nodesInitialized) {
      setLayoutedNodes(yourLayoutingFunction(getNodes()));
    }
  }, [nodesInitialized]);
 
  return layoutedNodes;
}

シグネチャ

#パラメータ
#options
オブジェクト
#options.includeHiddenNodes?
ブール値
false
#戻り値
ブール値
<ReactFlow />コンポーネントによって初期化され、幅と高さが割り当てられたかどうか。

備考

  • 内部ノード配列が空の場合は、このフックは常にfalseを返します。