rune-langium / visual-editor/src / useNavigationArrival

Function: useNavigationArrival()

function useNavigationArrival(consumedArrivalRef?): {
  arrivalNodeId: string | null;
  cancelArrival: () => void;
  emphasizeArrival: (nodeId, revision?) => void;
};

Defined in: packages/visual-editor/src/hooks/useNavigationArrival.ts:13

Brief destination emphasis, independent of selection and camera auto-fitting.

Parameters

Parameter	Type
consumedArrivalRef?	RefObject<NavigationArrival | undefined>

Returns

{
  arrivalNodeId: string | null;
  cancelArrival: () => void;
  emphasizeArrival: (nodeId, revision?) => void;
}

Name	Type	Defined in
arrivalNodeId	string | null	packages/visual-editor/src/hooks/useNavigationArrival.ts:43
cancelArrival()	() => void	packages/visual-editor/src/hooks/useNavigationArrival.ts:43
emphasizeArrival()	(nodeId, revision?) => void	packages/visual-editor/src/hooks/useNavigationArrival.ts:43